Read the workspace subscription and entitlements
Returns the workspace's current subscription record together with the entitlements derived from it. Requires a Clerk session and the `billing:read` workspace permission; API keys cannot call it.
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/subscription"{ "data": { "subscription": { "workspaceId": "string", "plan": "free", "status": "none", "polarCustomerId": "string", "polarSubscriptionId": "string", "polarProductId": "string", "cancelAtPeriodEnd": true, "currentPeriodEnd": "string" }, "entitlements": { "plan": "free", "status": "none", "maxEditorSeats": 0, "maxRecords": 0, "maxAutomationRunsPerMonth": 0, "maxAutomations": 0, "maxDashboards": 0, "maxForms": 0, "maxStorageBytes": 0, "historyRetentionDays": 0, "features": [ "string" ] } }}{ "_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}Resolve the Zero sync identity for the current session
Returns the caller's Clerk user id as `protocolUserId` alongside the internal Snoze user UUID, which the Zero sync client needs to address rows it owns. Requires a Clerk session with a synced Snoze profile; the internal user record is resolved on demand, so a session whose profile cannot be resolved fails.
Read the plan catalog with the workspace's current plan
Returns the purchasable plan catalog plus the workspace's effective plan and subscription status. Any workspace member with a Clerk session and a synced profile may call it, so members see only the effective plan rather than the full subscription record. If a pricing experiment is running the caller's deterministic variant selects the catalog and the exposure is recorded.