com.stripe.param.checkout

Class SessionCreateParams.SubscriptionData

java.lang.Object

com.stripe.param.checkout.SessionCreateParams.SubscriptionData

Enclosing class:

SessionCreateParams

public static class SessionCreateParams.SubscriptionData
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SessionCreateParams.SubscriptionData.Builder
static class	SessionCreateParams.SubscriptionData.Item

Method Summary

Modifier and Type	Method and Description
static SessionCreateParams.SubscriptionData.Builder	builder()
java.math.BigDecimal	getApplicationFeePercent() A non-negative decimal between 0 and 100, with at most two decimal places.
java.util.List<java.lang.String>	getDefaultTaxRates() The tax rates that will apply to any subscription item that does not have tax_rates set.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams() Map of extra parameters for custom features not available in this client library.
java.util.List<SessionCreateParams.SubscriptionData.Item>	getItems() A list of items, each with an attached plan, that the customer is subscribing to.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Set of key-value pairs that you can attach to an object.
java.lang.Long	getTrialEnd() Unix timestamp representing the end of the trial period the customer will get before being charged for the first time.
java.lang.Boolean	getTrialFromPlan() Indicates if a plan’s trial_period_days should be applied to the subscription.
java.lang.Long	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 Detail

builder

public static SessionCreateParams.SubscriptionData.Builder builder()

getApplicationFeePercent

public java.math.BigDecimal getApplicationFeePercent()

A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the Stripe-Account header or an OAuth key. For more information, see the application fees documentation.

getDefaultTaxRates

public java.util.List<java.lang.String> getDefaultTaxRates()

The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.

getExtraParams

public java.util.Map<java.lang.String,java.lang.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.

getItems

public java.util.List<SessionCreateParams.SubscriptionData.Item> getItems()

A list of items, each with an attached plan, that the customer is subscribing to. Use this parameter for subscriptions. To create one-time payments, use line_items.

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

getTrialEnd

public java.lang.Long getTrialEnd()

Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.

getTrialFromPlan

public java.lang.Boolean getTrialFromPlan()

Indicates if a plan’s trial_period_days should be applied to the subscription. Setting trial_end on subscription_data is preferred. Defaults to false.

getTrialPeriodDays

public java.lang.Long getTrialPeriodDays()

Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.