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.
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
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/admin/workspaces/string/override" \ -H "Content-Type: application/json" \ -d '{ "reason": "string" }'{ "data": { "workspaceId": "string", "name": "string", "slug": "string", "lifecycleStatus": "active", "memberCount": 0, "billedPlan": "free", "subscriptionStatus": "none", "effectivePlan": "free", "currentPeriodEnd": "string", "override": { "planOverride": "free", "aiMonthlyBonusMicrousd": 0, "aiBurstBonusMicrousd": 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" }, "burst": { "capMicrousd": 0, "usedMicrousd": 0, "remaining": 0, "refillsAt": "string" }, "onboardingGrantActive": true, "topupBalanceMicrousd": 0, "topupsAvailable": true } }}{ "_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}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.