Skip to content
Boltz Boltz Boltz API Docs
Go to Boltz API
API Reference
Admin
Workspaces

Set a workspace spending limit

admin.workspaces.set_spending_limit(strworkspace_id, WorkspaceSetSpendingLimitParams**kwargs) -> WorkspaceSetSpendingLimitResponse
PUT/compute/v1/admin/workspaces/{workspace_id}/spending-limit

Set a workspace spending limit

ParametersExpand Collapse
workspace_id: str
limit: Limit
amount: int

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.

minimum0
maximum9007199254740991
currency: Literal["MILLI_USD"]

Workspace spending limits currently support milli-USD only.

type: Literal["lifetime"]
ReturnsExpand Collapse
class WorkspaceSetSpendingLimitResponse: …

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

limit: Limit
amount: int

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.

minimum0
maximum9007199254740991
currency: Literal["MILLI_USD"]

Workspace spending limits currently support milli-USD only.

type: Literal["lifetime"]

Set a workspace spending limit

import os
from boltz_api import Boltz

client = Boltz(
    api_key=os.environ.get("BOLTZ_API_KEY"),  # This is the default and can be omitted
)
response = client.admin.workspaces.set_spending_limit(
    workspace_id="workspace_id",
    limit={
        "amount": 5000,
        "currency": "MILLI_USD",
    },
    type="lifetime",
)
print(response.limit)
{
  "limit": {
    "amount": 5000,
    "currency": "MILLI_USD"
  },
  "type": "lifetime"
}
Returns Examples
{
  "limit": {
    "amount": 5000,
    "currency": "MILLI_USD"
  },
  "type": "lifetime"
}