Skip to main content
GET
/
checkouts
/
{checkout_id}
Get Checkout session
curl --request GET \
  --url https://api.zenskar.com/checkouts/{checkout_id} \
  --header 'organisation: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "id": "abc12345-e89b-12d3-a456-426614174000",
  "checkout_status": "pending",
  "plan_id": "123e4567-e89b-12d3-a456-426614174000",
  "customer_id": "987fcdeb-51a2-43d7-9876-543210fedcba",
  "start_date": "2025-01-01T00:00:00Z",
  "end_date": "2025-12-31T23:59:59Z",
  "expires_at": "2025-01-02T10:30:00Z",
  "contract": {
    "name": "Enterprise Plan",
    "phases": []
  },
  "created_at": "2025-01-01T10:30:00Z",
  "updated_at": "2025-01-01T10:30:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs2.zenskar.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
default:<your-api-key>
required
​
organisation
string
header
default:<your-organisation-id>
required

Path Parameters

​
checkout_id
string<uuid>
required

Response

Checkout session retrieved successfully

Response schema for checkout session.

Does not include the full contract data.

​
id
string<uuid>
required

Unique checkout session ID.

​
organisation_id
string<uuid>
required

Organization ID.

​
checkout_status
string
required

Current status of the checkout session.

​
plan_id
string<uuid> | null

ID of the plan being purchased.

​
contract_id
string<uuid> | null

Contract ID. For amendments/plan switches: set at creation. For new contracts: set after confirmation.

​
start_date
string<date> | null

Contract start date.

​
end_date
string<date> | null

Contract end date.

​
customer_id
string<uuid> | null

ID of the customer (for non-guest checkouts).

​
business_entity_id
string<uuid> | null

ID of the business entity.

​
guest_checkout
boolean
default:false

Whether this is a guest checkout.

​
customer_data
Customer Data · object

Customer data for guest checkouts.

​
estimates
CheckoutEstimatesResponseSchema · object

Invoice estimates (current and next invoice only).

​
expires_at
string<date-time> | null

When the checkout session expires.

​
success_url
string | null

URL to redirect after successful checkout.

​
cancel_url
string | null

URL to redirect if checkout is cancelled.

​
product_overrides
ProductOverrideResponseSchema · object[] | null

Product overrides (quantity and/or is_enabled).

​
created_at
string<date-time> | null

When the checkout was created.

​
updated_at
string<date-time> | null

When the checkout was last updated.