API referenceAdmin billing
Get Overview
Authorization
apiKey AuthorizationBearer <token>
Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/admin/billing"{ "data": { "plans": [ { "plan": "free", "name": "string", "tagline": "string", "bullets": [ "string" ], "selfServe": true, "sortOrder": 0, "maxWorkspaceMembers": 0, "maxDatabases": 0, "maxDataSources": 0, "features": [ "string" ], "aiBaseMicrousd": 0, "aiOverageMicrousd": 0 } ], "prices": [ { "id": "string", "plan": "free", "interval": "month", "variant": "string", "amountCents": 0, "currency": "string", "polarProductId": "string", "active": true, "updatedAt": "string" } ], "subscriptions": [ { "workspaceId": "string", "workspaceName": "string", "plan": "free", "status": "none", "cancelAtPeriodEnd": true, "currentPeriodEnd": "string", "polarProductId": "string", "updatedAt": "string" } ], "pricingExperiments": [ { "id": "string", "name": "string", "hypothesis": "string", "status": "draft", "allocation": 0, "assignmentUnit": "workspace", "audience": "string", "startedAt": "string", "winner": "string", "variants": [ { "variantId": "string", "label": "string", "split": 0, "exposures": 0, "conversions": 0 } ] } ], "metrics": { "activeSubscriptions": 0, "trialing": 0, "mrrCents": 0, "byPlan": { "pro": 0, "team": 0, "enterprise": 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}