Read the platform billing overview
Returns the plans, price rows, and AI top-up products behind Snoze pricing. Opening the surface also provisions the Polar product for every price and top-up pack, which is idempotent, so the response always carries current product ids. Platform admins only.
Authorization
apiKey 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, "maxEditorSeats": 0, "maxRecords": 0, "automationRunsBasePerMonth": 0, "automationRunsPerSeatPerMonth": 0, "maxAutomations": 0, "maxDashboards": 0, "maxForms": 0, "maxStorageBytes": 0, "historyRetentionDays": 0, "features": [ "string" ], "aiMonthlyBaseMicrousd": 0, "aiMonthlyPerSeatMicrousd": 0, "aiBurstMicrousd": 0, "aiOnboardingGrantMicrousd": 0 } ], "prices": [ { "id": "string", "plan": "free", "interval": "month", "variant": "string", "amountCents": 0, "currency": "string", "polarProductId": "string", "active": true, "updatedAt": "string" } ], "topupProducts": [ { "pack": "string", "priceCents": 0, "grantedMicrousd": 0, "polarProductId": "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": { "team": 0, "business": 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}Invite a platform admin
Creates or re-enables a platform admin account for an email address and returns it. Platform admins only, and owner-only while the `require-owner-for-admin-invites` policy is on; a request without an email address is rejected as a validation error. Idempotent by email: inviting an address that is already an active admin returns the existing record.
Create a billing price row
Adds a price for a plan and immediately provisions its Polar product, returning the row with the resulting `polarProductId`. Platform admins only; an invalid amount, currency, or plan is rejected as a validation error.