SnozeDevelopers
API referenceBilling

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.

GET
/v1/workspaces/{workspaceId}/billing/plans

Authorization

apiKey
headerAuthorizationBearer <snoze_sk_…>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

Path Parameters

workspaceId*string

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.snoze.dev/v1/workspaces/string/billing/plans'
Example Response
{  "data": {    "catalog": {      "plans": [        {          "plan": "free",          "name": "string",          "tagline": "string",          "bullets": [            "string"          ],          "selfServe": true,          "maxEditorSeats": 0,          "maxRecords": 0,          "automationRunsBasePerMonth": 0,          "automationRunsPerSeatPerMonth": 0,          "maxAutomations": 0,          "maxDashboards": 0,          "maxForms": 0,          "maxStorageBytes": 0,          "historyRetentionDays": 0,          "aiMonthlyBaseMicrousd": 0,          "aiMonthlyPerSeatMicrousd": 0,          "features": [            "string"          ],          "prices": {            "month": {              "amountCents": 0,              "currency": "string",              "checkoutReady": true            },            "year": {              "amountCents": 0,              "currency": "string",              "checkoutReady": true            }          }        }      ]    },    "plan": "free",    "status": "none",    "entitlements": {      "plan": "free",      "status": "none",      "maxEditorSeats": 0,      "maxRecords": 0,      "maxAutomationRunsPerMonth": 0,      "maxAutomations": 0,      "maxDashboards": 0,      "maxForms": 0,      "maxStorageBytes": 0,      "historyRetentionDays": 0,      "features": [        "string"      ]    }  }}

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.

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.