Read the detailed billing record for a workspace
Returns the expanded billing detail behind the subscription summary. Requires a Clerk session and the `billing:read` workspace permission.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/workspaces/string/billing/detail"{ "data": { "invoices": [ { "id": "string", "createdAt": "string", "amountCents": 0, "currency": "string", "status": "string", "paid": true, "invoiceUrl": "string" } ], "paymentMethod": { "brand": "string", "last4": "string", "expMonth": 0, "expYear": 0 } }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Read the workspace AI usage snapshot
Returns the current AI usage snapshot for the workspace and the calling user, including the balance and whether top-up packs are available. Any workspace member with a Clerk session may call it; API keys are rejected.
Change the workspace subscription plan
Moves the existing subscription to the requested plan and billing interval in place, then returns the resulting subscription. Requires a Clerk session with a synced profile and the `billing:manage` workspace permission; the caller's pricing-experiment variant is applied so the price matches the catalog they were shown.