Start a Pro subscription checkout
POST/api/v1/billing/subscription/checkout
Open a the billing provider hosted checkout for one Pro plan cell.
The organization and user public ids ride along as checkout metadata so the webhook can route the subscription back to the right tenant.
- Scope required:
billing:manage; role manager or above. - 409
subscription_already_activewhen the org already has a live the billing provider subscription — a level change goes through the customer portal, never a second checkout that would bill twice. - 501 when this environment has no product configured for that cell.
- 502/503 when the billing provider refuses or is unreachable.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 422
- 429
- 500
Successful Response
Bad request — malformed input or failed validation.
Missing, expired, or invalid credentials.
Authenticated but not authorized for this resource. Note: cross-organization reads return 404, not 403.
Resource not found, or hidden for tenant-enumeration safety (the caller lacks permission to know whether the resource exists).
Conflict — the current resource state does not allow this operation (e.g. assessment already started, email already in use).
Semantic validation failure — request shape was valid but contents were not.
Too many requests — rate limited. Retry after the window resets.
Internal server error — unexpected failure.