Checkout

Initiate checkout sessions for subscriptions or purchases

Initiate Checkout

Start a checkout session for a new subscription or purchase

Query Parameters

Content-Type
string
x-idempotency-id
string
x-kc-token
string

Request Body

customer
string
product
string
expires_at
string
action
string
selected_currency
integer
selected_billing_cycle
string

Response

Successful checkout session initiation

data
object
POST /checkout_sessions
Response Example
{
  "data": {
    "id": "3b9a8d66-522d-461e-a92d-0995ca344a70",
    "status": "open",
    "date_created": "2025-02-28T07:41:13.738Z",
    "user_updated": null,
    "date_updated": null,
    "user_created": "a01c4d98-34e6-48b4-b31d-d543f0cc1da7",
    "customer": "a3e20b05-4b65-4b15-825f-8c42082e0ab7",
    "product": "22c220b6-9926-4a9c-baa1-95558d7a338d",
    "expires_at": "2025-02-28T07:50:45.000Z",
    "upgrade_to": null,
    "action": "new_subscription",
    "completed_at": null,
    "downgrade_to": null,
    "selected_billing_cycle": "months-1",
    "selected_currency": 1
  }
}