net.joelinn.stripe.api

Class Subscriptions

java.lang.Object

net.joelinn.stripe.api.AbstractApi

net.joelinn.stripe.api.Subscriptions

public class Subscriptions
extends AbstractApi

User: Joe Linn Date: 5/25/2014 Time: 7:47 PM

Field Summary

Fields inherited from class net.joelinn.stripe.api.AbstractApi

client

Constructor Summary

Constructors

Constructor and Description
Subscriptions(Client client)

Method Summary

Modifier and Type	Method and Description
protected String	buildUrl(String customerId)
protected String	buildUrl(String customerId, String subscriptionId)
SubscriptionResponse	cancelSubscription(String customerId, String subscriptionId) Cancel a subscription https://stripe.com/docs/api#cancel_subscription
SubscriptionResponse	cancelSubscription(String customerId, String subscriptionId, Boolean atPeriodEnd) Cancel a subscription https://stripe.com/docs/api#cancel_subscription
SubscriptionResponse	createSubscription(String customerId, CreateSubscriptionRequest request) Create a subscription https://stripe.com/docs/api/curl#create_subscription
SubscriptionResponse	getSubscription(String customerId, String subscriptionId) Retrieve a subscription https://stripe.com/docs/api/curl#retrieve_subscription
ListSubscriptionsResponse	listSubscriptions(String customerId, ListSubscriptionsRequest request) List subscriptions https://stripe.com/docs/api#list_subscriptions
SubscriptionResponse	updateSubscription(String customerId, String subscriptionId, UpdateSubscriptionRequest request) Update a subscription https://stripe.com/docs/api/curl#update_subscription

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Subscriptions

public Subscriptions(Client client)

Method Detail

createSubscription

public SubscriptionResponse createSubscription(String customerId,
                                               CreateSubscriptionRequest request)

Create a subscription https://stripe.com/docs/api/curl#create_subscription

Parameters:

customerId - the id of the customer for whom to create a subscription

getSubscription

public SubscriptionResponse getSubscription(String customerId,
                                            String subscriptionId)

Retrieve a subscription https://stripe.com/docs/api/curl#retrieve_subscription

Parameters:

customerId - the id of the customer to which the subscription belongs

subscriptionId - the id of the subscription to retrieve

updateSubscription

public SubscriptionResponse updateSubscription(String customerId,
                                               String subscriptionId,
                                               UpdateSubscriptionRequest request)

Update a subscription https://stripe.com/docs/api/curl#update_subscription

Parameters:

customerId - the id of the customer to which the subscription belongs

subscriptionId - the id of the subscription to update

cancelSubscription

public SubscriptionResponse cancelSubscription(String customerId,
                                               String subscriptionId)

Cancel a subscription https://stripe.com/docs/api#cancel_subscription

Parameters:

customerId - the id of the customer to which the subscription belongs

subscriptionId - the id of the subscription to cancel

cancelSubscription

public SubscriptionResponse cancelSubscription(String customerId,
                                               String subscriptionId,
                                               Boolean atPeriodEnd)

Cancel a subscription https://stripe.com/docs/api#cancel_subscription

Parameters:

customerId - the id of the customer to which the subscription belongs

subscriptionId - the id of the subscription to cancel

atPeriodEnd - if true, cancellation will be delayed until the end of the current period

listSubscriptions

public ListSubscriptionsResponse listSubscriptions(String customerId,
                                                   ListSubscriptionsRequest request)

List subscriptions https://stripe.com/docs/api#list_subscriptions

Parameters:

customerId - the id of the customer to which the subscriptions belong

buildUrl

protected String buildUrl(String customerId)

buildUrl

protected String buildUrl(String customerId,
                          String subscriptionId)