Set a workspace spending limit

$ boltz-api admin:workspaces set-spending-limit

PUT/compute/v1/admin/workspaces/{workspace_id}/spending-limit

ParametersExpand Collapse

--workspace-id: string

--limit: object { amount, currency }

--type: "lifetime"

ReturnsExpand Collapse

AdminWorkspaceSetSpendingLimitResponse: object { limit, type }

Configured lifetime workspace spending limit, or null if unset. Unset workspaces have no workspace-level cap and continue to use organization-level billing.

limit: object { amount, currency }

amount: number

Workspace spending limit amount in milli-USD. Tracking starts when the limit is configured; prior or already-committed unreserved work is not counted in this workspace cap ledger.

currency: "MILLI_USD"

Workspace spending limits currently support milli-USD only.

type: "lifetime"

Set a workspace spending limit

boltz-api admin:workspaces set-spending-limit \
  --api-key 'My API Key' \
  --workspace-id workspace_id \
  --limit '{amount: 5000, currency: MILLI_USD}' \
  --type lifetime

{
  "limit": {
    "amount": 5000,
    "currency": "MILLI_USD"
  },
  "type": "lifetime"
}

Returns Examples

{
  "limit": {
    "amount": 5000,
    "currency": "MILLI_USD"
  },
  "type": "lifetime"
}