Package com.stripe.model

Class Subscription

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.APIResource

com.stripe.model.Subscription

All Implemented Interfaces:

HasId, MetadataStore<Subscription>

public class Subscription
extends APIResource
implements MetadataStore<Subscription>, HasId

Nested Class Summary

Nested classes/interfaces inherited from class com.stripe.net.APIResource

APIResource.RequestMethod, APIResource.RequestType

Field Summary

Fields inherited from class com.stripe.net.APIResource

CHARSET, GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
Subscription()

Method Summary

Modifier and Type	Method	Description
static SubscriptionCollection	all(java.util.Map<java.lang.String,java.lang.Object> params)	Deprecated. Use the list(Map) method instead. This method will be removed in the next major version.
static SubscriptionCollection	all(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.
Subscription	cancel(java.util.Map<java.lang.String,java.lang.Object> params)	Cancel a subscription.
Subscription	cancel(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Cancel a subscription.
Subscription	cancel(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey)	Deprecated. Use the cancel(Map, RequestOptions) method instead. This method will be removed in the next major version.
protected boolean	canEqual(java.lang.Object other)
static Subscription	create(java.util.Map<java.lang.String,java.lang.Object> params)	Create a subscription.
static Subscription	create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Create a subscription.
void	deleteDiscount()	Delete a subscription discount.
void	deleteDiscount(RequestOptions options)	Delete a subscription discount.
void	deleteDiscount(java.lang.String apiKey)	Deprecated. Use the deleteDiscount(RequestOptions) method instead. This method will be removed in the next major version.
boolean	equals(java.lang.Object o)
java.lang.Double	getApplicationFeePercent()
java.lang.String	getBilling()
java.lang.Long	getBillingCycleAnchor()
java.lang.Boolean	getCancelAtPeriodEnd()
java.lang.Long	getCanceledAt()
java.lang.Long	getCreated()
java.lang.Long	getCurrentPeriodEnd()
java.lang.Long	getCurrentPeriodStart()
java.lang.String	getCustomer()
Customer	getCustomerObject()
java.lang.Integer	getDaysUntilDue()
Discount	getDiscount()
java.lang.Long	getEndedAt()
java.lang.String	getId()
java.util.Map<java.lang.String,java.lang.String>	getMetadata()
java.lang.String	getObject()
Plan	getPlan()
java.lang.Integer	getQuantity()
java.lang.Long	getStart()
java.lang.String	getStatus()
SubscriptionItemCollection	getSubscriptionItems()
java.lang.Double	getTaxPercent()
java.lang.Long	getTrialEnd()
java.lang.Long	getTrialStart()
int	hashCode()
static SubscriptionCollection	list(java.util.Map<java.lang.String,java.lang.Object> params)	List subscriptions.
static SubscriptionCollection	list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	List subscriptions.
static Subscription	retrieve(java.lang.String id)	Retrieve a subscription.
static Subscription	retrieve(java.lang.String id, RequestOptions options)	Retrieve a subscription.
static Subscription	retrieve(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Retrieve a subscription.
void	setApplicationFeePercent(java.lang.Double applicationFeePercent)
void	setBilling(java.lang.String billing)
void	setBillingCycleAnchor(java.lang.Long billingCycleAnchor)
void	setCancelAtPeriodEnd(java.lang.Boolean cancelAtPeriodEnd)
void	setCanceledAt(java.lang.Long canceledAt)
void	setCreated(java.lang.Long created)
void	setCurrentPeriodEnd(java.lang.Long currentPeriodEnd)
void	setCurrentPeriodStart(java.lang.Long currentPeriodStart)
void	setCustomer(java.lang.String customerID)
void	setCustomerObject(Customer c)
void	setDaysUntilDue(java.lang.Integer daysUntilDue)
void	setDiscount(Discount discount)
void	setEndedAt(java.lang.Long endedAt)
void	setId(java.lang.String id)
void	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
void	setObject(java.lang.String object)
void	setPlan(Plan plan)
void	setQuantity(java.lang.Integer quantity)
void	setStart(java.lang.Long start)
void	setStatus(java.lang.String status)
void	setSubscriptionItems(SubscriptionItemCollection items)
void	setTaxPercent(java.lang.Double taxPercent)
void	setTrialEnd(java.lang.Long trialEnd)
void	setTrialStart(java.lang.Long trialStart)
Subscription	update(java.util.Map<java.lang.String,java.lang.Object> params)	Update a subscription.
Subscription	update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Update a subscription.
Subscription	update(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey)	Deprecated. Use the update(Map, RequestOptions) method instead. This method will be removed in the next major version.

Methods inherited from class com.stripe.net.APIResource

classURL, classURL, instanceURL, instanceURL, multipartRequest, request, requestCollection, setExpandableFieldID, setStripeResponseGetter, singleClassURL, singleClassURL, subresourceURL, urlEncode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, setLastResponse, toJson, toString

Constructor Detail

Subscription

public Subscription()

Method Detail

getCustomer

public java.lang.String getCustomer()

setCustomer

public void setCustomer(java.lang.String customerID)

getCustomerObject

public Customer getCustomerObject()

setCustomerObject

public void setCustomerObject(Customer c)

getSubscriptionItems

public SubscriptionItemCollection getSubscriptionItems()

setSubscriptionItems

public void setSubscriptionItems(SubscriptionItemCollection items)

all

@Deprecated
public static SubscriptionCollection all(java.util.Map<java.lang.String,java.lang.Object> params)
                                  throws AuthenticationException,
                                         InvalidRequestException,
                                         APIConnectionException,
                                         CardException,
                                         APIException

Deprecated. Use the list(Map) method instead. This method will be removed in the next major version.

List subscriptions.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

all

@Deprecated
public static SubscriptionCollection all(java.util.Map<java.lang.String,java.lang.Object> params,
                                         RequestOptions options)
                                  throws AuthenticationException,
                                         InvalidRequestException,
                                         APIConnectionException,
                                         CardException,
                                         APIException

Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.

List subscriptions.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

cancel

public Subscription cancel(java.util.Map<java.lang.String,java.lang.Object> params)
                    throws AuthenticationException,
                           InvalidRequestException,
                           APIConnectionException,
                           CardException,
                           APIException

Cancel a subscription.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

cancel

public Subscription cancel(java.util.Map<java.lang.String,java.lang.Object> params,
                           RequestOptions options)
                    throws AuthenticationException,
                           InvalidRequestException,
                           APIConnectionException,
                           CardException,
                           APIException

Cancel a subscription.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

cancel

@Deprecated
public Subscription cancel(java.util.Map<java.lang.String,java.lang.Object> params,
                           java.lang.String apiKey)
                    throws AuthenticationException,
                           InvalidRequestException,
                           APIConnectionException,
                           CardException,
                           APIException

Deprecated. Use the cancel(Map, RequestOptions) method instead. This method will be removed in the next major version.

Cancel a subscription.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

public static Subscription create(java.util.Map<java.lang.String,java.lang.Object> params)
                           throws AuthenticationException,
                                  InvalidRequestException,
                                  APIConnectionException,
                                  CardException,
                                  APIException

Create a subscription.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

public static Subscription create(java.util.Map<java.lang.String,java.lang.Object> params,
                                  RequestOptions options)
                           throws AuthenticationException,
                                  InvalidRequestException,
                                  APIConnectionException,
                                  CardException,
                                  APIException

Create a subscription.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

deleteDiscount

public void deleteDiscount()
                    throws AuthenticationException,
                           InvalidRequestException,
                           APIConnectionException,
                           CardException,
                           APIException

Delete a subscription discount.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

deleteDiscount

public void deleteDiscount(RequestOptions options)
                    throws AuthenticationException,
                           InvalidRequestException,
                           APIConnectionException,
                           CardException,
                           APIException

Delete a subscription discount.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

deleteDiscount

@Deprecated
public void deleteDiscount(java.lang.String apiKey)
                    throws AuthenticationException,
                           InvalidRequestException,
                           APIConnectionException,
                           CardException,
                           APIException

Deprecated. Use the deleteDiscount(RequestOptions) method instead. This method will be removed in the next major version.

Delete a subscription discount.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

list

public static SubscriptionCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                                   throws AuthenticationException,
                                          InvalidRequestException,
                                          APIConnectionException,
                                          CardException,
                                          APIException

List subscriptions.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

list

public static SubscriptionCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                          RequestOptions options)
                                   throws AuthenticationException,
                                          InvalidRequestException,
                                          APIConnectionException,
                                          CardException,
                                          APIException

List subscriptions.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Subscription retrieve(java.lang.String id)
                             throws AuthenticationException,
                                    InvalidRequestException,
                                    APIConnectionException,
                                    CardException,
                                    APIException

Retrieve a subscription.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Subscription retrieve(java.lang.String id,
                                    RequestOptions options)
                             throws AuthenticationException,
                                    InvalidRequestException,
                                    APIConnectionException,
                                    CardException,
                                    APIException

Retrieve a subscription.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

public static Subscription retrieve(java.lang.String id,
                                    java.util.Map<java.lang.String,java.lang.Object> params,
                                    RequestOptions options)
                             throws AuthenticationException,
                                    InvalidRequestException,
                                    APIConnectionException,
                                    CardException,
                                    APIException

Retrieve a subscription.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

public Subscription update(java.util.Map<java.lang.String,java.lang.Object> params)
                    throws AuthenticationException,
                           InvalidRequestException,
                           APIConnectionException,
                           CardException,
                           APIException

Update a subscription.

Specified by:

update in interface MetadataStore<Subscription>

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

public Subscription update(java.util.Map<java.lang.String,java.lang.Object> params,
                           RequestOptions options)
                    throws AuthenticationException,
                           InvalidRequestException,
                           APIConnectionException,
                           CardException,
                           APIException

Update a subscription.

Specified by:

update in interface MetadataStore<Subscription>

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

@Deprecated
public Subscription update(java.util.Map<java.lang.String,java.lang.Object> params,
                           java.lang.String apiKey)
                    throws AuthenticationException,
                           InvalidRequestException,
                           APIConnectionException,
                           CardException,
                           APIException

Deprecated. Use the update(Map, RequestOptions) method instead. This method will be removed in the next major version.

Update a subscription.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getObject

public java.lang.String getObject()

getApplicationFeePercent

public java.lang.Double getApplicationFeePercent()

getBilling

public java.lang.String getBilling()

getBillingCycleAnchor

public java.lang.Long getBillingCycleAnchor()

getCancelAtPeriodEnd

public java.lang.Boolean getCancelAtPeriodEnd()

getCanceledAt

public java.lang.Long getCanceledAt()

getCreated

public java.lang.Long getCreated()

getCurrentPeriodEnd

public java.lang.Long getCurrentPeriodEnd()

getCurrentPeriodStart

public java.lang.Long getCurrentPeriodStart()

getDaysUntilDue

public java.lang.Integer getDaysUntilDue()

getDiscount

public Discount getDiscount()

getEndedAt

public java.lang.Long getEndedAt()

getPlan

public Plan getPlan()

getQuantity

public java.lang.Integer getQuantity()

getStart

public java.lang.Long getStart()

getStatus

public java.lang.String getStatus()

getTaxPercent

public java.lang.Double getTaxPercent()

getTrialEnd

public java.lang.Long getTrialEnd()

getTrialStart

public java.lang.Long getTrialStart()

setId

public void setId(java.lang.String id)

setObject

public void setObject(java.lang.String object)

setApplicationFeePercent

public void setApplicationFeePercent(java.lang.Double applicationFeePercent)

setBilling

public void setBilling(java.lang.String billing)

setBillingCycleAnchor

public void setBillingCycleAnchor(java.lang.Long billingCycleAnchor)

setCancelAtPeriodEnd

public void setCancelAtPeriodEnd(java.lang.Boolean cancelAtPeriodEnd)

setCanceledAt

public void setCanceledAt(java.lang.Long canceledAt)

setCreated

public void setCreated(java.lang.Long created)

setCurrentPeriodEnd

public void setCurrentPeriodEnd(java.lang.Long currentPeriodEnd)

setCurrentPeriodStart

public void setCurrentPeriodStart(java.lang.Long currentPeriodStart)

setDaysUntilDue

public void setDaysUntilDue(java.lang.Integer daysUntilDue)

setDiscount

public void setDiscount(Discount discount)

setEndedAt

public void setEndedAt(java.lang.Long endedAt)

setMetadata

public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

setPlan

public void setPlan(Plan plan)

setQuantity

public void setQuantity(java.lang.Integer quantity)

setStart

public void setStart(java.lang.Long start)

setStatus

public void setStatus(java.lang.String status)

setTaxPercent

public void setTaxPercent(java.lang.Double taxPercent)

setTrialEnd

public void setTrialEnd(java.lang.Long trialEnd)

setTrialStart

public void setTrialStart(java.lang.Long trialStart)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getId

public java.lang.String getId()

Specified by:

getId in interface HasId

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Specified by:

getMetadata in interface MetadataStore<Subscription>