Class SessionCreateParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.checkout.SessionCreateParams
-
public class SessionCreateParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SessionCreateParams.AfterExpiration
static class
SessionCreateParams.AutomaticTax
Add all map key/value pairs to `extraParams` map.static class
SessionCreateParams.BillingAddressCollection
Add all map key/value pairs to `extraParams` map.static class
SessionCreateParams.Builder
static class
SessionCreateParams.ConsentCollection
Add all map key/value pairs to `extraParams` map.static class
SessionCreateParams.CustomerCreation
static class
SessionCreateParams.CustomerUpdate
static class
SessionCreateParams.Discount
static class
SessionCreateParams.LineItem
The ID of a promotion code to apply to this Session.static class
SessionCreateParams.Locale
static class
SessionCreateParams.Mode
static class
SessionCreateParams.PaymentIntentData
The number of intervals between subscription billings.static class
SessionCreateParams.PaymentMethodOptions
static class
SessionCreateParams.PaymentMethodType
static class
SessionCreateParams.PhoneNumberCollection
Add all map key/value pairs to `extraParams` map.static class
SessionCreateParams.SetupIntentData
Add all map key/value pairs to `extraParams` map.static class
SessionCreateParams.ShippingAddressCollection
The Stripe account for which the setup is intended.static class
SessionCreateParams.ShippingOption
static class
SessionCreateParams.SubmitType
static class
SessionCreateParams.SubscriptionData
Add all map key/value pairs to `extraParams` map.static class
SessionCreateParams.TaxIdCollection
Add all map key/value pairs to `extraParams` map.-
Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams
ApiRequestParams.EnumParam
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiRequestParams
EXTRA_PARAMS_KEY
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SessionCreateParams.Builder
builder()
SessionCreateParams.AfterExpiration
getAfterExpiration()
Configure actions after a Checkout Session has expired.java.lang.Boolean
getAllowPromotionCodes()
Enables user redeemable promotion codes.SessionCreateParams.AutomaticTax
getAutomaticTax()
Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.SessionCreateParams.BillingAddressCollection
getBillingAddressCollection()
Specify whether Checkout should collect the customer's billing address.java.lang.String
getCancelUrl()
The URL the customer will be directed to if they decide to cancel payment and return to your website.java.lang.String
getClientReferenceId()
A unique string to reference the Checkout Session.SessionCreateParams.ConsentCollection
getConsentCollection()
Configure fields for the Checkout Session to gather active consent from customers.java.lang.String
getCustomer()
ID of an existing Customer, if one exists.SessionCreateParams.CustomerCreation
getCustomerCreation()
Configure whether a Checkout Session creates a Customer during Session confirmation.java.lang.String
getCustomerEmail()
If provided, this value will be used when the Customer object is created.SessionCreateParams.CustomerUpdate
getCustomerUpdate()
Controls what fields on Customer can be updated by the Checkout Session.java.util.List<SessionCreateParams.Discount>
getDiscounts()
The coupon or promotion code to apply to this Session.java.util.List<java.lang.String>
getExpand()
Specifies which fields in the response should be expanded.java.lang.Long
getExpiresAt()
The Epoch time in seconds at which the Checkout Session will expire.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.LineItem>
getLineItems()
A list of items the customer is purchasing.SessionCreateParams.Locale
getLocale()
The IETF language tag of the locale Checkout is displayed in.java.util.Map<java.lang.String,java.lang.String>
getMetadata()
Set of key-value pairs that you can attach to an object.SessionCreateParams.Mode
getMode()
The mode of the Checkout Session.SessionCreateParams.PaymentIntentData
getPaymentIntentData()
A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions inpayment
mode.SessionCreateParams.PaymentMethodOptions
getPaymentMethodOptions()
Payment-method-specific configuration.java.util.List<SessionCreateParams.PaymentMethodType>
getPaymentMethodTypes()
A list of the types of payment methods (e.g.,card
) this Checkout Session can accept.SessionCreateParams.PhoneNumberCollection
getPhoneNumberCollection()
Controls phone number collection settings for the session.SessionCreateParams.SetupIntentData
getSetupIntentData()
A subset of parameters to be passed to SetupIntent creation for Checkout Sessions insetup
mode.SessionCreateParams.ShippingAddressCollection
getShippingAddressCollection()
When set, provides configuration for Checkout to collect a shipping address from a customer.java.util.List<SessionCreateParams.ShippingOption>
getShippingOptions()
The shipping rate options to apply to this Session.java.util.List<java.lang.String>
getShippingRates()
[Deprecated] The shipping rate to apply to this Session.SessionCreateParams.SubmitType
getSubmitType()
Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button.SessionCreateParams.SubscriptionData
getSubscriptionData()
A subset of parameters to be passed to subscription creation for Checkout Sessions insubscription
mode.java.lang.String
getSuccessUrl()
The URL to which Stripe should send customers when payment or setup is complete.SessionCreateParams.TaxIdCollection
getTaxIdCollection()
Controls tax ID collection settings for the session.-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static SessionCreateParams.Builder builder()
-
getAfterExpiration
public SessionCreateParams.AfterExpiration getAfterExpiration()
Configure actions after a Checkout Session has expired.
-
getAllowPromotionCodes
public java.lang.Boolean getAllowPromotionCodes()
Enables user redeemable promotion codes.
-
getAutomaticTax
public SessionCreateParams.AutomaticTax getAutomaticTax()
Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
-
getBillingAddressCollection
public SessionCreateParams.BillingAddressCollection getBillingAddressCollection()
Specify whether Checkout should collect the customer's billing address.
-
getCancelUrl
public java.lang.String getCancelUrl()
The URL the customer will be directed to if they decide to cancel payment and return to your website.
-
getClientReferenceId
public java.lang.String getClientReferenceId()
A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the session with your internal systems.
-
getConsentCollection
public SessionCreateParams.ConsentCollection getConsentCollection()
Configure fields for the Checkout Session to gather active consent from customers.
-
getCustomer
public java.lang.String getCustomer()
ID of an existing Customer, if one exists. Inpayment
mode, the customer’s most recent card payment method will be used to prefill the email, name, card details, and billing address on the Checkout page. Insubscription
mode, the customer’s default payment method will be used if it’s a card, and otherwise the most recent card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details.If the Customer already has a valid email set, the email will be prefilled and not editable in Checkout. If the Customer does not have a valid
email
, Checkout will set the email entered during the session on the Customer.If blank for Checkout Sessions in
payment
orsubscription
mode, Checkout will create a new Customer object based on information provided during the payment flow.You can set
payment_intent_data.setup_future_usage
to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.
-
getCustomerCreation
public SessionCreateParams.CustomerCreation getCustomerCreation()
Configure whether a Checkout Session creates a Customer during Session confirmation.When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout with customer_details.
Sessions that do not create Customers will instead create Guest Customers in the Dashboard.
Can only be set in
payment
andsetup
mode.
-
getCustomerEmail
public java.lang.String getCustomerEmail()
If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address. Use this parameter to prefill customer data if you already have an email on file. To access information about the customer once a session is complete, use thecustomer
field.
-
getCustomerUpdate
public SessionCreateParams.CustomerUpdate getCustomerUpdate()
Controls what fields on Customer can be updated by the Checkout Session. Can only be provided whencustomer
is provided.
-
getDiscounts
public java.util.List<SessionCreateParams.Discount> getDiscounts()
The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
-
getExpand
public java.util.List<java.lang.String> getExpand()
Specifies which fields in the response should be expanded.
-
getExpiresAt
public java.lang.Long getExpiresAt()
The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 1 to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.
-
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.
-
getLineItems
public java.util.List<SessionCreateParams.LineItem> getLineItems()
A list of items the customer is purchasing. Use this parameter to pass one-time or recurring Prices.For
payment
mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.For
subscription
mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices in will be on the initial invoice only.
-
getLocale
public SessionCreateParams.Locale getLocale()
The IETF language tag of the locale Checkout is displayed in. If blank orauto
, the browser's locale is used.
-
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
.
-
getMode
public SessionCreateParams.Mode getMode()
The mode of the Checkout Session. Required when using prices orsetup
mode. Passsubscription
if the Checkout Session includes at least one recurring item.
-
getPaymentIntentData
public SessionCreateParams.PaymentIntentData getPaymentIntentData()
A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions inpayment
mode.
-
getPaymentMethodOptions
public SessionCreateParams.PaymentMethodOptions getPaymentMethodOptions()
Payment-method-specific configuration.
-
getPaymentMethodTypes
public java.util.List<SessionCreateParams.PaymentMethodType> getPaymentMethodTypes()
A list of the types of payment methods (e.g.,card
) this Checkout Session can accept.Read more about the supported payment methods and their requirements in our payment method details guide.
If multiple payment methods are passed, Checkout will dynamically reorder them to prioritize the most relevant payment methods based on the customer's location and other characteristics.
-
getPhoneNumberCollection
public SessionCreateParams.PhoneNumberCollection getPhoneNumberCollection()
Controls phone number collection settings for the session.We recommend that you review your privacy policy and check with your legal contacts before using this feature. Learn more about collecting phone numbers with Checkout.
-
getSetupIntentData
public SessionCreateParams.SetupIntentData getSetupIntentData()
A subset of parameters to be passed to SetupIntent creation for Checkout Sessions insetup
mode.
-
getShippingAddressCollection
public SessionCreateParams.ShippingAddressCollection getShippingAddressCollection()
When set, provides configuration for Checkout to collect a shipping address from a customer.
-
getShippingOptions
public java.util.List<SessionCreateParams.ShippingOption> getShippingOptions()
The shipping rate options to apply to this Session.
-
getShippingRates
public java.util.List<java.lang.String> getShippingRates()
[Deprecated] The shipping rate to apply to this Session. Only up to one may be specified.
-
getSubmitType
public SessionCreateParams.SubmitType getSubmitType()
Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the submit button.submit_type
can only be specified on Checkout Sessions inpayment
mode, but not Checkout Sessions insubscription
orsetup
mode.
-
getSubscriptionData
public SessionCreateParams.SubscriptionData getSubscriptionData()
A subset of parameters to be passed to subscription creation for Checkout Sessions insubscription
mode.
-
getSuccessUrl
public java.lang.String getSuccessUrl()
The URL to which Stripe should send customers when payment or setup is complete. If you’d like to use information from the successful Checkout Session on your page, read the guide on customizing your success page.
-
getTaxIdCollection
public SessionCreateParams.TaxIdCollection getTaxIdCollection()
Controls tax ID collection settings for the session.
-
-