Checkout Session (v2)

Checkout Session snapshot for checkout_session.completed with api_version v2. Related Customer, Payment Intent, or Setup Intent objects are included when available.

  • id
    Type: string
    required

    Checkout Session ID.

  • object
    enum
    const:  
    checkout_session
    required

    Identifies the resource carried by this event.

  • status
    Type: stringenum
    required

    Checkout Session status at the time of the event.

    values
    • complete

      The Checkout Session has completed.

    • expired

      The Checkout Session has expired.

    • open

      The Checkout Session is still open.

  • payment_status
    Type: stringenum
    required

    Payment status at the time of the event. Use this value to determine whether payment has completed.

    values
    • no_payment_required

      This Checkout Session does not require payment.

    • processing

      The payment is still processing.

    • paid

      Payment has completed.

    • unpaid

      Payment has not completed.

  • amount_total
    Type: integerFormat: int64
    required

    Total Checkout amount. Expressed in the smallest currency unit.

  • currency
    Type: string
    required

    Three-letter currency code.

  • account_id
    Type: string

    Account associated with the Checkout Session.

  • livemode
    Type: boolean

    Whether the resource belongs to live mode or test mode.

  • client_reference_id
    Type: string | null

    Your reference for this Checkout Session.

  • client_customer_id
    Type: string | null

    Your reference for the customer.

  • metadata

    Metadata attached to the resource.

    Metadata attached to the resource.

    • propertyName
      additionalPropertyType: string
  • customer
    Type: Customer

    Customer details included in a Checkout Session or Payment Intent snapshot.

    Properties: 4
  • payment_intent
    Type: Payment Intent (v2)
    required

    Payment Intent snapshot for payment_intent.authorized and payment_intent.captured events with api_version v2. Related resources are included as objects when available.

    Properties: 25
  • setup_intent
    Type: Setup Intent
    required

    Setup Intent included when Checkout saves a Payment Method for future use.

    Properties: 7