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.Operations.PostCheckoutSessions

Contains the different functions to run the operation postCheckoutSessions

  • 107 types
  • 56 values
  • Packagestripeapi-3.0.0.0
  • Exports163
  • LanguageHaskell2010
  • LicenceMIT
  • SourcePostCheckoutSessions.hs
datadata PostCheckoutSessionsRequestBody
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyAfterExpiration'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.after_expiration in the specification.

Configure actions after a Checkout Session has expired.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyAfterExpiration'Recovery'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.after_expiration.properties.recovery in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyAutomaticTax'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.automatic_tax in the specification.

Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyBillingAddressCollection'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.billing_address_collection in the specification.

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

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyConsentCollection'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.consent_collection in the specification.

Configure fields for the Checkout Session to gather active consent from customers.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyConsentCollection'Promotions'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.consent_collection.properties.promotions in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyCustomerCreation'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.customer_creation in the specification.

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 create 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.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyCustomerUpdate'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.customer_update in the specification.

Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyCustomerUpdate'Address'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.customer_update.properties.address in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyCustomerUpdate'Name'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.customer_update.properties.name in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyCustomerUpdate'Shipping'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.customer_update.properties.shipping in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyDiscounts'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.discounts.items in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyLineItems'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.line_items.items in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyLineItems'AdjustableQuantity'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.line_items.items.properties.adjustable_quantity in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyLineItems'PriceData'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.line_items.items.properties.price_data in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyLineItems'PriceData'ProductData'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.line_items.items.properties.price_data.properties.product_data in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyLineItems'PriceData'Recurring'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.line_items.items.properties.price_data.properties.recurring in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyLineItems'PriceData'Recurring'Interval'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.line_items.items.properties.price_data.properties.recurring.properties.interval in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyLineItems'PriceData'TaxBehavior'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.line_items.items.properties.price_data.properties.tax_behavior in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyLocale'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.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 PostCheckoutSessionsRequestBodyMode'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mode in the specification.

The mode of the Checkout Session. Required when using prices or `setup` mode. Pass `subscription` if the Checkout Session includes at least one recurring item.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentIntentData'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_intent_data in the specification.

A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentIntentData'CaptureMethod'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_intent_data.properties.capture_method in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentIntentData'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_intent_data.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentIntentData'Shipping'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_intent_data.properties.shipping in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentIntentData'Shipping'Address'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_intent_data.properties.shipping.properties.address in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentIntentData'TransferData'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_intent_data.properties.transfer_data in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options in the specification.

Payment-method-specific configuration.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'AcssDebit'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'AcssDebit'Currency'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit.properties.currency in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'AcssDebit'MandateOptions'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit.properties.mandate_options in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'AcssDebit'MandateOptions'CustomMandateUrl'Variants
#

