API reference / Start a hosted chargebee checkout

Start a hosted chargebee checkout

POST/billing/checkout

Creates a one-time hosted checkout URL for the org selected by Organization-Id, Connection-Id, or Entity-Id to subscribe to the given plan. PREMIUM checks out at the org's preset price; GROWTH checks out at the standard metered price. FREE is not checkout-able.

Authorization

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-07-21.

Organization-Idstring

Target organization id (Organization-Id selector).

Connection-Idstring

Target connection id; resolves to its organization.

Entity-Idstring

Platform entity id; resolves to a connection's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

Body

billingPlanPublicBillingWritePlanEnumRequired

Plan tier to check out into. FREE is not checkout-able.

Available options:GROWTHPREMIUM

Response

idstringRequired

Chargebee hosted page id.

urlstringRequired

One-time hosted checkout URL. Treat as a secret.

statestringRequired

Hosted page lifecycle state, e.g. created.

expiresAtstringRequired

When the checkout URL expires.

201

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

404

The requested resource was not found.

409

The request conflicts with existing state.

422

Validation Error