SnozeDevelopers
API referenceAdmin workspaces

Override a workspace's plan limits

Sets a platform-admin override on a workspace's limits and returns the updated summary. Platform admins only — the override is authorized by the platform admin gate, not by workspace membership. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.

PATCH
/v1/admin/workspaces/{workspaceId}/override

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

Request Body

application/json
  1. body
planOverride?|null|null
aiMonthlyBonusMicrousd?|null
aiRunCapMicrousd?|null|null
featureGrants?array<>|null
expiresAt?string|null|null
reason*string
Match^\S[\s\S]*\S$|^\S$|^$
Length3 <= length <= 500

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X PATCH 'https://api.snoze.dev/v1/admin/workspaces/string/override' \  -H 'Content-Type: application/json' \  -d '{  "reason": "string"}'
Example Response
{  "data": {    "workspaceId": "string",    "name": "string",    "slug": "string",    "lifecycleStatus": "active",    "memberCount": 0,    "billedPlan": "free",    "subscriptionStatus": "none",    "effectivePlan": "free",    "currentPeriodEnd": "string",    "override": {      "planOverride": "free",      "aiMonthlyBonusMicrousd": 0,      "aiRunCapMicrousd": 0,      "featureGrants": [        "integrations"      ],      "reason": "string",      "expiresAt": "string",      "updatedAt": "string"    },    "lastResetAt": "string",    "aiUsage": {      "plan": "free",      "unlimited": true,      "monthly": {        "capMicrousd": 0,        "usedMicrousd": 0,        "remaining": 0,        "refillsAt": "string"      },      "includedMonthlyMicrousd": 0,      "burst": {        "capMicrousd": 0,        "usedMicrousd": 0,        "remaining": 0,        "refillsAt": "string"      },      "auto": {        "enabled": true,        "window": {          "capMicrousd": 0,          "usedMicrousd": 0,          "remaining": 0,          "refillsAt": "string"        },        "daily": {          "capMicrousd": 0,          "usedMicrousd": 0,          "remaining": 0,          "refillsAt": "string"        }      },      "onboardingGrantActive": true,      "topupBalanceMicrousd": 0,      "topupsAvailable": true,      "typicalTurnMicrousd": 0,      "credits": {        "usedCredits": 0,        "totalCredits": 0,        "remainingCredits": 0,        "includedCredits": 0,        "topupCredits": 0,        "percentUsed": 0,        "thresholds": [          0        ],        "thresholdReached": 0,        "refillsAt": "string",        "editors": 0,        "freeMembers": 0,        "perEditorCredits": 0,        "perFreeMemberCredits": 0,        "member": {          "usedCredits": 0,          "capCredits": 0        },        "grace": {          "dailyCredits": 0,          "usedTodayCredits": 0,          "remainingCredits": 0,          "refillsAt": "string"        },        "runCapCredits": 0,        "fastLaneOnly": true,        "fastLaneReason": "plan"      }    }  }}

Read one workspace's operational state

Returns a single workspace's plan, limit overrides, and AI usage. Platform admins only; an unknown `workspaceId` is reported as not found.

Clear a workspace's plan limit override

Removes the platform-admin override and returns the workspace to its plan defaults, recording the supplied `reason`. Platform admins only. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.