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

Modifier and Type	Class and Description
static class	Plan.Tier
static class	Plan.TransformUsage

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 and Description
Plan()

Method Summary

Modifier and Type	Method and Description
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.
Plan	delete() Delete a plan.
Plan	delete(RequestOptions options) Delete a plan.
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.Boolean	getDeleted()
java.lang.String	getId()
java.lang.String	getInterval()
java.lang.Long	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<Plan.Tier>	getTiers()
java.lang.String	getTiersMode()
Plan.TransformUsage	getTransformUsage()
java.lang.Long	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, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) Retrieve a plan.
static Plan	retrieve(java.lang.String id, RequestOptions options) Retrieve a plan.
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	setDeleted(java.lang.Boolean deleted)
void	setId(java.lang.String id)
void	setInterval(java.lang.String interval)
void	setIntervalCount(java.lang.Long 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<Plan.Tier> tiers)
void	setTiersMode(java.lang.String tiersMode)
void	setTransformUsage(Plan.TransformUsage transformUsage)
void	setTrialPeriodDays(java.lang.Long 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.

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

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)

create

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

Create a plan.

Throws:

StripeException

create

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

Create a plan.

Throws:

StripeException

delete

public Plan delete()
            throws StripeException

Delete a plan.

Throws:

StripeException

delete

public Plan delete(RequestOptions options)
            throws StripeException

Delete a plan.

Throws:

StripeException

list

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

List all plans.

Throws:

StripeException

list

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

List all plans.

Throws:

StripeException

retrieve

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

Retrieve a plan.

Throws:

StripeException

retrieve

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

Retrieve a plan.

Throws:

StripeException

retrieve

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

Retrieve a plan.

Throws:

StripeException

update

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

Update a plan.

Specified by:

update in interface MetadataStore<Plan>

Throws:

StripeException

update

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

Update a plan.

Specified by:

update in interface MetadataStore<Plan>

Throws:

StripeException

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

getLivemode

public java.lang.Boolean getLivemode()

getNickname

public java.lang.String getNickname()

getTiers

public java.util.List<Plan.Tier> getTiers()

getTiersMode

public java.lang.String getTiersMode()

getTransformUsage

public Plan.TransformUsage getTransformUsage()

getUsageType

public java.lang.String getUsageType()

getDeleted

public java.lang.Boolean getDeleted()

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.Long 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.Long 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<Plan.Tier> tiers)

setTiersMode

public void setTiersMode(java.lang.String tiersMode)

setTransformUsage

public void setTransformUsage(Plan.TransformUsage transformUsage)

setUsageType

public void setUsageType(java.lang.String usageType)

setDeleted

public void setDeleted(java.lang.Boolean deleted)

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