Start a hosted billing checkout
Creates a one-time hosted checkout URL that subscribes the org to the given plan. Organization-Id, Connection-Id, or Entity-Id selects the org. SCALE and PREMIUM check out at the org's preset price. A SCALE checkout answers 400 while the Scale preset is closed. GROWTH checks out the legacy Starter plan at the standard metered price. STARTER checks out the current Starter plan. An org that cannot buy it yet gets the legacy Starter plan (GROWTH) instead, so its plan can read GROWTH after checkout. An org staged on the Scale preset checks out GROWTH or STARTER at its Scale price. If the org just started a checkout for the same plan and price, this returns that checkout again. Requires an owner or admin of the organization, or the organization's own API key.
Authorization
Headers
Release date, as YYYY-MM-DD. Defaults to 2026-07-21.
Target organization id (Organization-Id selector).
Target connection id; resolves to its organization.
Platform entity id; resolves to a connection's organization.
Optional source to disambiguate an Entity-Id.
Body
One of GROWTH (the legacy Starter plan), STARTER, SCALE or PREMIUM: the plan tier to check out into. STARTER checks out the legacy Starter plan for an org that cannot buy the current one yet.
GROWTHSTARTERSCALEPREMIUMResponse
Billing hosted page id.
One-time hosted checkout URL. Treat as a secret.
Hosted page lifecycle state, e.g. created.
When the checkout URL expires.
Successful Response
The request was invalid.
Authentication failed or was missing.
The credential is not permitted for this request.
The requested resource was not found.
The request conflicts with existing state.
Validation Error