Defines the oneOf schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit.properties.mandate_options.properties.custom_mandate_url.anyOf in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'AcssDebit'MandateOptions'DefaultFor'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit.properties.mandate_options.properties.default_for.items in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'AcssDebit'MandateOptions'PaymentSchedule'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit.properties.mandate_options.properties.payment_schedule in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'AcssDebit'MandateOptions'TransactionType'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit.properties.mandate_options.properties.transaction_type in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'AcssDebit'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'AcssDebit'VerificationMethod'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.acss_debit.properties.verification_method in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Affirm'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.affirm in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Affirm'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.affirm.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'AfterpayClearpay'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.afterpay_clearpay in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'AfterpayClearpay'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.afterpay_clearpay.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Alipay'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.alipay in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Alipay'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.alipay.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'AuBecsDebit'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.au_becs_debit in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'AuBecsDebit'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.au_becs_debit.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'BacsDebit'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.bacs_debit in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'BacsDebit'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.bacs_debit.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Bancontact'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.bancontact in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Bancontact'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.bancontact.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Boleto'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.boleto in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Boleto'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.boleto.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Card'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.card in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Card'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.card.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Eps'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.eps in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Eps'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.eps.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Fpx'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.fpx in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Fpx'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.fpx.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Giropay'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.giropay in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Giropay'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.giropay.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Grabpay'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.grabpay in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Grabpay'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.grabpay.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Ideal'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.ideal in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Ideal'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.ideal.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Klarna'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.klarna in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Klarna'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.klarna.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Konbini'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.konbini in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Konbini'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.konbini.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Oxxo'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.oxxo in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Oxxo'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.oxxo.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'P24'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.p24 in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'P24'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.p24.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Paynow'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.paynow in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Paynow'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.paynow.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'SepaDebit'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.sepa_debit in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'SepaDebit'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.sepa_debit.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Sofort'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.sofort in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'Sofort'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.sofort.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'UsBankAccount'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.us_bank_account in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'UsBankAccount'FinancialConnections'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.us_bank_account.properties.financial_connections in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'UsBankAccount'FinancialConnections'Permissions'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.us_bank_account.properties.financial_connections.properties.permissions.items in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'UsBankAccount'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.us_bank_account.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'UsBankAccount'VerificationMethod'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.us_bank_account.properties.verification_method in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'WechatPay'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.wechat_pay in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'WechatPay'Client'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.wechat_pay.properties.client in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodOptions'WechatPay'SetupFutureUsage'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_options.properties.wechat_pay.properties.setup_future_usage in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPaymentMethodTypes'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_method_types.items in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyPhoneNumberCollection'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.phone_number_collection in the specification.

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.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodySetupIntentData'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.setup_intent_data in the specification.

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

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyShippingAddressCollection'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping_address_collection in the specification.

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

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyShippingAddressCollection'AllowedCountries'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping_address_collection.properties.allowed_countries.items in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyShippingOptions'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping_options.items in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping_options.items.properties.shipping_rate_data in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'DeliveryEstimate'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping_options.items.properties.shipping_rate_data.properties.delivery_estimate in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'DeliveryEstimate'Maximum'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping_options.items.properties.shipping_rate_data.properties.delivery_estimate.properties.maximum in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
valuemkPostCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'DeliveryEstimate'Maximum'
  1. :: PostCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'DeliveryEstimate'Maximum'Unit'

    postCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'DeliveryEstimate'Maximum'Unit

  2. -> Int

    postCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'DeliveryEstimate'Maximum'Value

  3. -> PostCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'DeliveryEstimate'Maximum'
#

Create a new PostCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'DeliveryEstimate'Maximum' with all required fields.

datadata PostCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'DeliveryEstimate'Maximum'Unit'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping_options.items.properties.shipping_rate_data.properties.delivery_estimate.properties.maximum.properties.unit in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'DeliveryEstimate'Minimum'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping_options.items.properties.shipping_rate_data.properties.delivery_estimate.properties.minimum in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
valuemkPostCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'DeliveryEstimate'Minimum'
  1. :: PostCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'DeliveryEstimate'Minimum'Unit'

    postCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'DeliveryEstimate'Minimum'Unit

  2. -> Int

    postCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'DeliveryEstimate'Minimum'Value

  3. -> PostCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'DeliveryEstimate'Minimum'
#

Create a new PostCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'DeliveryEstimate'Minimum' with all required fields.

datadata PostCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'DeliveryEstimate'Minimum'Unit'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping_options.items.properties.shipping_rate_data.properties.delivery_estimate.properties.minimum.properties.unit in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'FixedAmount'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping_options.items.properties.shipping_rate_data.properties.fixed_amount in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'TaxBehavior'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping_options.items.properties.shipping_rate_data.properties.tax_behavior in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyShippingOptions'ShippingRateData'Type'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping_options.items.properties.shipping_rate_data.properties.type in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodySubmitType'
#

Defines the enum schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.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 PostCheckoutSessionsRequestBodySubscriptionData'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.subscription_data in the specification.

A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodySubscriptionData'Items'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.subscription_data.properties.items.items in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodySubscriptionData'TransferData'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.subscription_data.properties.transfer_data in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsRequestBodyTaxIdCollection'
#

Defines the object schema located at paths./v1/checkout/sessions.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.tax_id_collection in the specification.

Controls tax ID collection settings for the session.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostCheckoutSessionsResponse
#

Represents a response of the operation postCheckoutSessions.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostCheckoutSessionsResponseError is used.

Constructors

Instances2Eq, Show