BillKit/Docs Console
Checkout

Get checkout session

Retrieve one checkout session, to see whether the customer completed it.

GET/v1/checkout/sessions/{checkout_id}
Operation get_checkout_session · Scope checkout_sessions:read · Spec snapshot 2026-09-13

Parameters

ParameterDescription
checkout_idstring · pathrequiredNo description in the spec.

Returns

Returns a CheckoutSessionResponse object.

Errors

Status Cause
401 Missing or invalid API key.
403 Key is missing the checkout_sessions:read scope.
404 No such object, or it belongs to the other mode.
422 Validation Error
429 Rate limited. Back off and retry.
Request · curl 
curl -X GET https://api.billkit.eu/v1/checkout/sessions/cs_9XKp2vQ1 \
  -H "Authorization: Bearer $BILLKIT_SECRET_KEY"
Response · 200 OK 
{
  "cancel_url": "https://acme.example/welcome",
  "client_secret": "string",
  "coupon_id": "coup_9XKp2vQ1",
  "created": 1789392000,
  "customer_country_code": "NL",
  "customer_email": "ada@example.com",
  "customer_id": "cus_9XKp2vQ1",
  "expires_at": 1789392000,
  "id": "cs_9XKp2vQ1",
  "livemode": false,
  "metadata": {},
  "method": "string",
  "object": "checkout_session",
  "payment_id": "pay_9XKp2vQ1",
  "price_id": "price_9XKp2vQ1",
  "status": "string",
  "subscription_id": "sub_9XKp2vQ1",
  "success_url": "https://acme.example/welcome",
  "trial_days_override": 0,
  "ui_mode": "string",
  "url": "https://acme.example/welcome"
}