Checkout Page API

A predictable REST API over HTTPS. JSON in, JSON out, conventional status codes, and a typed SDK for TypeScript.

https://api.checkoutpage.example/v1v2026-08-01

create-checkout.ts

import { CheckoutPage } from "@checkoutpage/sdk"

const cp = new CheckoutPage(process.env.CP_API_KEY)

const session = await cp.checkouts.create({
  product: "prod_9fA2",
  quantity: 1,
  customFields: [{ key: "vat_id", required: true }],
  successUrl: "https://acme.com/thanks",
})

redirect(session.url)  // https://pay.acme.com/c/cs_live_a91f

Authentication

Send your secret key as a bearer token on every request. Keys are scoped per environment — test keys never touch live money.

terminal

curl https://api.checkoutpage.example/v1/orders \
  -H "Authorization: Bearer sk_live_••••" \
  -H "Checkout-Version: 2026-08-01"

Endpoints

Every endpoint returns JSON and uses conventional HTTP status codes. IDs are prefixed by resource type, so they are safe to log.

POST/checkoutsCreate a checkout session and get a hosted URL back.

GET/checkouts/:idRetrieve a checkout session and its current status.

GET/ordersList orders, filtered by product, status or date range.

GET/orders/:idRetrieve one order with line items and custom field answers.

POST/orders/:id/refundsRefund an order in full or in part.

GET/subscriptionsList subscriptions with plan, status and next charge date.

POST/subscriptions/:id/pausePause billing without cancelling the subscription.

DELETE/subscriptions/:idCancel immediately or at the end of the period.

POST/webhooksRegister an endpoint and choose the events it receives.

GET/webhooks/:id/deliveriesInspect delivery attempts and replay any of them.

Webhook events

Deliveries are signed with HMAC-SHA256 and retried with exponential backoff for 24 hours. Handlers should be idempotent.

order.completed

A payment succeeded and the order is fulfilled.

order.refunded

A full or partial refund was issued.

checkout.abandoned

A buyer left before paying, after entering an email.

subscription.created

A new subscription started, including trials.

subscription.updated

Plan, quantity or billing date changed.

subscription.paused

Billing was paused by the customer or by you.

subscription.cancelled

The subscription ended or was cancelled.

payment.failed

A recurring charge failed and entered retry.

Errors

400	invalid_request	A parameter is missing or malformed. The response names the field.
401	unauthorised	The API key is missing, revoked or from the wrong environment.
403	forbidden	The key is valid but the plan does not include this endpoint.
404	not_found	No resource with that ID exists on this account.
409	conflict	The request collided with the current state, e.g. double refund.
429	rate_limited	Too many requests. Back off using the Retry-After header.
500	server_error	Something broke on our side. These are alerted on and investigated.

Rate limits

Read endpoints1,000 req/min

Write endpoints200 req/min

Webhook deliveries24h retry window

Burst allowance2x for 10 seconds

Build it this afternoon

Test-mode keys are available the moment you sign up. No sales call, no waiting list.

Get an API key See integrations