Skip to main content
GET
Get a workspace budget

Authorizations

Authorization
string
header
required

API key as bearer token in Authorization header

Path Parameters

id
string
required

The workspace ID (UUID) or slug

Minimum string length: 1
Example:

"production"

interval
enum<string>
required

Budget reset interval. Use "lifetime" for a one-time budget that never resets.

Available options:
daily,
weekly,
monthly,
lifetime
Example:

"monthly"

Response

Budget retrieved successfully

data
object
required

The budget for the requested interval

Example:
include_byok_in_budgets
boolean

Whether BYOK (bring-your-own-key) spend is included when enforcing the workspace's budgets. This is a workspace-wide setting that applies to all budget intervals (daily, weekly, monthly, and lifetime).

Example:

true