API Reference
OIDC
Platform

Billing

AdminUpdated Sep 11, 2026

Billing

Backend API — secret key (Authorization: Bearer sk_…).

6 routes. Each row is one endpoint with its explanation, required scope, and whether it honours the Idempotency-Key header.

Method & path

Scope

Idem

Explanation

GET /v1/billing/plans

billing:read

List the plans the tenant defines for their app's users (end-user billing). Admin view — includes the Stripe price id.

POST /v1/billing/plans

billing:write

Create an end-user billing plan (name, slug, Stripe price, features, user/org audience). The slug becomes the pla session claim and must be unique per instance.

GET /v1/billing/plans/:id

billing:read

Read one end-user billing plan, including its Stripe price id and granted features.

PATCH /v1/billing/plans/:id

billing:write

Update an end-user billing plan's name, slug, price, interval, features, audience or active flag.

DELETE /v1/billing/plans/:id

billing:write

Delete an end-user billing plan. Existing subscriptions retain their plan_id (the FK restricts deletion of a plan still referenced).

GET /v1/billing/subscriptions

billing:read

List end-user subscriptions, optionally filtered by subject_type (user/org) and subject_id. Read-only — status is moved solely by the Stripe webhook.

Was this page helpful?
Billing