listCheckoutSessions

List checkout sessions

​

Lists checkout sessions, newest first: each customer's attempt to buy on a checkout. Filter by checkout, status or client reference. Answers 400 for an unknown status.

Query Parameters

  • checkoutId
    Type: string

    Only sessions on this checkout.

  • status
    Type: enum

    Only sessions in this status.

    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
  • clientReferenceId
    Type: string

    Only sessions with this client reference.

  • limit
    Type: integer
    min:  
    1
    max:  
    100

    How many records to return, 1 to 100.

  • offset
    Type: integer
    min:  
    0

    How many records to skip.

Responses

  • application/json
  • application/json
Request Example for get/checkout-sessions
curl 'https://billing.getspondo.com/api/v1/checkout-sessions?checkoutId=chk_9Xq2Lm7Rt4Vw1Bn8' \
  --header "Authorization: Bearer $SPONDO_API_KEY"


{
  "data": [
    {
      "id": "cs_3Hq7Zt1Xv5Nc9Bm2",
      "checkoutId": "chk_9Xq2Lm7Rt4Vw1Bn8",
      "status": "completed",
      "customerId": "cus_Z8rT3nW6yP0aJc5E",
      "externalCustomerId": "northwind",
      "clientReferenceId": null,
      "selectedProduct": {
        "id": "prod_7Hk2LmQ9xR4tVb1N",
        "plan": {
          "id": "plan_4Fd8sK1mW9qZ2xCv",
          "name": "Growth",
          "externalId": "growth-monthly"
        }
      },
      "orderId": "ord_5Rk1Tz8Wn3Yb6Hd0",
      "invoiceId": "inv_2Gm6Px9Qs4Vc7Kj1",
      "createdAt": "2026-11-09T14:00:00.000Z",
      "completedAt": "2026-11-09T14:06:31.000Z",
      "expiresAt": "2026-11-10T13:30:00.000Z"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 1,
    "hasMore": false
  }
}

A page of checkout sessions.

Previous
Archive a checkout
Next
Get a checkout session