Package 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
Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. SeeSessionCreateParams.ShippingOption.ShippingRateData.FixedAmount.extraParams
for the field documentation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SessionCreateParams.SubscriptionData.Builder
static class
SessionCreateParams.SubscriptionData.Item
static class
SessionCreateParams.SubscriptionData.TransferData
Add all elements to `taxRates` list.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.lang.String
getCoupon()
The ID of the coupon to apply to this subscription.java.util.List<java.lang.String>
getDefaultTaxRates()
The tax rates that will apply to any subscription item that does not havetax_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.SessionCreateParams.SubscriptionData.TransferData
getTransferData()
If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.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’strial_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.
-
-
-
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 theStripe-Account
header or an OAuth key. For more information, see the application fees documentation.
-
getCoupon
public java.lang.String getCoupon()
The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.
-
getDefaultTaxRates
public java.util.List<java.lang.String> getDefaultTaxRates()
The tax rates that will apply to any subscription item that does not havetax_rates
set. Invoices created will have theirdefault_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. Prefer usingline_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 tometadata
.
-
getTransferData
public SessionCreateParams.SubscriptionData.TransferData getTransferData()
If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
-
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’strial_period_days
should be applied to the subscription. Settingtrial_end
onsubscription_data
is preferred. Defaults tofalse
.
-
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.
-
-