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

Modifier and Type	Class	Description
static class	Subscription.BillingThresholds
static class	Subscription.TransferData

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
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.
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.
boolean	equals(java.lang.Object o)
java.math.BigDecimal	getApplicationFeePercent()
java.lang.String	getBilling()
java.lang.Long	getBillingCycleAnchor()
Subscription.BillingThresholds	getBillingThresholds()
java.lang.Long	getCancelAt()
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.Long	getDaysUntilDue()
java.lang.String	getDefaultSource()
ExternalAccount	getDefaultSourceObject()
Discount	getDiscount()
java.lang.Long	getEndedAt()
java.lang.String	getId()
java.lang.String	getLatestInvoice()
Invoice	getLatestInvoiceObject()
java.lang.Boolean	getLivemode()
java.util.Map<java.lang.String,java.lang.String>	getMetadata()
java.lang.String	getObject()
Plan	getPlan()
java.lang.Long	getQuantity()
java.lang.Long	getStart()
java.lang.String	getStatus()
SubscriptionItemCollection	getSubscriptionItems()
java.math.BigDecimal	getTaxPercent()
Subscription.TransferData	getTransferData()
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.math.BigDecimal applicationFeePercent)
void	setBilling(java.lang.String billing)
void	setBillingCycleAnchor(java.lang.Long billingCycleAnchor)
void	setBillingThresholds(Subscription.BillingThresholds billingThresholds)
void	setCancelAt(java.lang.Long cancelAt)
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.Long daysUntilDue)
void	setDefaultSource(java.lang.String defaultSourceId)
void	setDefaultSourceObject(ExternalAccount c)
void	setDiscount(Discount discount)
void	setEndedAt(java.lang.Long endedAt)
void	setId(java.lang.String id)
void	setLatestInvoice(java.lang.String latestInvoiceId)
void	setLatestInvoiceObject(Invoice c)
void	setLivemode(java.lang.Boolean livemode)
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.Long quantity)
void	setStart(java.lang.Long start)
void	setStatus(java.lang.String status)
void	setSubscriptionItems(SubscriptionItemCollection items)
void	setTaxPercent(java.math.BigDecimal taxPercent)
void	setTransferData(Subscription.TransferData transferData)
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.

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 com.stripe.model.StripeObject

equals, getLastResponse, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

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

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)

getDefaultSource

public java.lang.String getDefaultSource()

setDefaultSource

public void setDefaultSource(java.lang.String defaultSourceId)

getDefaultSourceObject

public ExternalAccount getDefaultSourceObject()

setDefaultSourceObject

public void setDefaultSourceObject(ExternalAccount c)

getLatestInvoice

public java.lang.String getLatestInvoice()

setLatestInvoice

public void setLatestInvoice(java.lang.String latestInvoiceId)

getLatestInvoiceObject

public Invoice getLatestInvoiceObject()

setLatestInvoiceObject

public void setLatestInvoiceObject(Invoice c)

getSubscriptionItems

public SubscriptionItemCollection getSubscriptionItems()

setSubscriptionItems

public void setSubscriptionItems(SubscriptionItemCollection items)

cancel

public Subscription cancel(java.util.Map<java.lang.String,java.lang.Object> params)
                    throws StripeException

Cancel a subscription.

Throws:

StripeException

cancel

public Subscription cancel(java.util.Map<java.lang.String,java.lang.Object> params,
                           RequestOptions options)
                    throws StripeException

Cancel a subscription.

Throws:

StripeException

create

public static Subscription create(java.util.Map<java.lang.String,java.lang.Object> params)
                           throws StripeException

Create a subscription.

Throws:

StripeException

create

public static Subscription create(java.util.Map<java.lang.String,java.lang.Object> params,
                                  RequestOptions options)
                           throws StripeException

Create a subscription.

Throws:

StripeException

deleteDiscount

public void deleteDiscount()
                    throws StripeException

Delete a subscription discount.

Throws:

StripeException

deleteDiscount

public void deleteDiscount(RequestOptions options)
                    throws StripeException

Delete a subscription discount.

Throws:

StripeException

list

public static SubscriptionCollection list(java.util.Map<java.lang.String,java.lang.Object> params)
                                   throws StripeException

List subscriptions.

Throws:

StripeException

list

public static SubscriptionCollection list(java.util.Map<java.lang.String,java.lang.Object> params,
                                          RequestOptions options)
                                   throws StripeException

List subscriptions.

Throws:

StripeException

retrieve

public static Subscription retrieve(java.lang.String id)
                             throws StripeException

Retrieve a subscription.

Throws:

StripeException

retrieve

public static Subscription retrieve(java.lang.String id,
                                    RequestOptions options)
                             throws StripeException

Retrieve a subscription.

Throws:

StripeException

retrieve

public static Subscription retrieve(java.lang.String id,
                                    java.util.Map<java.lang.String,java.lang.Object> params,
                                    RequestOptions options)
                             throws StripeException

Retrieve a subscription.

Throws:

StripeException

update

public Subscription update(java.util.Map<java.lang.String,java.lang.Object> params)
                    throws StripeException

Update a subscription.

Specified by:

update in interface MetadataStore<Subscription>

Throws:

StripeException

update

public Subscription update(java.util.Map<java.lang.String,java.lang.Object> params,
                           RequestOptions options)
                    throws StripeException

Update a subscription.

Specified by:

update in interface MetadataStore<Subscription>

Throws:

StripeException

getObject

public java.lang.String getObject()

getApplicationFeePercent

public java.math.BigDecimal getApplicationFeePercent()

getBilling

public java.lang.String getBilling()

getBillingCycleAnchor

public java.lang.Long getBillingCycleAnchor()

getBillingThresholds

public Subscription.BillingThresholds getBillingThresholds()

getCancelAt

public java.lang.Long getCancelAt()

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.Long getDaysUntilDue()

getDiscount

public Discount getDiscount()

getEndedAt

public java.lang.Long getEndedAt()

getLivemode

public java.lang.Boolean getLivemode()

getPlan

public Plan getPlan()

getQuantity

public java.lang.Long getQuantity()

getStart

public java.lang.Long getStart()

getStatus

public java.lang.String getStatus()

getTaxPercent

public java.math.BigDecimal getTaxPercent()

getTransferData

public Subscription.TransferData getTransferData()

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.math.BigDecimal applicationFeePercent)

setBilling

public void setBilling(java.lang.String billing)

setBillingCycleAnchor

public void setBillingCycleAnchor(java.lang.Long billingCycleAnchor)

setBillingThresholds

public void setBillingThresholds(Subscription.BillingThresholds billingThresholds)

setCancelAt

public void setCancelAt(java.lang.Long cancelAt)

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.Long daysUntilDue)

setDiscount

public void setDiscount(Discount discount)

setEndedAt

public void setEndedAt(java.lang.Long endedAt)

setLivemode

public void setLivemode(java.lang.Boolean livemode)

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.Long quantity)

setStart

public void setStart(java.lang.Long start)

setStatus

public void setStatus(java.lang.String status)

setTaxPercent

public void setTaxPercent(java.math.BigDecimal taxPercent)

setTransferData

public void setTransferData(Subscription.TransferData transferData)

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>