Skip to main content
GET
Get a budget

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Path Parameters

budget_id
string
required

Response

Successful Response

A spend threshold over a recurring or fixed period.

A budget compares actual and forecasted spend against amount for its current period, optionally narrowed to a team and to a slice of spend via filter_expression. The period dates are derived from period as the budget is read, so they always describe the period it is in now. status is measured against spend instead, on the cadence its own description gives.

id
string
required
read-only

The unique identifier of the budget.

name
string
required
amount
number
required

The spend threshold for one period.

period
FixedRangeSchedule · object
required

The recurrence or date range the budget's threshold applies over.

started_at
string
required
current_period_start
string<date>
required
read-only

The start date of the period the budget is currently in.

current_period_end
string<date>
required
read-only

The end date of the period the budget is currently in.

created_by
string
required
read-only

Who created the budget.

create_time
string
required
read-only

RFC 3339 UTC creation timestamp.

update_time
string
required
read-only

RFC 3339 UTC last-update timestamp.

etag
string
required
read-only

Opaque strong ETag.

status
enum<string> | null

The budget's current standing against its spend threshold. Measured by a daily refresh, or on demand by evaluating the budget. Null until one of those has run: creating or changing a budget does not measure it, and changing what it measures clears it again.

Available options:
on_track,
at_risk,
overspending,
expired
team_id
string | null

The team this budget is scoped to. Null scopes it to the whole organization.

filter_expression
FilterExpression[Union[SemiStructuredDimension[ConsolidatedDailySpendDimensions], ConsolidatedDailySpendDimensions]] · object | null

Narrows which spend counts toward the budget. Null counts all spend.

filter_expression_json
string | null

The JSON string representation of the filter expression, used by the Terraform provider. Null when the budget has no filter.

budget_end_date
string<date> | null

When the budget itself expires. Null if it never does.

updated_by
string | null

Who last changed the budget. Null if no one has since it was created.