Billing
Provider-neutral Workspace subscription status and invoice references.
Read the provider-neutral Workspace subscription and invoice references
/api/v1/workspaces/{workspace_id}/billing-settingsRead a bounded cross-Workspace billing and plan overview
/api/v1/me/billing-plansReturns a signed-cursor page of plan/status facts for at most 100 active Workspace memberships. Sensitive details and mutations remain on the target Workspace Billing surface.
Query Parameters
Responses
string·const no-storePrevents storage of error responses by clients and intermediaries.
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Create a hosted checkout session for a paid Workspace plan
/api/v1/workspaces/{workspace_id}/checkout-sessionsCreates a short-lived provider-hosted Checkout URL. The browser return is navigation only; signed provider webhooks remain authoritative for subscription state and entitlements.
Path Parameters
Header Parameters
Request Body
Responses
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.
Create a hosted customer billing portal session
/api/v1/workspaces/{workspace_id}/billing-portal-sessionsCreates a short-lived provider-hosted portal URL for a Workspace that already has a provider customer reference.
Path Parameters
Header Parameters
Responses
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.
Create a catalogued Knowledge credit checkout
/api/v1/workspaces/{workspace_id}/billing/knowledge-credit-top-upsRequires Workspace billing-management capability, recent authentication, and an Idempotency-Key. A verified paid provider event grants the credits; delayed-payment failure and the browser return never grant value. Production remains unavailable while provider billing is disabled.
Path Parameters
Header Parameters
Request Body
Responses
string·const no-storePrevents storage of error responses by clients and intermediaries.
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.
Start paid Workspace creation
/api/v1/workspace-checkoutsCreates or replays an expiring account-level pending checkout and returns a provider-hosted URL. No usable Workspace exists yet. Only a signature-verified provider event followed by subscription reconciliation may activate the Workspace; browser return is navigation only.
Header Parameters
Request Body
Responses
string·const no-storePrevents storage of error responses by clients and intermediaries.
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.
Read paid Workspace creation state
/api/v1/workspace-checkouts/{checkout_id}Returns only the current account's bounded checkout state. A foreign identifier is indistinguishable from an absent one.
Path Parameters
Header Parameters
stringUpcoming browser-session canonical Account read. Captures the checkout response and a signed Account replay cursor in one read-only snapshot. Apply the response before acknowledging the socket checkpoint. An ordinary read may expire a pending checkout; a canonical baseline never mutates it.
accountResponses
string·const no-storePrevents storage of error responses by clients and intermediaries.
stringSigned Account replay cursor on a successful canonical baseline.
integer <int64>Account source position captured with the canonical baseline.
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.