com.stripe.param.checkout

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 and Description
static class	SessionCreateParams.BillingAddressCollection Add all elements to `taxRates` list.
static class	SessionCreateParams.Builder
static class	SessionCreateParams.LineItem
static class	SessionCreateParams.Locale
static class	SessionCreateParams.Mode
static class	SessionCreateParams.PaymentIntentData The number of intervals between subscription billings.
static class	SessionCreateParams.PaymentMethodType
static class	SessionCreateParams.SetupIntentData
static class	SessionCreateParams.ShippingAddressCollection The Stripe account for which the setup is intended.
static class	SessionCreateParams.SubmitType
static class	SessionCreateParams.SubscriptionData

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

Modifier and Type	Method and Description
static SessionCreateParams.Builder	builder()
java.lang.Boolean	getAllowPromotionCodes() Enables user redeemable promotion codes.
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.
java.lang.String	getCustomer() ID of an existing customer, if one exists.
java.lang.String	getCustomerEmail() If provided, this value will be used when the Customer object is created.
java.util.List<java.lang.String>	getExpand() Specifies which fields in the response should be expanded.
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, one of payment, setup, or subscription.
SessionCreateParams.PaymentIntentData	getPaymentIntentData() A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in payment mode.
java.util.List<SessionCreateParams.PaymentMethodType>	getPaymentMethodTypes() A list of the types of payment methods (e.g., card) this Checkout session can accept.
SessionCreateParams.SetupIntentData	getSetupIntentData() A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in setup mode.
SessionCreateParams.ShippingAddressCollection	getShippingAddressCollection() When set, provides configuration for Checkout to collect a shipping address from a customer.
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 in subscription mode.
java.lang.String	getSuccessUrl() The URL to which Stripe should send customers when payment or setup is complete.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SessionCreateParams.Builder builder()

getAllowPromotionCodes

public java.lang.Boolean getAllowPromotionCodes()

Enables user redeemable promotion codes.

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.

getCustomer

public java.lang.String getCustomer()

ID of an existing customer, if one exists. The email stored on the customer will be used to prefill the email field on the Checkout page. If the customer changes their email on the Checkout page, the Customer object will be updated with the new email. If blank for Checkout Sessions in payment or subscription mode, Checkout will create a new customer object based on information provided during the session.

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 the customer field.

getExpand

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

Specifies which fields in the response should be expanded.

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. One-time Prices in subscription mode will be on the initial invoice only.

There is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.

getLocale

public SessionCreateParams.Locale getLocale()

The IETF language tag of the locale Checkout is displayed in. If blank or auto, 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 to metadata.

getMode

public SessionCreateParams.Mode getMode()

The mode of the Checkout Session, one of payment, setup, or subscription. Required when using prices or setup mode. Pass subscription if 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 in payment mode.

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.

getSetupIntentData

public SessionCreateParams.SetupIntentData getSetupIntentData()

A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in setup mode.

getShippingAddressCollection

public SessionCreateParams.ShippingAddressCollection getShippingAddressCollection()

When set, provides configuration for Checkout to collect a shipping address from a customer.

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 in payment mode, but not Checkout Sessions in subscription or setup mode.

getSubscriptionData

public SessionCreateParams.SubscriptionData getSubscriptionData()

A subset of parameters to be passed to subscription creation for Checkout Sessions in subscription 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 access to the Checkout Session for the successful payment, read more about it in our guide on fulfilling your payments with webhooks.