Package com.stripe.model

Class Quote.SubscriptionData

java.lang.Object

com.stripe.model.StripeObject

com.stripe.model.Quote.SubscriptionData

All Implemented Interfaces:

StripeObjectInterface

Enclosing class:

Quote

public static class Quote.SubscriptionData
extends StripeObject

Field Summary

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
SubscriptionData()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getDescription()	The subscription's description, meant to be displayable to the customer.
Long	getEffectiveDate()	When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted.
Map<String,String>	getMetadata()	Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted.
Long	getTrialPeriodDays()	Integer representing the number of trial period days before the customer is charged for the first time.
int	hashCode()
void	setDescription(String description)	The subscription's description, meant to be displayable to the customer.
void	setEffectiveDate(Long effectiveDate)	When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted.
void	setMetadata(Map<String,String> metadata)	Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted.
void	setTrialPeriodDays(Long trialPeriodDays)	Integer representing the number of trial period days before the customer is charged for the first time.

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

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

Constructor Details

SubscriptionData

public SubscriptionData()

Method Details

getDescription

public String getDescription()

The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

getEffectiveDate

public Long getEffectiveDate()

When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.

getMetadata

public Map<String,String> getMetadata()

Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in line_items, this field will be passed to the resulting subscription's metadata field. If subscription_data.effective_date is used, this field will be passed to the resulting subscription schedule's phases.metadata field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.

getTrialPeriodDays

public Long getTrialPeriodDays()

Integer representing the number of trial period days before the customer is charged for the first time.

setDescription

public void setDescription(String description)

The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

setEffectiveDate

public void setEffectiveDate(Long effectiveDate)

When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.

setMetadata

public void setMetadata(Map<String,String> metadata)

Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in line_items, this field will be passed to the resulting subscription's metadata field. If subscription_data.effective_date is used, this field will be passed to the resulting subscription schedule's phases.metadata field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.

setTrialPeriodDays

public void setTrialPeriodDays(Long trialPeriodDays)

Integer representing the number of trial period days before the customer is charged for the first time.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object