StripeAPI.Types.Checkout_Session

Contains the types generated from the schema Checkout_Session

Documentation

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

Checkout'session

Fields

• checkout'sessionAllowPromotionCodes :: Maybe Bool

  allow_promotion_codes: Enables user redeemable promotion codes.

• checkout'sessionAmountSubtotal :: Maybe Int

  amount_subtotal: Total of all items before discounts or taxes are applied.

• checkout'sessionAmountTotal :: Maybe Int

  amount_total: Total of all items after discounts and taxes are applied.

• checkout'sessionAutomaticTax :: PaymentPagesCheckoutSessionAutomaticTax

  automatic_tax:

• checkout'sessionBillingAddressCollection :: Maybe Checkout'sessionBillingAddressCollection'

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

• checkout'sessionCancelUrl :: Text

  cancel_url: The URL the customer will be directed to if they decide to cancel payment and return to your website.

  Constraints:

  • Maximum length of 5000
• checkout'sessionClientReferenceId :: Maybe Text

  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.

  Constraints:

  • Maximum length of 5000
• checkout'sessionCurrency :: Maybe Text

  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.

• checkout'sessionCustomer :: Maybe Checkout'sessionCustomer'Variants

  customer: 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.

• checkout'sessionCustomerDetails :: Maybe Checkout'sessionCustomerDetails'

  customer_details: 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.

• checkout'sessionCustomerEmail :: Maybe Text

  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.

  Constraints:

  • Maximum length of 5000
• checkout'sessionId :: Text

  id: Unique identifier for the object. Used to pass to `redirectToCheckout` in Stripe.js.

  Constraints:

  • Maximum length of 5000
• checkout'sessionLineItems :: Maybe Checkout'sessionLineItems'

  line_items: The line items purchased by the customer.

• checkout'sessionLivemode :: Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• checkout'sessionLocale :: Maybe Checkout'sessionLocale'

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

• checkout'sessionMetadata :: Maybe Object

  metadata: 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.

• checkout'sessionMode :: Checkout'sessionMode'

  mode: The mode of the Checkout Session.

• checkout'sessionPaymentIntent :: Maybe Checkout'sessionPaymentIntent'Variants

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

• checkout'sessionPaymentMethodOptions :: Maybe Checkout'sessionPaymentMethodOptions'

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

• checkout'sessionPaymentMethodTypes :: [Text]

  payment_method_types: A list of the types of payment methods (e.g. card) this Checkout Session is allowed to accept.

• checkout'sessionPaymentStatus :: Checkout'sessionPaymentStatus'

  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.

• checkout'sessionSetupIntent :: Maybe Checkout'sessionSetupIntent'Variants

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

• checkout'sessionShipping :: Maybe Checkout'sessionShipping'

  shipping: Shipping information for this Checkout Session.

• checkout'sessionShippingAddressCollection :: Maybe Checkout'sessionShippingAddressCollection'

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

• checkout'sessionSubmitType :: Maybe Checkout'sessionSubmitType'

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

• checkout'sessionSubscription :: Maybe Checkout'sessionSubscription'Variants

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

• checkout'sessionSuccessUrl :: Text

  success_url: The URL the customer will be directed to after the payment or subscription creation is successful.

  Constraints:

  • Maximum length of 5000
• checkout'sessionTaxIdCollection :: Maybe PaymentPagesCheckoutSessionTaxIdCollection

  tax_id_collection:

• checkout'sessionTotalDetails :: Maybe Checkout'sessionTotalDetails'

  total_details: Tax and discount details for the computed total amount.

• checkout'sessionUrl :: Maybe Text

  url: The URL to the Checkout Session.

  Constraints:

  • Maximum length of 5000

Instances

Eq Checkout'session

Defined in StripeAPI.Types.Checkout_Session

Methods

(==) :: Checkout'session -> Checkout'session -> Bool

(/=) :: Checkout'session -> Checkout'session -> Bool

Show Checkout'session

Defined in StripeAPI.Types.Checkout_Session

Methods

showsPrec :: Int -> Checkout'session -> ShowS

show :: Checkout'session -> String

