Package com.stripe.model

Class Plan

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.APIResource

com.stripe.model.Plan

All Implemented Interfaces:

HasId, MetadataStore<Plan>

public class Plan
extends APIResource
implements MetadataStore<Plan>, 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
Plan()

Method Summary

Modifier and Type	Method	Description
static PlanCollection	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 PlanCollection	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.
static PlanCollection	all(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey)	Deprecated. Use the list(Map, RequestOptions) method instead. This method will be removed in the next major version.
protected boolean	canEqual(java.lang.Object other)
static Plan	create(java.util.Map<java.lang.String,java.lang.Object> params)	Create a plan.
static Plan	create(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Create a plan.
static Plan	create(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String apiKey)	Deprecated. Use the create(Map, RequestOptions) method instead. This method will be removed in the next major version.
DeletedPlan	delete()	Delete a plan.
DeletedPlan	delete(RequestOptions options)	Delete a plan.
DeletedPlan	delete(java.lang.String apiKey)	Deprecated. Use the delete(RequestOptions) method instead. This method will be removed in the next major version.
boolean	equals(java.lang.Object o)
java.lang.Boolean	getActive()
java.lang.Long	getAmount()
java.lang.String	getBillingScheme()
java.lang.Long	getCreated()
java.lang.String	getCurrency()
java.lang.String	getId()
java.lang.String	getInterval()
java.lang.Integer	getIntervalCount()
java.lang.Boolean	getLivemode()
java.util.Map<java.lang.String,java.lang.String>	getMetadata()
java.lang.String	getName()	Deprecated. Prefer using the getProduct().getName() method instead.
java.lang.String	getNickname()
java.lang.String	getObject()
java.lang.String	getProduct()
Product	getProductObject()
java.lang.String	getStatementDescription()	Deprecated. Prefer using the getProduct().getStatementDescriptor() method instead.
java.lang.String	getStatementDescriptor()	Deprecated. Prefer using the getProduct().getStatementDescriptor() method instead.
java.util.List<PlanTier>	getTiers()
java.lang.String	getTiersMode()
PlanTransformUsage	getTransformUsage()
java.lang.Integer	getTrialPeriodDays()	Deprecated. Prefer using the Subscription.create(java.util.Map<java.lang.String, java.lang.Object>) method with the trial_end parameter instead.
java.lang.String	getUsageType()
int	hashCode()
static PlanCollection	list(java.util.Map<java.lang.String,java.lang.Object> params)	List all plans.
static PlanCollection	list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	List all plans.
static Plan	retrieve(java.lang.String id)	Retrieve a plan.
static Plan	retrieve(java.lang.String id, RequestOptions options)	Retrieve a plan.
static Plan	retrieve(java.lang.String id, java.lang.String apiKey)	Deprecated. Use the retrieve(String, RequestOptions) method instead. This method will be removed in the next major version.
void	setActive(java.lang.Boolean active)
void	setAmount(java.lang.Long amount)
void	setBillingScheme(java.lang.String billingScheme)
void	setCreated(java.lang.Long created)
void	setCurrency(java.lang.String currency)
void	setId(java.lang.String id)
void	setInterval(java.lang.String interval)
void	setIntervalCount(java.lang.Integer intervalCount)
void	setLivemode(java.lang.Boolean livemode)
void	setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
void	setName(java.lang.String name)	Deprecated. Prefer using the getProduct().getName() method instead.
void	setNickname(java.lang.String nickname)
void	setObject(java.lang.String object)
void	setProduct(java.lang.String productID)
void	setProductObject(Product product)
void	setStatementDescription(java.lang.String statementDescription)	Deprecated. Prefer using the getProduct().getStatementDescriptor() method instead.
void	setStatementDescriptor(java.lang.String statementDescriptor)	Deprecated. Prefer using the getProduct().getStatementDescriptor() method instead.
void	setTiers(java.util.List<PlanTier> tiers)
void	setTiersMode(java.lang.String tiersMode)
void	setTransformUsage(PlanTransformUsage transformUsage)
void	setTrialPeriodDays(java.lang.Integer trialPeriodDays)	Deprecated. Prefer using the Subscription.create(java.util.Map<java.lang.String, java.lang.Object>) method with the trial_end parameter instead.
void	setUsageType(java.lang.String usageType)
Plan	update(java.util.Map<java.lang.String,java.lang.Object> params)	Update a plan.
Plan	update(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)	Update a plan.
Plan	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

Plan

public Plan()

Method Detail

getProduct

public java.lang.String getProduct()

setProduct

public void setProduct(java.lang.String productID)

getProductObject

public Product getProductObject()

setProductObject

public void setProductObject(Product product)

all

@Deprecated
public static PlanCollection 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 all plans.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

all

@Deprecated
public static PlanCollection 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 all plans.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

all

@Deprecated
public static PlanCollection all(java.util.Map<java.lang.String,java.lang.Object> params,
                                 java.lang.String apiKey)
                          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 all plans.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

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

Create a plan.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

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

Create a plan.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

create

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

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

Create a plan.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

delete

public DeletedPlan delete()
                   throws AuthenticationException,
                          InvalidRequestException,
                          APIConnectionException,
                          CardException,
                          APIException

Delete a plan.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

delete

public DeletedPlan delete(RequestOptions options)
                   throws AuthenticationException,
                          InvalidRequestException,
                          APIConnectionException,
                          CardException,
                          APIException

Delete a plan.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

delete

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

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

Delete a plan.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

list

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

List all plans.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

list

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

List all plans.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

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

Retrieve a plan.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

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

Retrieve a plan.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

retrieve

@Deprecated
public static Plan retrieve(java.lang.String id,
                            java.lang.String apiKey)
                     throws AuthenticationException,
                            InvalidRequestException,
                            APIConnectionException,
                            CardException,
                            APIException

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

Retrieve a plan.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

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

Update a plan.

Specified by:

update in interface MetadataStore<Plan>

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

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

Update a plan.

Specified by:

update in interface MetadataStore<Plan>

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

update

@Deprecated
public Plan 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 plan.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getObject

public java.lang.String getObject()

getActive

public java.lang.Boolean getActive()

getAmount

public java.lang.Long getAmount()

getBillingScheme

public java.lang.String getBillingScheme()

getCreated

public java.lang.Long getCreated()

getCurrency

public java.lang.String getCurrency()

getInterval

public java.lang.String getInterval()

getIntervalCount

public java.lang.Integer getIntervalCount()

getLivemode

public java.lang.Boolean getLivemode()

getNickname

public java.lang.String getNickname()

getTiers

public java.util.List<PlanTier> getTiers()

getTiersMode

public java.lang.String getTiersMode()

getTransformUsage

public PlanTransformUsage getTransformUsage()

getUsageType

public java.lang.String getUsageType()

getName

@Deprecated
public java.lang.String getName()

Deprecated. Prefer using the getProduct().getName() method instead.

The name attribute.

Returns:

the name attribute

See Also:

API version 2018-02-05

getStatementDescription

@Deprecated
public java.lang.String getStatementDescription()

Deprecated. Prefer using the getProduct().getStatementDescriptor() method instead.

The statement_description attribute.

Returns:

the statement_description attribute

See Also:

API version 2014-12-17, API version 2018-02-05

getStatementDescriptor

@Deprecated
public java.lang.String getStatementDescriptor()

Deprecated. Prefer using the getProduct().getStatementDescriptor() method instead.

The statement_descriptor attribute.

Returns:

the statement_descriptor attribute

See Also:

API version 2018-02-05

getTrialPeriodDays

@Deprecated
public java.lang.Integer getTrialPeriodDays()

Deprecated. Prefer using the Subscription.create(java.util.Map<java.lang.String, java.lang.Object>) method with the trial_end parameter instead.

The trial_period_days attribute.

Returns:

the trial_period_days attribute

See Also:

API version 2018-02-05

setId

public void setId(java.lang.String id)

setObject

public void setObject(java.lang.String object)

setActive

public void setActive(java.lang.Boolean active)

setAmount

public void setAmount(java.lang.Long amount)

setBillingScheme

public void setBillingScheme(java.lang.String billingScheme)

setCreated

public void setCreated(java.lang.Long created)

setCurrency

public void setCurrency(java.lang.String currency)

setInterval

public void setInterval(java.lang.String interval)

setIntervalCount

public void setIntervalCount(java.lang.Integer intervalCount)

setLivemode

public void setLivemode(java.lang.Boolean livemode)

setMetadata

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

setNickname

public void setNickname(java.lang.String nickname)

setTiers

public void setTiers(java.util.List<PlanTier> tiers)

setTiersMode

public void setTiersMode(java.lang.String tiersMode)

setTransformUsage

public void setTransformUsage(PlanTransformUsage transformUsage)

setUsageType

public void setUsageType(java.lang.String usageType)

setName

@Deprecated
public void setName(java.lang.String name)

Deprecated. Prefer using the getProduct().getName() method instead.

The name attribute.

See Also:

API version 2018-02-05

setStatementDescription

@Deprecated
public void setStatementDescription(java.lang.String statementDescription)

Deprecated. Prefer using the getProduct().getStatementDescriptor() method instead.

The statement_description attribute.

See Also:

API version 2014-12-17, API version 2018-02-05

setStatementDescriptor

@Deprecated
public void setStatementDescriptor(java.lang.String statementDescriptor)

Deprecated. Prefer using the getProduct().getStatementDescriptor() method instead.

The statement_descriptor attribute.

See Also:

API version 2018-02-05

setTrialPeriodDays

@Deprecated
public void setTrialPeriodDays(java.lang.Integer trialPeriodDays)

Deprecated. Prefer using the Subscription.create(java.util.Map<java.lang.String, java.lang.Object>) method with the trial_end parameter instead.

The trial_period_days attribute.

See Also:

API version 2018-02-05

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<Plan>