Checkout Session

Checkout session for processing payments

  • id
    Type: string
    required

    Unique identifier for the checkout session

  • client_secret
    Type: string | null
    max length:  
    4096

    Opaque client-side capability for continuing this custom Checkout Session through a supported Paypercut client SDK. In a JavaScript integration, pass it to paypercut.confirmPayment().

    Return it only to the untrusted client instance and customer that own the payment attempt. Do not parse it, log it, embed it in UI markup, place it in a URL or analytics, persist it in client-side storage, or expose it to another customer or payment attempt. This value is not a secret API key and does not authorize server-side API operations.

  • currency
    Type: Currency

    Three-letter ISO currency code

    Properties: 2
  • description
    Type: string | null

    A free-form reference that describes the checkout.

  • mode
    Type: stringenum
    required

    The mode of the Checkout Session.

    values
    • payment

      Standard one-time payment.

    • setup

      Set up a payment method for future use.

    • subscription

      Create a subscription checkout that collects the first payment and stores a reusable payment method for renewal billing.

  • ui_mode
    Type: "custom" or "embedded" or "hosted"enum

    The UI mode of the Session.

  • amount_total
    Type: integerFormat: int64

    Total of all items after discounts and taxes are applied.

  • amount_subtotal
    Type: integerFormat: int64

    Subtotal of all items before shipping, discounts, and taxes are applied.

  • total_details
    Type: CheckoutSessionTotalDetails
    Properties: 3
  • shipping_options
    Type: array of CheckoutSessionShippingOption

    Shipping options available for the Checkout Session.

    Properties: 1
  • shipping_cost
    Type: CheckoutShippingCostnullable
    Properties: 5
  • url
    Type: stringFormat: uri
    required

    URL where the customer can complete the payment.

  • cancel_url
    Type: string | null

    URL customers can return to if they cancel payment.

  • success_url
    Type: string | null

    URL customers are sent to when payment or setup is complete.

  • return_url
    Type: string | null

    URL customers return to after redirect-based authentication.

  • payment_method_types
    Type: array of string
    max length:  
    100

    Payment method types this Checkout Session can accept.

  • submit_type
    Type: string | nullenum

    Submit button text behavior used for Checkout Sessions in payment mode.

    values
    autobookdonatepaysubscribe
  • wallet_options
    Type: CheckoutSessionWalletOptions
    Properties: 2
  • client_reference_id
    Type: string | null

    A free-form reference from the merchant's system.

  • client_customer_id
    Type: string | null

    An identifier of the customer in the merchant's system.

  • expires_at
    Type: string | nullFormat: date-time

    Expiry time for the checkout.

  • line_items
    Type: array of LineItem

    Details about the products sold or services provided.

    Properties: 4
  • saved_payment_method_options
    Type: SavedPaymentMethodOptions
    Properties: 3
  • payment_method_options
    Type: Checkout Payment Method Optionsnullable

    Payment-method-specific options captured for this Checkout Session.

    Properties: 1
  • 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    • propertyName
      additionalPropertyType: string
  • after_completion
    Type: AfterCompletion

    After completion behavior for the Checkout Session.

    Properties: 3
  • locale
    Type: string | null

    The IETF language tag of the locale Checkout is displayed in.

  • customer

    Customer associated with the Checkout Session, if one exists.

    • Type: Customer ID
      max length:  
      100

      Customer associated with the Checkout Session, if one exists.

  • customer_email
    Type: string | null

    Email address associated with the Checkout Session.

  • customer_creation
    Type: "always" or "if_required"enum

    Customer creation behavior used during Session confirmation.

  • payment_intent

    The PaymentIntent for Checkout Sessions in payment mode. It may be returned as an ID unless expanded.

    • Type: IntentId
      max length:  
      100

      The PaymentIntent for Checkout Sessions in payment mode. It may be returned as an ID unless expanded.

  • setup_intent

    The SetupIntent for Checkout Sessions in setup mode.

    • Type: IntentId
      max length:  
      100

      The SetupIntent for Checkout Sessions in setup mode.

  • subscription

    The Subscription for Checkout Sessions in subscription mode. It may be returned as an ID unless expanded.

    • Type: string

      Subscription ID.

  • payment_link

    The Payment Link that created this Session, if applicable.

    • Type: PaymentLinkId
      max length:  
      100

      The Payment Link that created this Session, if applicable.

  • payment_status
    Type: stringenum
    required

    The payment status of the Checkout Session, one of paid, unpaid, or no_payment_required.

    values
    no_payment_requiredprocessingpaidunpaid
  • status
    Type: "complete" or "expired" or "open"enum
    required

    The status of the Checkout Session.

  • next_action
    Type: PaymentIntentNextActionnullable
    Properties: 3
  • livemode
    Type: boolean
    required

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

  • billing_address_collection
    Type: BillingAddressCollectionenum

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

    values
    • auto

      Checkout will only collect the billing address when necessary.

    • required

      Checkout will always collect the customer's billing address.