BillKit/DocsConsole
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·OpenAPI v1.1.0

Parameters

ParameterDescription
checkout_idstring · pathrequiredId of the Checkout session, which starts cs_.

Returns

Returns a CheckoutSessionResponse object.

Errors

StatusCause
400The request was refused (type: invalid_request_error): a required parameter is missing (parameter_missing), one failed validation (parameter_invalid) or is not one the operation takes (parameter_unknown), and param names it.
401No credential, or one that does not authenticate.
402The account is suspended (tenant_suspended), or the payment provider refused a charge or refund the call made (type: payment_error, code: payment_refused).
403Authenticated, but not allowed: missing scope (insufficient_scope), a key of the wrong mode (mode_mismatch), or a refused origin. Needs the checkout_sessions:read scope.
404No such object in this account and mode.
429Rate limited. Retry-After says when to try again.
500Something failed on BillKit's side (type: api_error). Retry with the same Idempotency-Key.
503Temporarily unable to serve. reason says whether the request was attempted.
Request · curl
curl -X GET https://api.billkit.eu/v1/checkout/sessions/cs_9XKp2vQ1 \
  -H "Authorization: Bearer $BILLKIT_API_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": "obj_9XKp2vQ1",
  "livemode": false,
  "metadata": {},
  "object": "checkout.session",
  "payment_id": "pay_9XKp2vQ1",
  "payment_method": "creditcard",
  "price_id": "price_9XKp2vQ1",
  "status": "open",
  "subscription_id": "sub_9XKp2vQ1",
  "success_url": "https://acme.example/welcome",
  "trial_days_override": 0,
  "ui_mode": "hosted",
  "url": "https://acme.example/welcome"
}