Skip to main content
GET
Get a budget's spend summary

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

What a budget has spent so far this period, and where it is heading.

Refreshed once a day, on the same cadence as the budget's status. Only days that have finished loading count toward spend, and a day only finishes once, so these figures step forward daily rather than continuously. Null until the first refresh after the budget is created — evaluate the budget to fill them in without waiting for the next one.

budget_id
string
required
read-only

The budget this summary is for.

period_start
string<date>
required
read-only

The first day of the period these figures cover.

period_end
string<date>
required
read-only

The last day of the period these figures cover.

spend
number | null

Spend so far in the current period, counting only days that have finished loading. Null before the budget's first refresh.

forecast
number | null

Projected total spend by the end of the current period, extrapolated from the budget's recent daily spend. Null before the first refresh, when there is too little history to project from, or once the period has ended.

forecast_diff
number | null

How far forecast lands from the budget's threshold, as a percentage of it — positive over, negative under. Null when there is no forecast, or the threshold is zero.