HORIZON HASKELLDocslts/ghc-9.10.x248f8f02026-10-05Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · 248f8f0 · 2026-10-05

Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Checkout_Session

Contains the types generated from the schema Checkout_Session

  • 29 types
  • 12 values
  • Packagestripeapi-3.0.0.0
  • Exports41
  • LanguageHaskell2010
  • LicenceMIT
  • SourceCheckout_Session.hs
datadata Checkout'session
#

Defines the object schema located at components.schemas.checkout.session in the specification.

A Checkout Session represents your customer's session as they pay for one-time purchases or subscriptions through Checkout or 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, and either the successful PaymentIntent or an active Subscription.

You can create a Checkout Session on your server and pass its ID to the client to begin Checkout.

Related guide: Checkout Server Quickstart.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
valuemkCheckout'session
  1. :: PaymentPagesCheckoutSessionAutomaticTax

    checkout'sessionAutomaticTax

  2. -> Text

    checkout'sessionCancelUrl

  3. -> Int

    checkout'sessionExpiresAt

  4. -> Text

    checkout'sessionId

  5. -> Bool

    checkout'sessionLivemode

  6. -> Checkout'sessionMode'

    checkout'sessionMode

  7. -> [Text]

    checkout'sessionPaymentMethodTypes

  8. -> Checkout'sessionPaymentStatus'

    checkout'sessionPaymentStatus

  9. -> [PaymentPagesCheckoutSessionShippingOption]

    checkout'sessionShippingOptions

  10. -> Text

    checkout'sessionSuccessUrl

  11. -> Checkout'session
#

Create a new Checkout'session with all required fields.

datadata Checkout'sessionAfterExpiration'NonNullable
#

Defines the object schema located at components.schemas.checkout.session.properties.after_expiration.anyOf in the specification.

When set, provides configuration for actions to take if this Checkout Session expires.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionAfterExpiration'NonNullableRecovery'NonNullable
#

Defines the object schema located at components.schemas.checkout.session.properties.after_expiration.anyOf.properties.recovery.anyOf in the specification.

When set, configuration used to recover the Checkout Session on expiry.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionBillingAddressCollection'NonNullable
#

Defines the enum schema located at components.schemas.checkout.session.properties.billing_address_collection in the specification.

Describes whether Checkout should collect the customer's billing address.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionConsent'NonNullable
#

Defines the object schema located at components.schemas.checkout.session.properties.consent.anyOf in the specification.

Results of \`consent_collection\` for this session.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionConsent'NonNullablePromotions'NonNullable
#

Defines the enum schema located at components.schemas.checkout.session.properties.consent.anyOf.properties.promotions in the specification.

If `opt_in`, the customer consents to receiving promotional communications from the merchant about this Checkout Session.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionConsentCollection'NonNullable
#

Defines the object schema located at components.schemas.checkout.session.properties.consent_collection.anyOf in the specification.

When set, provides configuration for the Checkout Session to gather active consent from customers.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionConsentCollection'NonNullablePromotions'NonNullable
#

Defines the enum schema located at components.schemas.checkout.session.properties.consent_collection.anyOf.properties.promotions in the specification.

If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout Session will determine whether to display an option to opt into promotional communication from the merchant depending on the customer's locale. Only available to US merchants.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionCustomer'NonNullableVariants
#

Defines the oneOf schema located at components.schemas.checkout.session.properties.customer.anyOf in the specification.

The ID of the customer for this Session. For Checkout Sessions in `payment` or `subscription` 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.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionCustomerCreation'NonNullable
#

Defines the enum schema located at components.schemas.checkout.session.properties.customer_creation in the specification.

Configure whether a Checkout Session creates a Customer when the Checkout Session completes.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionCustomerDetails'NonNullable
#

Defines the object schema located at components.schemas.checkout.session.properties.customer_details.anyOf in the specification.

The customer details including the customer\'s tax exempt status and the customer\'s tax IDs. Only present on Sessions in \`payment\` or \`subscription\` mode.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionCustomerDetails'NonNullableAddress'NonNullable
#

Defines the object schema located at components.schemas.checkout.session.properties.customer_details.anyOf.properties.address.anyOf in the specification.

The customer\'s address at the time of checkout. Note: This property is populated only for sessions on or after March 30, 2022.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionCustomerDetails'NonNullableTaxExempt'NonNullable
#

Defines the enum schema located at components.schemas.checkout.session.properties.customer_details.anyOf.properties.tax_exempt in the specification.

The customer’s tax exempt status at time of checkout.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionLineItems'
#

Defines the object schema located at components.schemas.checkout.session.properties.line_items in the specification.

The line items purchased by the customer.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionLocale'NonNullable
#

Defines the enum schema located at components.schemas.checkout.session.properties.locale in the specification.

The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionMode'
#

Defines the enum schema located at components.schemas.checkout.session.properties.mode in the specification.

The mode of the Checkout Session.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionPaymentIntent'NonNullableVariants
#

Defines the oneOf schema located at components.schemas.checkout.session.properties.payment_intent.anyOf in the specification.

The ID of the PaymentIntent for Checkout Sessions in `payment` mode.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionPaymentMethodOptions'NonNullable
#

Defines the object schema located at components.schemas.checkout.session.properties.payment_method_options.anyOf in the specification.

Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionPaymentStatus'
#

Defines the enum schema located at components.schemas.checkout.session.properties.payment_status in the specification.

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.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionSetupIntent'NonNullableVariants
#

Defines the oneOf schema located at components.schemas.checkout.session.properties.setup_intent.anyOf in the specification.

The ID of the SetupIntent for Checkout Sessions in `setup` mode.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionShipping'NonNullable
#

Defines the object schema located at components.schemas.checkout.session.properties.shipping.anyOf in the specification.

Shipping information for this Checkout Session.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionShippingAddressCollection'NonNullable
#

Defines the object schema located at components.schemas.checkout.session.properties.shipping_address_collection.anyOf in the specification.

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

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionShippingAddressCollection'NonNullableAllowedCountries'
#

Defines the enum schema located at components.schemas.checkout.session.properties.shipping_address_collection.anyOf.properties.allowed_countries.items in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionShippingRate'NonNullableVariants
#

Defines the oneOf schema located at components.schemas.checkout.session.properties.shipping_rate.anyOf in the specification.

The ID of the ShippingRate for Checkout Sessions in `payment` mode.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionStatus'NonNullable
#

Defines the enum schema located at components.schemas.checkout.session.properties.status in the specification.

The status of the Checkout Session, one of `open`, `complete`, or `expired`.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionSubmitType'NonNullable
#

Defines the enum schema located at components.schemas.checkout.session.properties.submit_type in the specification.

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.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionSubscription'NonNullableVariants
#

Defines the oneOf schema located at components.schemas.checkout.session.properties.subscription.anyOf in the specification.

The ID of the subscription for Checkout Sessions in `subscription` mode.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Checkout'sessionTotalDetails'NonNullable
#

Defines the object schema located at components.schemas.checkout.session.properties.total_details.anyOf in the specification.

Tax and discount details for the computed total amount.

Constructors

Instances4Eq, Show, FromJSON, ToJSON