API Reference
OIDC
Platform

Client Billing

AdminUpdated Sep 11, 2026

Client Billing

Frontend API — publishable key (x-publishable-key) plus the user session.

4 routes. Each row is one endpoint with its explanation and whether it honours the Idempotency-Key header.

Method & path

Idem

Explanation

GET /v1/client/billing/plans

Public list of the instance's active end-user billing plans for display (no Stripe price ids or secrets).

POST /v1/client/billing/checkout

Create a Stripe Checkout Session to subscribe the signed-in user (or an org they administer) to a plan. Returns {url}; never changes subscription state.

GET /v1/client/billing/subscription

Read the signed-in user's subscription, or an org's (org_id) when the caller is a member — status plus the active plan and its features.

POST /v1/client/billing/portal

Create a Stripe Billing Portal session for the subject's customer (self, or an org the caller administers) to manage or cancel. Returns {url}.

Was this page helpful?