showList :: [Checkout'session] -> ShowS

ToJSON Checkout'session

Defined in StripeAPI.Types.Checkout_Session

Methods

toJSON :: Checkout'session -> Value

toEncoding :: Checkout'session -> Encoding

toJSONList :: [Checkout'session] -> Value

toEncodingList :: [Checkout'session] -> Encoding

FromJSON Checkout'session

Defined in StripeAPI.Types.Checkout_Session

Methods

parseJSON :: Value -> Parser Checkout'session

parseJSONList :: Value -> Parser [Checkout'session]

mkCheckout'session

Arguments

:: PaymentPagesCheckoutSessionAutomaticTax

checkout'sessionAutomaticTax

-> Text

checkout'sessionCancelUrl

-> Text

checkout'sessionId

-> Bool

checkout'sessionLivemode

-> Checkout'sessionMode'

checkout'sessionMode

-> [Text]

checkout'sessionPaymentMethodTypes

-> Checkout'sessionPaymentStatus'

checkout'sessionPaymentStatus

-> Text

checkout'sessionSuccessUrl

-> Checkout'session

Create a new Checkout'session with all required fields.

data Checkout'sessionBillingAddressCollection'

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

Checkout'sessionBillingAddressCollection'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

Checkout'sessionBillingAddressCollection'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

Checkout'sessionBillingAddressCollection'EnumAuto

Represents the JSON value "auto"

Checkout'sessionBillingAddressCollection'EnumRequired

Represents the JSON value "required"

Instances

Eq Checkout'sessionBillingAddressCollection'

Defined in StripeAPI.Types.Checkout_Session

Methods

(==) :: Checkout'sessionBillingAddressCollection' -> Checkout'sessionBillingAddressCollection' -> Bool

(/=) :: Checkout'sessionBillingAddressCollection' -> Checkout'sessionBillingAddressCollection' -> Bool

Show Checkout'sessionBillingAddressCollection'

Defined in StripeAPI.Types.Checkout_Session

Methods

showsPrec :: Int -> Checkout'sessionBillingAddressCollection' -> ShowS

show :: Checkout'sessionBillingAddressCollection' -> String

showList :: [Checkout'sessionBillingAddressCollection'] -> ShowS

ToJSON Checkout'sessionBillingAddressCollection'

Defined in StripeAPI.Types.Checkout_Session

Methods

toJSON :: Checkout'sessionBillingAddressCollection' -> Value

toEncoding :: Checkout'sessionBillingAddressCollection' -> Encoding

toJSONList :: [Checkout'sessionBillingAddressCollection'] -> Value

toEncodingList :: [Checkout'sessionBillingAddressCollection'] -> Encoding

FromJSON Checkout'sessionBillingAddressCollection'

Defined in StripeAPI.Types.Checkout_Session

Methods

parseJSON :: Value -> Parser Checkout'sessionBillingAddressCollection'

parseJSONList :: Value -> Parser [Checkout'sessionBillingAddressCollection']

data Checkout'sessionCustomer'Variants

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

Checkout'sessionCustomer'Text Text

Checkout'sessionCustomer'Customer Customer

Checkout'sessionCustomer'DeletedCustomer DeletedCustomer

Instances

Eq Checkout'sessionCustomer'Variants

Defined in StripeAPI.Types.Checkout_Session

Methods

(==) :: Checkout'sessionCustomer'Variants -> Checkout'sessionCustomer'Variants -> Bool

(/=) :: Checkout'sessionCustomer'Variants -> Checkout'sessionCustomer'Variants -> Bool

Show Checkout'sessionCustomer'Variants

Defined in StripeAPI.Types.Checkout_Session

Methods

showsPrec :: Int -> Checkout'sessionCustomer'Variants -> ShowS

show :: Checkout'sessionCustomer'Variants -> String

showList :: [Checkout'sessionCustomer'Variants] -> ShowS

ToJSON Checkout'sessionCustomer'Variants

Defined in StripeAPI.Types.Checkout_Session

Methods

toJSON :: Checkout'sessionCustomer'Variants -> Value

toEncoding :: Checkout'sessionCustomer'Variants -> Encoding

toJSONList :: [Checkout'sessionCustomer'Variants] -> Value

toEncodingList :: [Checkout'sessionCustomer'Variants] -> Encoding

FromJSON Checkout'sessionCustomer'Variants

Defined in StripeAPI.Types.Checkout_Session

Methods

parseJSON :: Value -> Parser Checkout'sessionCustomer'Variants

parseJSONList :: Value -> Parser [Checkout'sessionCustomer'Variants]

data Checkout'sessionCustomerDetails'

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

Checkout'sessionCustomerDetails'

Fields

• checkout'sessionCustomerDetails'Email :: Maybe Text

  email: The customer’s email at time of checkout.

  Constraints:

  • Maximum length of 5000
• checkout'sessionCustomerDetails'TaxExempt :: Maybe Checkout'sessionCustomerDetails'TaxExempt'

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

• checkout'sessionCustomerDetails'TaxIds :: Maybe [PaymentPagesCheckoutSessionTaxId]

  tax_ids: The customer’s tax IDs at time of checkout.

Instances

Eq Checkout'sessionCustomerDetails'

Defined in StripeAPI.Types.Checkout_Session

Methods

(==) :: Checkout'sessionCustomerDetails' -> Checkout'sessionCustomerDetails' -> Bool

(/=) :: Checkout'sessionCustomerDetails' -> Checkout'sessionCustomerDetails' -> Bool

Show Checkout'sessionCustomerDetails'

Defined in StripeAPI.Types.Checkout_Session

Methods

showsPrec :: Int -> Checkout'sessionCustomerDetails' -> ShowS

show :: Checkout'sessionCustomerDetails' -> String

showList :: [Checkout'sessionCustomerDetails'] -> ShowS

ToJSON Checkout'sessionCustomerDetails'

Defined in StripeAPI.Types.Checkout_Session

Methods

toJSON :: Checkout'sessionCustomerDetails' -> Value

toEncoding :: Checkout'sessionCustomerDetails' -> Encoding

toJSONList :: [Checkout'sessionCustomerDetails'] -> Value

toEncodingList :: [Checkout'sessionCustomerDetails'] -> Encoding

FromJSON Checkout'sessionCustomerDetails'

Defined in StripeAPI.Types.Checkout_Session

Methods

parseJSON :: Value -> Parser Checkout'sessionCustomerDetails'

parseJSONList :: Value -> Parser [Checkout'sessionCustomerDetails']

mkCheckout'sessionCustomerDetails' :: Checkout'sessionCustomerDetails'

Create a new Checkout'sessionCustomerDetails' with all required fields.

data Checkout'sessionCustomerDetails'TaxExempt'

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

Checkout'sessionCustomerDetails'TaxExempt'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

Checkout'sessionCustomerDetails'TaxExempt'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

Checkout'sessionCustomerDetails'TaxExempt'EnumExempt

Represents the JSON value "exempt"

Checkout'sessionCustomerDetails'TaxExempt'EnumNone

Represents the JSON value "none"

Checkout'sessionCustomerDetails'TaxExempt'EnumReverse

Represents the JSON value "reverse"

Instances

Eq Checkout'sessionCustomerDetails'TaxExempt'

Defined in StripeAPI.Types.Checkout_Session

Methods

(==) :: Checkout'sessionCustomerDetails'TaxExempt' -> Checkout'sessionCustomerDetails'TaxExempt' -> Bool

(/=) :: Checkout'sessionCustomerDetails'TaxExempt' -> Checkout'sessionCustomerDetails'TaxExempt' -> Bool

Show Checkout'sessionCustomerDetails'TaxExempt'

Defined in StripeAPI.Types.Checkout_Session

Methods

showsPrec :: Int -> Checkout'sessionCustomerDetails'TaxExempt' -> ShowS

show :: Checkout'sessionCustomerDetails'TaxExempt' -> String

showList :: [Checkout'sessionCustomerDetails'TaxExempt'] -> ShowS

ToJSON Checkout'sessionCustomerDetails'TaxExempt'

Defined in StripeAPI.Types.Checkout_Session

Methods

toJSON :: Checkout'sessionCustomerDetails'TaxExempt' -> Value

toEncoding :: Checkout'sessionCustomerDetails'TaxExempt' -> Encoding

toJSONList :: [Checkout'sessionCustomerDetails'TaxExempt'] -> Value

toEncodingList :: [Checkout'sessionCustomerDetails'TaxExempt'] -> Encoding

FromJSON Checkout'sessionCustomerDetails'TaxExempt'

Defined in StripeAPI.Types.Checkout_Session

Methods

parseJSON :: Value -> Parser Checkout'sessionCustomerDetails'TaxExempt'

parseJSONList :: Value -> Parser [Checkout'sessionCustomerDetails'TaxExempt']

data 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

Checkout'sessionLineItems'

Fields

• checkout'sessionLineItems'Data :: [Item]

  data: Details about each object.

• checkout'sessionLineItems'HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• checkout'sessionLineItems'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq Checkout'sessionLineItems'

Defined in StripeAPI.Types.Checkout_Session

Methods

(==) :: Checkout'sessionLineItems' -> Checkout'sessionLineItems' -> Bool

(/=) :: Checkout'sessionLineItems' -> Checkout'sessionLineItems' -> Bool

Show Checkout'sessionLineItems'

Defined in StripeAPI.Types.Checkout_Session

Methods

showsPrec :: Int -> Checkout'sessionLineItems' -> ShowS

show :: Checkout'sessionLineItems' -> String

showList :: [Checkout'sessionLineItems'] -> ShowS

ToJSON Checkout'sessionLineItems'

Defined in StripeAPI.Types.Checkout_Session

Methods

toJSON :: Checkout'sessionLineItems' -> Value

toEncoding :: Checkout'sessionLineItems' -> Encoding

toJSONList :: [Checkout'sessionLineItems'] -> Value

toEncodingList :: [Checkout'sessionLineItems'] -> Encoding

FromJSON Checkout'sessionLineItems'

Defined in StripeAPI.Types.Checkout_Session

Methods

parseJSON :: Value -> Parser Checkout'sessionLineItems'

parseJSONList :: Value -> Parser [Checkout'sessionLineItems']

mkCheckout'sessionLineItems'

Arguments

:: [Item]

checkout'sessionLineItems'Data

-> Bool

checkout'sessionLineItems'HasMore

-> Text

checkout'sessionLineItems'Url

-> Checkout'sessionLineItems'

Create a new Checkout'sessionLineItems' with all required fields.

data Checkout'sessionLocale'

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

Checkout'sessionLocale'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

Checkout'sessionLocale'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

Checkout'sessionLocale'EnumAuto

Represents the JSON value "auto"

Checkout'sessionLocale'EnumBg

Represents the JSON value "bg"

Checkout'sessionLocale'EnumCs

Represents the JSON value "cs"

Checkout'sessionLocale'EnumDa

Represents the JSON value "da"

Checkout'sessionLocale'EnumDe

Represents the JSON value "de"

Checkout'sessionLocale'EnumEl

Represents the JSON value "el"

Checkout'sessionLocale'EnumEn

Represents the JSON value "en"

Checkout'sessionLocale'EnumEnGB

Represents the JSON value "en-GB"

Checkout'sessionLocale'EnumEs

Represents the JSON value "es"

Checkout'sessionLocale'EnumEs_419

Represents the JSON value "es-419"

Checkout'sessionLocale'EnumEt

Represents the JSON value "et"

Checkout'sessionLocale'EnumFi

Represents the JSON value "fi"

Checkout'sessionLocale'EnumFr

Represents the JSON value "fr"

Checkout'sessionLocale'EnumFrCA

Represents the JSON value "fr-CA"

Checkout'sessionLocale'EnumHu

Represents the JSON value "hu"

Checkout'sessionLocale'EnumId

Represents the JSON value "id"

Checkout'sessionLocale'EnumIt

Represents the JSON value "it"

Checkout'sessionLocale'EnumJa

Represents the JSON value "ja"

Checkout'sessionLocale'EnumLt

Represents the JSON value "lt"

Checkout'sessionLocale'EnumLv

Represents the JSON value "lv"

Checkout'sessionLocale'EnumMs

Represents the JSON value "ms"

Checkout'sessionLocale'EnumMt

Represents the JSON value "mt"

Checkout'sessionLocale'EnumNb

Represents the JSON value "nb"

Checkout'sessionLocale'EnumNl

Represents the JSON value "nl"

Checkout'sessionLocale'EnumPl

Represents the JSON value "pl"

Checkout'sessionLocale'EnumPt

Represents the JSON value "pt"

Checkout'sessionLocale'EnumPtBR

Represents the JSON value "pt-BR"

Checkout'sessionLocale'EnumRo

Represents the JSON value "ro"

Checkout'sessionLocale'EnumRu

Represents the JSON value "ru"

Checkout'sessionLocale'EnumSk

Represents the JSON value "sk"

Checkout'sessionLocale'EnumSl

Represents the JSON value "sl"

Checkout'sessionLocale'EnumSv

Represents the JSON value "sv"

Checkout'sessionLocale'EnumTh

Represents the JSON value "th"

Checkout'sessionLocale'EnumTr

Represents the JSON value "tr"

Checkout'sessionLocale'EnumZh

Represents the JSON value "zh"

Checkout'sessionLocale'EnumZhHK

Represents the JSON value "zh-HK"

Checkout'sessionLocale'EnumZhTW

Represents the JSON value "zh-TW"

Instances

Eq Checkout'sessionLocale'

Defined in StripeAPI.Types.Checkout_Session

Methods

(==) :: Checkout'sessionLocale' -> Checkout'sessionLocale' -> Bool

(/=) :: Checkout'sessionLocale' -> Checkout'sessionLocale' -> Bool

Show Checkout'sessionLocale'

Defined in StripeAPI.Types.Checkout_Session

Methods

showsPrec :: Int -> Checkout'sessionLocale' -> ShowS

show :: Checkout'sessionLocale' -> String

showList :: [Checkout'sessionLocale'] -> ShowS

ToJSON Checkout'sessionLocale'

Defined in StripeAPI.Types.Checkout_Session

Methods

toJSON :: Checkout'sessionLocale' -> Value

toEncoding :: Checkout'sessionLocale' -> Encoding

toJSONList :: [Checkout'sessionLocale'] -> Value

toEncodingList :: [Checkout'sessionLocale'] -> Encoding

FromJSON Checkout'sessionLocale'

Defined in StripeAPI.Types.Checkout_Session

Methods

parseJSON :: Value -> Parser Checkout'sessionLocale'

parseJSONList :: Value -> Parser [Checkout'sessionLocale']

data Checkout'sessionMode'

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

The mode of the Checkout Session.

Constructors

Checkout'sessionMode'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

Checkout'sessionMode'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

Checkout'sessionMode'EnumPayment

Represents the JSON value "payment"

Checkout'sessionMode'EnumSetup

Represents the JSON value "setup"

Checkout'sessionMode'EnumSubscription

Represents the JSON value "subscription"

Instances

Eq Checkout'sessionMode'

Defined in StripeAPI.Types.Checkout_Session

Methods

(==) :: Checkout'sessionMode' -> Checkout'sessionMode' -> Bool

(/=) :: Checkout'sessionMode' -> Checkout'sessionMode' -> Bool

Show Checkout'sessionMode'

Defined in StripeAPI.Types.Checkout_Session

Methods

showsPrec :: Int -> Checkout'sessionMode' -> ShowS

show :: Checkout'sessionMode' -> String

showList :: [Checkout'sessionMode'] -> ShowS

ToJSON Checkout'sessionMode'

Defined in StripeAPI.Types.Checkout_Session

Methods

toJSON :: Checkout'sessionMode' -> Value

toEncoding :: Checkout'sessionMode' -> Encoding

toJSONList :: [Checkout'sessionMode'] -> Value

toEncodingList :: [Checkout'sessionMode'] -> Encoding

FromJSON Checkout'sessionMode'

Defined in StripeAPI.Types.Checkout_Session

Methods

parseJSON :: Value -> Parser Checkout'sessionMode'

parseJSONList :: Value -> Parser [Checkout'sessionMode']

data Checkout'sessionPaymentIntent'Variants

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

Checkout'sessionPaymentIntent'Text Text

Checkout'sessionPaymentIntent'PaymentIntent PaymentIntent

Instances

Eq Checkout'sessionPaymentIntent'Variants

Defined in StripeAPI.Types.Checkout_Session

Methods

(==) :: Checkout'sessionPaymentIntent'Variants -> Checkout'sessionPaymentIntent'Variants -> Bool

(/=) :: Checkout'sessionPaymentIntent'Variants -> Checkout'sessionPaymentIntent'Variants -> Bool

Show Checkout'sessionPaymentIntent'Variants

Defined in StripeAPI.Types.Checkout_Session

Methods

showsPrec :: Int -> Checkout'sessionPaymentIntent'Variants -> ShowS

show :: Checkout'sessionPaymentIntent'Variants -> String

showList :: [Checkout'sessionPaymentIntent'Variants] -> ShowS

ToJSON Checkout'sessionPaymentIntent'Variants

Defined in StripeAPI.Types.Checkout_Session

Methods

toJSON :: Checkout'sessionPaymentIntent'Variants -> Value

toEncoding :: Checkout'sessionPaymentIntent'Variants -> Encoding

toJSONList :: [Checkout'sessionPaymentIntent'Variants] -> Value

toEncodingList :: [Checkout'sessionPaymentIntent'Variants] -> Encoding

FromJSON Checkout'sessionPaymentIntent'Variants

Defined in StripeAPI.Types.Checkout_Session

Methods

parseJSON :: Value -> Parser Checkout'sessionPaymentIntent'Variants

parseJSONList :: Value -> Parser [Checkout'sessionPaymentIntent'Variants]

data Checkout'sessionPaymentMethodOptions'

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

Checkout'sessionPaymentMethodOptions'

Fields

• checkout'sessionPaymentMethodOptions'AcssDebit :: Maybe CheckoutAcssDebitPaymentMethodOptions

  acss_debit:

Instances

Eq Checkout'sessionPaymentMethodOptions'

Defined in StripeAPI.Types.Checkout_Session

Methods

(==) :: Checkout'sessionPaymentMethodOptions' -> Checkout'sessionPaymentMethodOptions' -> Bool

(/=) :: Checkout'sessionPaymentMethodOptions' -> Checkout'sessionPaymentMethodOptions' -> Bool

Show Checkout'sessionPaymentMethodOptions'

Defined in StripeAPI.Types.Checkout_Session

Methods

showsPrec :: Int -> Checkout'sessionPaymentMethodOptions' -> ShowS

show :: Checkout'sessionPaymentMethodOptions' -> String

showList :: [Checkout'sessionPaymentMethodOptions'] -> ShowS

ToJSON Checkout'sessionPaymentMethodOptions'

Defined in StripeAPI.Types.Checkout_Session

Methods

toJSON :: Checkout'sessionPaymentMethodOptions' -> Value

toEncoding :: Checkout'sessionPaymentMethodOptions' -> Encoding

toJSONList :: [Checkout'sessionPaymentMethodOptions'] -> Value

toEncodingList :: [Checkout'sessionPaymentMethodOptions'] -> Encoding

FromJSON Checkout'sessionPaymentMethodOptions'

Defined in StripeAPI.Types.Checkout_Session

Methods

parseJSON :: Value -> Parser Checkout'sessionPaymentMethodOptions'

parseJSONList :: Value -> Parser [Checkout'sessionPaymentMethodOptions']

mkCheckout'sessionPaymentMethodOptions' :: Checkout'sessionPaymentMethodOptions'

Create a new Checkout'sessionPaymentMethodOptions' with all required fields.

data 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

Checkout'sessionPaymentStatus'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

Checkout'sessionPaymentStatus'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

Checkout'sessionPaymentStatus'EnumNoPaymentRequired

Represents the JSON value "no_payment_required"

Checkout'sessionPaymentStatus'EnumPaid

Represents the JSON value "paid"

Checkout'sessionPaymentStatus'EnumUnpaid

Represents the JSON value "unpaid"

Instances

Eq Checkout'sessionPaymentStatus'

Defined in StripeAPI.Types.Checkout_Session

Methods

(==) :: Checkout'sessionPaymentStatus' -> Checkout'sessionPaymentStatus' -> Bool

(/=) :: Checkout'sessionPaymentStatus' -> Checkout'sessionPaymentStatus' -> Bool

Show Checkout'sessionPaymentStatus'

Defined in StripeAPI.Types.Checkout_Session

Methods

showsPrec :: Int -> Checkout'sessionPaymentStatus' -> ShowS

show :: Checkout'sessionPaymentStatus' -> String

showList :: [Checkout'sessionPaymentStatus'] -> ShowS

ToJSON Checkout'sessionPaymentStatus'

Defined in StripeAPI.Types.Checkout_Session

Methods

toJSON :: Checkout'sessionPaymentStatus' -> Value

toEncoding :: Checkout'sessionPaymentStatus' -> Encoding

toJSONList :: [Checkout'sessionPaymentStatus'] -> Value

toEncodingList :: [Checkout'sessionPaymentStatus'] -> Encoding

FromJSON Checkout'sessionPaymentStatus'

Defined in StripeAPI.Types.Checkout_Session

Methods

parseJSON :: Value -> Parser Checkout'sessionPaymentStatus'

parseJSONList :: Value -> Parser [Checkout'sessionPaymentStatus']

data Checkout'sessionSetupIntent'Variants

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

Checkout'sessionSetupIntent'Text Text

Checkout'sessionSetupIntent'SetupIntent SetupIntent

Instances

Eq Checkout'sessionSetupIntent'Variants

Defined in StripeAPI.Types.Checkout_Session

Methods

(==) :: Checkout'sessionSetupIntent'Variants -> Checkout'sessionSetupIntent'Variants -> Bool

(/=) :: Checkout'sessionSetupIntent'Variants -> Checkout'sessionSetupIntent'Variants -> Bool

Show Checkout'sessionSetupIntent'Variants

Defined in StripeAPI.Types.Checkout_Session

Methods

showsPrec :: Int -> Checkout'sessionSetupIntent'Variants -> ShowS

show :: Checkout'sessionSetupIntent'Variants -> String

showList :: [Checkout'sessionSetupIntent'Variants] -> ShowS

ToJSON Checkout'sessionSetupIntent'Variants

Defined in StripeAPI.Types.Checkout_Session

Methods

toJSON :: Checkout'sessionSetupIntent'Variants -> Value

toEncoding :: Checkout'sessionSetupIntent'Variants -> Encoding

toJSONList :: [Checkout'sessionSetupIntent'Variants] -> Value

toEncodingList :: [Checkout'sessionSetupIntent'Variants] -> Encoding

FromJSON Checkout'sessionSetupIntent'Variants

Defined in StripeAPI.Types.Checkout_Session

Methods

parseJSON :: Value -> Parser Checkout'sessionSetupIntent'Variants

parseJSONList :: Value -> Parser [Checkout'sessionSetupIntent'Variants]

data Checkout'sessionShipping'

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

Shipping information for this Checkout Session.

Constructors

Checkout'sessionShipping'

Fields

• checkout'sessionShipping'Address :: Maybe Address

  address:

• checkout'sessionShipping'Carrier :: Maybe Text

  carrier: The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.

  Constraints:

  • Maximum length of 5000
• checkout'sessionShipping'Name :: Maybe Text

  name: Recipient name.

  Constraints:

  • Maximum length of 5000
• checkout'sessionShipping'Phone :: Maybe Text

  phone: Recipient phone (including extension).

  Constraints:

  • Maximum length of 5000
• checkout'sessionShipping'TrackingNumber :: Maybe Text

  tracking_number: The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

  Constraints:

  • Maximum length of 5000

Instances

Eq Checkout'sessionShipping'

Defined in StripeAPI.Types.Checkout_Session

Methods

(==) :: Checkout'sessionShipping' -> Checkout'sessionShipping' -> Bool

(/=) :: Checkout'sessionShipping' -> Checkout'sessionShipping' -> Bool

Show Checkout'sessionShipping'

Defined in StripeAPI.Types.Checkout_Session

Methods

showsPrec :: Int -> Checkout'sessionShipping' -> ShowS

show :: Checkout'sessionShipping' -> String

showList :: [Checkout'sessionShipping'] -> ShowS

ToJSON Checkout'sessionShipping'

Defined in StripeAPI.Types.Checkout_Session

Methods

toJSON :: Checkout'sessionShipping' -> Value

toEncoding :: Checkout'sessionShipping' -> Encoding

toJSONList :: [Checkout'sessionShipping'] -> Value

toEncodingList :: [Checkout'sessionShipping'] -> Encoding

FromJSON Checkout'sessionShipping'

Defined in StripeAPI.Types.Checkout_Session

Methods

parseJSON :: Value -> Parser Checkout'sessionShipping'

parseJSONList :: Value -> Parser [Checkout'sessionShipping']

mkCheckout'sessionShipping' :: Checkout'sessionShipping'

Create a new Checkout'sessionShipping' with all required fields.

data Checkout'sessionShippingAddressCollection'

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

Checkout'sessionShippingAddressCollection'

Fields

• checkout'sessionShippingAddressCollection'AllowedCountries :: Maybe [Checkout'sessionShippingAddressCollection'AllowedCountries']

  allowed_countries: An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.

Instances

Eq Checkout'sessionShippingAddressCollection'

Defined in StripeAPI.Types.Checkout_Session

Methods

(==) :: Checkout'sessionShippingAddressCollection' -> Checkout'sessionShippingAddressCollection' -> Bool

(/=) :: Checkout'sessionShippingAddressCollection' -> Checkout'sessionShippingAddressCollection' -> Bool

Show Checkout'sessionShippingAddressCollection'

Defined in StripeAPI.Types.Checkout_Session

Methods

showsPrec :: Int -> Checkout'sessionShippingAddressCollection' -> ShowS

show :: Checkout'sessionShippingAddressCollection' -> String

showList :: [Checkout'sessionShippingAddressCollection'] -> ShowS

ToJSON Checkout'sessionShippingAddressCollection'

Defined in StripeAPI.Types.Checkout_Session

Methods

toJSON :: Checkout'sessionShippingAddressCollection' -> Value

toEncoding :: Checkout'sessionShippingAddressCollection' -> Encoding

toJSONList :: [Checkout'sessionShippingAddressCollection'] -> Value

toEncodingList :: [Checkout'sessionShippingAddressCollection'] -> Encoding

FromJSON Checkout'sessionShippingAddressCollection'

Defined in StripeAPI.Types.Checkout_Session

Methods

parseJSON :: Value -> Parser Checkout'sessionShippingAddressCollection'

parseJSONList :: Value -> Parser [Checkout'sessionShippingAddressCollection']

mkCheckout'sessionShippingAddressCollection' :: Checkout'sessionShippingAddressCollection'

Create a new Checkout'sessionShippingAddressCollection' with all required fields.

data Checkout'sessionShippingAddressCollection'AllowedCountries'

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

Constructors

Checkout'sessionShippingAddressCollection'AllowedCountries'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

Checkout'sessionShippingAddressCollection'AllowedCountries'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumAC

Represents the JSON value AC

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumAD

Represents the JSON value AD

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumAE

Represents the JSON value AE

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumAF

Represents the JSON value AF

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumAG

Represents the JSON value AG

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumAI

Represents the JSON value AI

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumAL

Represents the JSON value AL

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumAM

Represents the JSON value AM

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumAO

Represents the JSON value AO

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumAQ

Represents the JSON value AQ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumAR

Represents the JSON value AR

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumAT

Represents the JSON value AT

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumAU

Represents the JSON value AU

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumAW

Represents the JSON value AW

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumAX

Represents the JSON value AX

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumAZ

Represents the JSON value AZ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBA

Represents the JSON value BA

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBB

Represents the JSON value BB

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBD

Represents the JSON value BD

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBE

Represents the JSON value BE

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBF

Represents the JSON value BF

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBG

Represents the JSON value BG

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBH

Represents the JSON value BH

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBI

Represents the JSON value BI

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBJ

Represents the JSON value BJ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBL

Represents the JSON value BL

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBM

Represents the JSON value BM

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBN

Represents the JSON value BN

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBO

Represents the JSON value BO

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBQ

Represents the JSON value BQ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBR

Represents the JSON value BR

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBS

Represents the JSON value BS

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBT

Represents the JSON value BT

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBV

Represents the JSON value BV

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBW

Represents the JSON value BW

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBY

Represents the JSON value BY

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumBZ

Represents the JSON value BZ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumCA

Represents the JSON value CA

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumCD

Represents the JSON value CD

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumCF

Represents the JSON value CF

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumCG

Represents the JSON value CG

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumCH

Represents the JSON value CH

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumCI

Represents the JSON value CI

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumCK

Represents the JSON value CK

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumCL

Represents the JSON value CL

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumCM

Represents the JSON value CM

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumCN

Represents the JSON value CN

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumCO

Represents the JSON value CO

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumCR

Represents the JSON value CR

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumCV

Represents the JSON value CV

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumCW

Represents the JSON value CW

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumCY

Represents the JSON value CY

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumCZ

Represents the JSON value CZ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumDE

Represents the JSON value DE

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumDJ

Represents the JSON value DJ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumDK

Represents the JSON value DK

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumDM

Represents the JSON value DM

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumDO

Represents the JSON value DO

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumDZ

Represents the JSON value DZ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumEC

Represents the JSON value EC

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumEE

Represents the JSON value EE

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumEG

Represents the JSON value EG

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumEH

Represents the JSON value EH

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumER

Represents the JSON value ER

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumES

Represents the JSON value ES

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumET

Represents the JSON value ET

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumFI

Represents the JSON value FI

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumFJ

Represents the JSON value FJ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumFK

Represents the JSON value FK

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumFO

Represents the JSON value FO

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumFR

Represents the JSON value FR

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGA

Represents the JSON value GA

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGB

Represents the JSON value GB

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGD

Represents the JSON value GD

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGE

Represents the JSON value GE

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGF

Represents the JSON value GF

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGG

Represents the JSON value GG

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGH

Represents the JSON value GH

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGI

Represents the JSON value GI

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGL

Represents the JSON value GL

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGM

Represents the JSON value GM

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGN

Represents the JSON value GN

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGP

Represents the JSON value GP

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGQ

Represents the JSON value GQ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGR

Represents the JSON value GR

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGS

Represents the JSON value GS

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGT

Represents the JSON value GT

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGU

Represents the JSON value GU

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGW

Represents the JSON value GW

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumGY

Represents the JSON value GY

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumHK

Represents the JSON value HK

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumHN

Represents the JSON value HN

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumHR

Represents the JSON value HR

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumHT

Represents the JSON value HT

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumHU

Represents the JSON value HU

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumID

Represents the JSON value ID

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumIE

Represents the JSON value IE

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumIL

Represents the JSON value IL

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumIM

Represents the JSON value IM

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumIN

Represents the JSON value IN

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumIO

Represents the JSON value IO

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumIQ

Represents the JSON value IQ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumIS

Represents the JSON value IS

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumIT

Represents the JSON value IT

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumJE

Represents the JSON value JE

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumJM

Represents the JSON value JM

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumJO

Represents the JSON value JO

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumJP

Represents the JSON value JP

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumKE

Represents the JSON value KE

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumKG

Represents the JSON value KG

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumKH

Represents the JSON value KH

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumKI

Represents the JSON value KI

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumKM

Represents the JSON value KM

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumKN

Represents the JSON value KN

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumKR

Represents the JSON value KR

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumKW

Represents the JSON value KW

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumKY

Represents the JSON value KY

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumKZ

Represents the JSON value KZ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumLA

Represents the JSON value LA

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumLB

Represents the JSON value LB

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumLC

Represents the JSON value LC

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumLI

Represents the JSON value LI

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumLK

Represents the JSON value LK

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumLR

Represents the JSON value LR

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumLS

Represents the JSON value LS

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumLT

Represents the JSON value LT

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumLU

Represents the JSON value LU

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumLV

Represents the JSON value LV

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumLY

Represents the JSON value LY

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMA

Represents the JSON value MA

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMC

Represents the JSON value MC

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMD

Represents the JSON value MD

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumME

Represents the JSON value ME

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMF

Represents the JSON value MF

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMG

Represents the JSON value MG

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMK

Represents the JSON value MK

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumML

Represents the JSON value ML

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMM

Represents the JSON value MM

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMN

Represents the JSON value MN

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMO

Represents the JSON value MO

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMQ

Represents the JSON value MQ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMR

Represents the JSON value MR

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMS

Represents the JSON value MS

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMT

Represents the JSON value MT

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMU

Represents the JSON value MU

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMV

Represents the JSON value MV

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMW

Represents the JSON value MW

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMX

Represents the JSON value MX

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMY

Represents the JSON value MY

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumMZ

Represents the JSON value MZ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumNA

Represents the JSON value NA

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumNC

Represents the JSON value NC

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumNE

Represents the JSON value NE

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumNG

Represents the JSON value NG

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumNI

Represents the JSON value NI

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumNL

Represents the JSON value NL

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumNO

Represents the JSON value NO

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumNP

Represents the JSON value NP

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumNR

Represents the JSON value NR

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumNU

Represents the JSON value NU

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumNZ

Represents the JSON value NZ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumOM

Represents the JSON value OM

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumPA

Represents the JSON value PA

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumPE

Represents the JSON value PE

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumPF

Represents the JSON value PF

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumPG

Represents the JSON value PG

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumPH

Represents the JSON value PH

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumPK

Represents the JSON value PK

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumPL

Represents the JSON value PL

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumPM

Represents the JSON value PM

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumPN

Represents the JSON value PN

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumPR

Represents the JSON value PR

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumPS

Represents the JSON value PS

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumPT

Represents the JSON value PT

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumPY

Represents the JSON value PY

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumQA

Represents the JSON value QA

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumRE

Represents the JSON value RE

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumRO

Represents the JSON value RO

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumRS

Represents the JSON value RS

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumRU

Represents the JSON value RU

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumRW

Represents the JSON value RW

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumSA

Represents the JSON value SA

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumSB

Represents the JSON value SB

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumSC

Represents the JSON value SC

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumSE

Represents the JSON value SE

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumSG

Represents the JSON value SG

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumSH

Represents the JSON value SH

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumSI

Represents the JSON value SI

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumSJ

Represents the JSON value SJ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumSK

Represents the JSON value SK

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumSL

Represents the JSON value SL

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumSM

Represents the JSON value SM

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumSN

Represents the JSON value SN

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumSO

Represents the JSON value SO

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumSR

Represents the JSON value SR

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumSS

Represents the JSON value SS

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumST

Represents the JSON value ST

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumSV

Represents the JSON value SV

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumSX

Represents the JSON value SX

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumSZ

Represents the JSON value SZ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumTA

Represents the JSON value TA

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumTC

Represents the JSON value TC

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumTD

Represents the JSON value TD

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumTF

Represents the JSON value TF

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumTG

Represents the JSON value TG

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumTH

Represents the JSON value TH

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumTJ

Represents the JSON value TJ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumTK

Represents the JSON value TK

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumTL

Represents the JSON value TL

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumTM

Represents the JSON value TM

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumTN

Represents the JSON value TN

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumTO

Represents the JSON value TO

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumTR

Represents the JSON value TR

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumTT

Represents the JSON value TT

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumTV

Represents the JSON value TV

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumTW

Represents the JSON value TW

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumTZ

Represents the JSON value TZ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumUA

Represents the JSON value UA

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumUG

Represents the JSON value UG

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumUS

Represents the JSON value US

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumUY

Represents the JSON value UY

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumUZ

Represents the JSON value UZ

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumVA

Represents the JSON value VA

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumVC

Represents the JSON value VC

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumVE

Represents the JSON value VE

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumVG

Represents the JSON value VG

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumVN

Represents the JSON value VN

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumVU

Represents the JSON value VU

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumWF

Represents the JSON value WF

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumWS

Represents the JSON value WS

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumXK

Represents the JSON value XK

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumYE

Represents the JSON value YE

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumYT

Represents the JSON value YT

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumZA

Represents the JSON value ZA

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumZM

Represents the JSON value ZM

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumZW

Represents the JSON value ZW

Checkout'sessionShippingAddressCollection'AllowedCountries'EnumZZ

Represents the JSON value ZZ

Instances

Eq Checkout'sessionShippingAddressCollection'AllowedCountries'

Defined in StripeAPI.Types.Checkout_Session

Methods

(==) :: Checkout'sessionShippingAddressCollection'AllowedCountries' -> Checkout'sessionShippingAddressCollection'AllowedCountries' -> Bool

(/=) :: Checkout'sessionShippingAddressCollection'AllowedCountries' -> Checkout'sessionShippingAddressCollection'AllowedCountries' -> Bool

Show Checkout'sessionShippingAddressCollection'AllowedCountries'

Defined in StripeAPI.Types.Checkout_Session

Methods

showsPrec :: Int -> Checkout'sessionShippingAddressCollection'AllowedCountries' -> ShowS

show :: Checkout'sessionShippingAddressCollection'AllowedCountries' -> String

showList :: [Checkout'sessionShippingAddressCollection'AllowedCountries'] -> ShowS

ToJSON Checkout'sessionShippingAddressCollection'AllowedCountries'

Defined in StripeAPI.Types.Checkout_Session

Methods

toJSON :: Checkout'sessionShippingAddressCollection'AllowedCountries' -> Value

toEncoding :: Checkout'sessionShippingAddressCollection'AllowedCountries' -> Encoding

toJSONList :: [Checkout'sessionShippingAddressCollection'AllowedCountries'] -> Value

toEncodingList :: [Checkout'sessionShippingAddressCollection'AllowedCountries'] -> Encoding

FromJSON Checkout'sessionShippingAddressCollection'AllowedCountries'

Defined in StripeAPI.Types.Checkout_Session

Methods

parseJSON :: Value -> Parser Checkout'sessionShippingAddressCollection'AllowedCountries'

parseJSONList :: Value -> Parser [Checkout'sessionShippingAddressCollection'AllowedCountries']

data Checkout'sessionSubmitType'

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

Checkout'sessionSubmitType'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

Checkout'sessionSubmitType'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

Checkout'sessionSubmitType'EnumAuto

Represents the JSON value "auto"

Checkout'sessionSubmitType'EnumBook

Represents the JSON value "book"

Checkout'sessionSubmitType'EnumDonate

Represents the JSON value "donate"

Checkout'sessionSubmitType'EnumPay

Represents the JSON value "pay"

Instances

Eq Checkout'sessionSubmitType'

Defined in StripeAPI.Types.Checkout_Session

Methods

(==) :: Checkout'sessionSubmitType' -> Checkout'sessionSubmitType' -> Bool

(/=) :: Checkout'sessionSubmitType' -> Checkout'sessionSubmitType' -> Bool

Show Checkout'sessionSubmitType'

Defined in StripeAPI.Types.Checkout_Session

Methods

showsPrec :: Int -> Checkout'sessionSubmitType' -> ShowS

show :: Checkout'sessionSubmitType' -> String

showList :: [Checkout'sessionSubmitType'] -> ShowS

ToJSON Checkout'sessionSubmitType'

Defined in StripeAPI.Types.Checkout_Session

Methods

toJSON :: Checkout'sessionSubmitType' -> Value

toEncoding :: Checkout'sessionSubmitType' -> Encoding

toJSONList :: [Checkout'sessionSubmitType'] -> Value

toEncodingList :: [Checkout'sessionSubmitType'] -> Encoding

FromJSON Checkout'sessionSubmitType'

Defined in StripeAPI.Types.Checkout_Session

Methods

parseJSON :: Value -> Parser Checkout'sessionSubmitType'

parseJSONList :: Value -> Parser [Checkout'sessionSubmitType']

data Checkout'sessionSubscription'Variants

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

Checkout'sessionSubscription'Text Text

Checkout'sessionSubscription'Subscription Subscription

Instances

Eq Checkout'sessionSubscription'Variants

Defined in StripeAPI.Types.Checkout_Session

Methods

(==) :: Checkout'sessionSubscription'Variants -> Checkout'sessionSubscription'Variants -> Bool

(/=) :: Checkout'sessionSubscription'Variants -> Checkout'sessionSubscription'Variants -> Bool

Show Checkout'sessionSubscription'Variants

Defined in StripeAPI.Types.Checkout_Session

Methods

showsPrec :: Int -> Checkout'sessionSubscription'Variants -> ShowS

show :: Checkout'sessionSubscription'Variants -> String

showList :: [Checkout'sessionSubscription'Variants] -> ShowS

ToJSON Checkout'sessionSubscription'Variants

Defined in StripeAPI.Types.Checkout_Session

Methods

toJSON :: Checkout'sessionSubscription'Variants -> Value

toEncoding :: Checkout'sessionSubscription'Variants -> Encoding

toJSONList :: [Checkout'sessionSubscription'Variants] -> Value

toEncodingList :: [Checkout'sessionSubscription'Variants] -> Encoding

FromJSON Checkout'sessionSubscription'Variants

Defined in StripeAPI.Types.Checkout_Session

Methods

parseJSON :: Value -> Parser Checkout'sessionSubscription'Variants

parseJSONList :: Value -> Parser [Checkout'sessionSubscription'Variants]

data Checkout'sessionTotalDetails'

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

Checkout'sessionTotalDetails'

Fields

• checkout'sessionTotalDetails'AmountDiscount :: Maybe Int

  amount_discount: This is the sum of all the line item discounts.

• checkout'sessionTotalDetails'AmountShipping :: Maybe Int

  amount_shipping: This is the sum of all the line item shipping amounts.

• checkout'sessionTotalDetails'AmountTax :: Maybe Int

  amount_tax: This is the sum of all the line item tax amounts.

• checkout'sessionTotalDetails'Breakdown :: Maybe PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown

  breakdown:

Instances

Eq Checkout'sessionTotalDetails'

Defined in StripeAPI.Types.Checkout_Session

Methods

(==) :: Checkout'sessionTotalDetails' -> Checkout'sessionTotalDetails' -> Bool

(/=) :: Checkout'sessionTotalDetails' -> Checkout'sessionTotalDetails' -> Bool

Show Checkout'sessionTotalDetails'

Defined in StripeAPI.Types.Checkout_Session

Methods

showsPrec :: Int -> Checkout'sessionTotalDetails' -> ShowS

show :: Checkout'sessionTotalDetails' -> String

showList :: [Checkout'sessionTotalDetails'] -> ShowS

ToJSON Checkout'sessionTotalDetails'

Defined in StripeAPI.Types.Checkout_Session

Methods

toJSON :: Checkout'sessionTotalDetails' -> Value

toEncoding :: Checkout'sessionTotalDetails' -> Encoding

toJSONList :: [Checkout'sessionTotalDetails'] -> Value

toEncodingList :: [Checkout'sessionTotalDetails'] -> Encoding

FromJSON Checkout'sessionTotalDetails'

Defined in StripeAPI.Types.Checkout_Session

Methods

parseJSON :: Value -> Parser Checkout'sessionTotalDetails'

parseJSONList :: Value -> Parser [Checkout'sessionTotalDetails']

mkCheckout'sessionTotalDetails' :: Checkout'sessionTotalDetails'

Create a new Checkout'sessionTotalDetails' with all required fields.