Package com.stripe.param

Class PaymentLinkCreateParams.SubscriptionData

java.lang.Object

com.stripe.param.PaymentLinkCreateParams.SubscriptionData

Enclosing class:

PaymentLinkCreateParams

public static class PaymentLinkCreateParams.SubscriptionData
extends Object

The ID of the Shipping Rate to use for this shipping option.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaymentLinkCreateParams.SubscriptionData.Builder
static class	PaymentLinkCreateParams.SubscriptionData.InvoiceSettings
static class	PaymentLinkCreateParams.SubscriptionData.TrialSettings	Required. Type of the account referenced in the request.

Method Summary

Modifier and Type	Method	Description
static PaymentLinkCreateParams.SubscriptionData.Builder	builder()
String	getDescription()	The subscription's description, meant to be displayable to the customer.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
PaymentLinkCreateParams.SubscriptionData.InvoiceSettings	getInvoiceSettings()	All invoices will be billed using the specified settings.
Map<String,String>	getMetadata()	Set of key-value pairs that will declaratively set metadata on Subscriptions generated from this payment link.
Long	getTrialPeriodDays()	Integer representing the number of trial period days before the customer is charged for the first time.
PaymentLinkCreateParams.SubscriptionData.TrialSettings	getTrialSettings()	Settings related to subscription trials.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static PaymentLinkCreateParams.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.

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.

getInvoiceSettings

public PaymentLinkCreateParams.SubscriptionData.InvoiceSettings getInvoiceSettings()

All invoices will be billed using the specified settings.

getMetadata

public Map<String,String> getMetadata()

Set of key-value pairs that will declaratively set metadata on Subscriptions generated from this payment link. 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. Has to be at least 1.

getTrialSettings

public PaymentLinkCreateParams.SubscriptionData.TrialSettings getTrialSettings()

Settings related to subscription trials.