Class SessionCreateParams


public class SessionCreateParams extends ApiRequestParams
  • Method Details

    • builder

      public static SessionCreateParams.Builder builder()
    • getAfterExpiration

      public SessionCreateParams.AfterExpiration getAfterExpiration()
      Configure actions after a Checkout Session has expired.
    • getAllowPromotionCodes

      public 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. Defaults to auto.
    • getCancelUrl

      public String getCancelUrl()
      If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
    • getClientReferenceId

      public 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.
    • getCurrency

      public String getCurrency()
      Three-letter ISO currency code, in lowercase. Must be a supported currency. Required in setup mode when payment_method_types is not set.
    • getCustomFields

      public List<SessionCreateParams.CustomField> getCustomFields()
      Collect additional information from your customer using custom fields. Up to 3 fields are supported.
    • getCustomText

      public SessionCreateParams.CustomText getCustomText()
      Display additional text for your customers using custom text.
    • getCustomer

      public String getCustomer()
      ID of an existing Customer, if one exists. In payment mode, the customer’s most recently saved card payment method will be used to prefill the email, name, card details, and billing address on the Checkout page. In subscription mode, the customer’s default payment method will be used if it’s a card, otherwise the most recently saved 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 subscription mode or with customer_creation set as always in payment 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 don't create Customers instead are grouped by guest customers in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.

      Can only be set in payment and setup mode.

    • getCustomerEmail

      public 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.
    • getCustomerUpdate

      public SessionCreateParams.CustomerUpdate getCustomerUpdate()
      Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when customer is provided.
    • getDiscounts

      public List<SessionCreateParams.Discount> getDiscounts()
      The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.
    • getExpiresAt

      public Long getExpiresAt()
      The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.
    • 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.
    • getInvoiceCreation

      public SessionCreateParams.InvoiceCreation getInvoiceCreation()
      Generate a post-purchase Invoice for one-time payments.
    • getLineItems

      public 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 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 or auto, the browser's locale is used.
    • getMetadata

      public Map<String,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. Pass subscription 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 in payment mode.
    • getPaymentMethodCollection

      public SessionCreateParams.PaymentMethodCollection getPaymentMethodCollection()
      Specify whether Checkout should collect a payment method. When set to if_required, Checkout will not collect a payment method when the total due for the session is 0. This may occur if the Checkout Session includes a free trial or a discount.

      Can only be set in subscription mode. Defaults to always.

      If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring subscriptions with a free trial.

    • getPaymentMethodConfiguration

      public String getPaymentMethodConfiguration()
      The ID of the payment method configuration to use with this Checkout session.
    • getPaymentMethodData

      public SessionCreateParams.PaymentMethodData getPaymentMethodData()
      This parameter allows you to set some attributes on the payment method created during a Checkout session.
    • getPaymentMethodOptions

      public SessionCreateParams.PaymentMethodOptions getPaymentMethodOptions()
      Payment-method-specific configuration.
    • getPaymentMethodTypes

      public List<SessionCreateParams.PaymentMethodType> getPaymentMethodTypes()
      A list of the types of payment methods (e.g., card) this Checkout Session can accept.

      You can omit this attribute to manage your payment methods from the Stripe Dashboard. See Dynamic Payment Methods for more details.

      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.

    • getRedirectOnCompletion

      public SessionCreateParams.RedirectOnCompletion getRedirectOnCompletion()
      This parameter applies to ui_mode: embedded. Learn more about the redirect behavior of embedded sessions. Defaults to always.
    • getReturnUrl

      public String getReturnUrl()
      The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. This parameter is required if ui_mode is embedded and redirect-based payment methods are enabled on the session.
    • getSavedPaymentMethodOptions

      public SessionCreateParams.SavedPaymentMethodOptions getSavedPaymentMethodOptions()
      Controls saved payment method settings for the session. Only available in payment and subscription mode.
    • 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.
    • getShippingOptions

      public List<SessionCreateParams.ShippingOption> getShippingOptions()
      The shipping rate options to apply to this Session. Up to a maximum of 5.
    • 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. If blank or auto, pay is used.
    • getSubscriptionData

      public SessionCreateParams.SubscriptionData getSubscriptionData()
      A subset of parameters to be passed to subscription creation for Checkout Sessions in subscription mode.
    • getSuccessUrl

      public String getSuccessUrl()
      The URL to which Stripe should send customers when payment or setup is complete. This parameter is not allowed if ui_mode is embedded. 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 during checkout.
    • getUiMode

      public SessionCreateParams.UiMode getUiMode()
      The UI mode of the Session. Defaults to hosted.