SnozeDevelopers
API referenceBilling

Read the workspace usage breakdown

Returns per-resource usage counts for the workspace. Deliberately open to any workspace member rather than gated on `billing:read`, because these counts are what the interface uses to explain why a limit-bound action is unavailable.

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

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/usage'
Example Response
{  "data": {    "billableSeats": 0,    "freeSeats": 0,    "records": 0,    "automationRunsThisMonth": 0,    "usagePeriod": {      "start": "string",      "end": "string",      "source": "subscription"    },    "automations": 0,    "dashboards": 0,    "forms": 0,    "storageBytes": 0,    "surfaceLimits": {      "dashboards": 0,      "forms": 0    }  }}

Cancel a scheduled plan change

Keeps the current plan by dropping a downgrade or interval switch scheduled for the renewal, then returns the subscription. Succeeds without changes when nothing is scheduled; a workspace without a subscription is a conflict. Requires a Clerk session with a synced profile and the `billing:manage` workspace permission. Send an `Idempotency-Key` header to make retries safe.

Recover the workspace's pending checkout

Requires billing:manage. Returns the existing verified recurring checkout without creating or changing a purchase, including legacy single-product sessions. Expired and failed sessions return null.