# `Stripe.Resources.Checkout.Session`
[🔗](https://github.com/jeffhuen/tiger_stripe/blob/main/lib/stripe/resources/checkout/session.ex#L2)

Session

A Checkout Session represents your customer's session as they pay for
one-time purchases or subscriptions through [Checkout](https://docs.stripe.com/payments/checkout)
or [Payment Links](https://docs.stripe.com/payments/payment-links). We recommend creating a
new Session each time your customer attempts to pay.

Once payment is successful, the Checkout Session will contain a reference
to the [Customer](https://docs.stripe.com/api/customers), and either the successful
[PaymentIntent](https://docs.stripe.com/api/payment_intents) or an active
[Subscription](https://docs.stripe.com/api/subscriptions).

You can create a Checkout Session on your server and redirect to its URL
to begin Checkout.

Related guide: [Checkout quickstart](https://docs.stripe.com/checkout/quickstart)

# `t`

```elixir
@type t() :: %Stripe.Resources.Checkout.Session{
  adaptive_pricing: Stripe.Resources.Checkout.Session.AdaptivePricing.t(),
  after_expiration: Stripe.Resources.Checkout.Session.AfterExpiration.t(),
  allow_promotion_codes: boolean(),
  amount_subtotal: integer(),
  amount_total: integer(),
  automatic_tax: Stripe.Resources.Checkout.Session.AutomaticTax.t(),
  billing_address_collection: String.t(),
  branding_settings:
    Stripe.Resources.Checkout.Session.BrandingSettings.t() | nil,
  cancel_url: String.t(),
  client_reference_id: String.t(),
  client_secret: String.t(),
  collected_information:
    Stripe.Resources.Checkout.Session.CollectedInformation.t(),
  consent: Stripe.Resources.Checkout.Session.Consent.t(),
  consent_collection: Stripe.Resources.Checkout.Session.ConsentCollection.t(),
  created: integer(),
  currency: String.t(),
  currency_conversion: Stripe.Resources.Checkout.Session.CurrencyConversion.t(),
  custom_fields: [Stripe.Resources.Checkout.Session.CustomFields.t()],
  custom_text: Stripe.Resources.Checkout.Session.CustomText.t(),
  customer: String.t() | Stripe.Resources.Customer.t(),
  customer_account: String.t(),
  customer_creation: String.t(),
  customer_details: Stripe.Resources.Checkout.Session.CustomerDetails.t(),
  customer_email: String.t(),
  discounts: [Stripe.Resources.Checkout.Session.Discounts.t()],
  excluded_payment_method_types: [String.t()] | nil,
  expires_at: integer(),
  id: String.t(),
  integration_identifier: String.t(),
  invoice: String.t() | Stripe.Resources.Invoice.t(),
  invoice_creation: Stripe.Resources.Checkout.Session.InvoiceCreation.t(),
  line_items: Stripe.Resources.Checkout.Session.LineItems.t() | nil,
  livemode: boolean(),
  locale: String.t(),
  metadata: %{required(String.t()) =&gt; String.t()},
  mode: String.t(),
  name_collection: Stripe.Resources.Checkout.Session.NameCollection.t() | nil,
  object: String.t(),
  optional_items: [Stripe.Resources.Checkout.Session.OptionalItems.t()] | nil,
  origin_context: String.t(),
  payment_intent: String.t() | Stripe.Resources.PaymentIntent.t(),
  payment_link: String.t() | Stripe.Resources.PaymentLink.t(),
  payment_method_collection: String.t(),
  payment_method_configuration_details:
    Stripe.Resources.Checkout.Session.PaymentMethodConfigurationDetails.t(),
  payment_method_options:
    Stripe.Resources.Checkout.Session.PaymentMethodOptions.t(),
  payment_method_types: [String.t()],
  payment_status: String.t(),
  permissions: Stripe.Resources.Permissions.t(),
  phone_number_collection:
    Stripe.Resources.Checkout.Session.PhoneNumberCollection.t() | nil,
  presentment_details:
    Stripe.Resources.Checkout.Session.PresentmentDetails.t() | nil,
  recovered_from: String.t(),
  redirect_on_completion: String.t() | nil,
  return_url: String.t() | nil,
  saved_payment_method_options:
    Stripe.Resources.Checkout.Session.SavedPaymentMethodOptions.t(),
  setup_intent: String.t() | Stripe.Resources.SetupIntent.t(),
  shipping_address_collection: Stripe.Resources.ShippingAddressCollection.t(),
  shipping_cost: Stripe.Resources.Checkout.Session.ShippingCost.t(),
  shipping_options: [Stripe.Resources.Checkout.Session.ShippingOptions.t()],
  status: String.t(),
  submit_type: String.t(),
  subscription: String.t() | Stripe.Resources.Subscription.t(),
  success_url: String.t(),
  tax_id_collection:
    Stripe.Resources.Checkout.Session.TaxIdCollection.t() | nil,
  total_details: Stripe.Resources.Checkout.Session.TotalDetails.t(),
  ui_mode: String.t(),
  url: String.t(),
  wallet_options: Stripe.Resources.Checkout.Session.WalletOptions.t()
}
```

* `adaptive_pricing` - Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing). Nullable. Expandable.
* `after_expiration` - When set, provides configuration for actions to take if this Checkout Session expires. Nullable. Expandable.
* `allow_promotion_codes` - Enables user redeemable promotion codes. Nullable.
* `amount_subtotal` - Total of all items before discounts or taxes are applied. Nullable.
* `amount_total` - Total of all items after discounts and taxes are applied. Nullable.
* `automatic_tax` - Expandable.
* `billing_address_collection` - Describes whether Checkout should collect the customer's billing address. Defaults to `auto`. Possible values: `auto`, `required`. Nullable.
* `branding_settings` - Expandable.
* `cancel_url` - 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. Max length: 5000. Nullable.
* `client_reference_id` - 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. Max length: 5000. Nullable.
* `client_secret` - The client secret of your Checkout Session. Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. For `ui_mode: embedded`, the client secret is to be used when initializing Stripe.js embedded checkout.
For `ui_mode: custom`, use the client secret with [initCheckout](https://docs.stripe.com/js/custom_checkout/init) on your front end. Max length: 5000. Nullable.
* `collected_information` - Information about the customer collected within the Checkout Session. Nullable. Expandable.
* `consent` - Results of `consent_collection` for this session. Nullable. Expandable.
* `consent_collection` - When set, provides configuration for the Checkout Session to gather active consent from customers. Nullable. Expandable.
* `created` - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
* `currency` - Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: ISO 4217 currency code. Nullable.
* `currency_conversion` - Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions created before 2025-03-31. Nullable. Expandable.
* `custom_fields` - Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `custom`. Expandable.
* `custom_text` - Expandable.
* `customer` - The ID of the customer for this Session.
For Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout
will create a new customer object based on information provided
during the payment flow unless an existing customer was provided when
the Session was created. Nullable. Expandable.
* `customer_account` - The ID of the account for this Session. Max length: 5000. Nullable.
* `customer_creation` - Configure whether a Checkout Session creates a Customer when the Checkout Session completes. Possible values: `always`, `if_required`. Nullable.
* `customer_details` - The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode. Nullable. Expandable.
* `customer_email` - 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 the payment flow is
complete, use the `customer` attribute. Max length: 5000. Nullable.
* `discounts` - List of coupons and promotion codes attached to the Checkout Session. Nullable. Expandable.
* `excluded_payment_method_types` - A list of the types of payment methods (e.g., `card`) that should be excluded from this Checkout Session. This should only be used when payment methods for this Checkout Session are managed through the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
* `expires_at` - The timestamp at which the Checkout Session will expire. Format: Unix timestamp.
* `id` - Unique identifier for the object. Max length: 5000.
* `integration_identifier` - The integration identifier for this Checkout Session. Multiple Checkout Sessions can have the same integration identifier. Max length: 5000. Nullable.
* `invoice` - ID of the invoice created by the Checkout Session, if it exists. Nullable. Expandable.
* `invoice_creation` - Details on the state of invoice creation for the Checkout Session. Nullable. Expandable.
* `line_items` - The line items purchased by the customer. Expandable.
* `livemode` - If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
* `locale` - The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used. Possible values: `auto`, `bg`, `cs`, `da`, `de`, `el`, `en`, `en-GB`, `es`, `es-419`, `et`, `fi`, `fil`, `fr`, `fr-CA`, `hr`, `hu`, `id`, `it`, `ja`, `ko`, `lt`, `lv`, `ms`, `mt`, `nb`, `nl`, `pl`, `pt`, `pt-BR`, `ro`, `ru`, `sk`, `sl`, `sv`, `th`, `tr`, `vi`, `zh`, `zh-HK`, `zh-TW`. Nullable.
* `metadata` - Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Nullable.
* `mode` - The mode of the Checkout Session. Possible values: `payment`, `setup`, `subscription`.
* `name_collection` - Expandable.
* `object` - String representing the object's type. Objects of the same type share the same value. Possible values: `checkout.session`.
* `optional_items` - The optional items presented to the customer at checkout. Nullable. Expandable.
* `origin_context` - Where the user is coming from. This informs the optimizations that are applied to the session. Possible values: `mobile_app`, `web`. Nullable.
* `payment_intent` - The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://docs.stripe.com/api/checkout/sessions/expire) instead. Nullable. Expandable.
* `payment_link` - The ID of the Payment Link that created this Session. Nullable. Expandable.
* `payment_method_collection` - Configure whether a Checkout Session should collect a payment method. Defaults to `always`. Possible values: `always`, `if_required`. Nullable.
* `payment_method_configuration_details` - Information about the payment method configuration used for this Checkout session if using dynamic payment methods. Nullable. Expandable.
* `payment_method_options` - Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession. Nullable. Expandable.
* `payment_method_types` - A list of the types of payment methods (e.g. card) this Checkout
Session is allowed to accept.
* `payment_status` - The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.
You can use this value to decide when to fulfill your customer's order. Possible values: `no_payment_required`, `paid`, `unpaid`.
* `permissions` - This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.

For specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`. Nullable. Expandable.
* `phone_number_collection` - Expandable.
* `presentment_details` - Expandable.
* `recovered_from` - The ID of the original expired Checkout Session that triggered the recovery flow. Max length: 5000. Nullable.
* `redirect_on_completion` - This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. Possible values: `always`, `if_required`, `never`.
* `return_url` - Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. Max length: 5000.
* `saved_payment_method_options` - Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode. Nullable. Expandable.
* `setup_intent` - The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://docs.stripe.com/api/checkout/sessions/expire) instead. Nullable. Expandable.
* `shipping_address_collection` - When set, provides configuration for Checkout to collect a shipping address from a customer. Nullable. Expandable.
* `shipping_cost` - The details of the customer cost of shipping, including the customer chosen ShippingRate. Nullable. Expandable.
* `shipping_options` - The shipping rate options applied to this Session. Expandable.
* `status` - The status of the Checkout Session, one of `open`, `complete`, or `expired`. Possible values: `complete`, `expired`, `open`. Nullable.
* `submit_type` - 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. Possible values: `auto`, `book`, `donate`, `pay`, `subscribe`. Nullable.
* `subscription` - The ID of the [Subscription](https://docs.stripe.com/api/subscriptions) for Checkout Sessions in `subscription` mode. Nullable. Expandable.
* `success_url` - The URL the customer will be directed to after the payment or
subscription creation is successful. Max length: 5000. Nullable.
* `tax_id_collection` - Expandable.
* `total_details` - Tax and discount details for the computed total amount. Nullable. Expandable.
* `ui_mode` - The UI mode of the Session. Defaults to `hosted_page`. Possible values: `elements`, `embedded_page`, `form`, `hosted_page`. Nullable.
* `url` - The URL to the Checkout Session. Applies to Checkout Sessions with `ui_mode: hosted`. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://docs.stripe.com/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`
This value is only present when the session is active. Max length: 5000. Nullable.
* `wallet_options` - Wallet-specific configuration for this Checkout Session. Nullable. Expandable.

# `expandable_fields`

# `object_name`

---

*Consult [api-reference.md](api-reference.md) for complete listing*
