Package com.stripe.param

Class QuoteCreateParams.SubscriptionData

java.lang.Object

com.stripe.param.QuoteCreateParams.SubscriptionData

Enclosing class:

QuoteCreateParams

public static class QuoteCreateParams.SubscriptionData
extends Object

The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QuoteCreateParams.SubscriptionData.Builder
static enum	QuoteCreateParams.SubscriptionData.EffectiveDate

Method Summary

Modifier and Type	Method	Description
static QuoteCreateParams.SubscriptionData.Builder	builder()
String	getDescription()	The subscription's description, meant to be displayable to the customer.
Object	getEffectiveDate()	When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
Map<String,String>	getMetadata()	Set of key-value pairs that will set metadata on the subscription or subscription schedule when the quote is accepted.
Object	getTrialPeriodDays()	Integer representing the number of trial period days before the customer is charged for the first time.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static QuoteCreateParams.SubscriptionData.Builder builder()

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 Object getEffectiveDate()

When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value current_period_end can be provided to update a subscription at the end of its current period. The effective_date is ignored if it is in the past when the quote is accepted.

getExtraParams

public Map<String,Object> getExtraParams()

Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

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 Object getTrialPeriodDays()

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