CheckoutSession

One customer's attempt to buy on a checkout.

checkoutId
Type: string | null
required
clientReferenceId
Type: string | null
required

Your reference for the session.
completedAt
Type: string | nullFormat: date-time
required

When the order started, once completed.
createdAt
Type: stringFormat: date-time
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
customerId
Type: string
required
expiresAt
Type: stringFormat: date-time
required

When the session can no longer be paid.
externalCustomerId
Type: string | null
required
id
Type: string
required

The session's Spondo Billing ID; what {CHECKOUT_SESSION_ID} in the success URL becomes.
invoiceId
Type: string | null
required

That order's first invoice, once completed and invoiced.
orderId
Type: string | null
required

The order the session made, once completed.
selectedProduct
Type: nullable
required

The product and plan the customer took.

Properties: 2
status
Type: enum
required

open: waiting for the customer to pay. processing: paid, with the payment being confirmed. completed: the order has started. expired: not completed by expiresAt. canceled: the checkout was archived.

values
openprocessingcompletedexpiredcanceled