Cost Controls

Get budget status

Get real-time status of a budget including current usage, remaining amount, and whether the budget is exceeded.

Enterprise only. These routes are not registered in Community edition, which returns 404 Not Found.

get/api/v1/budgets/{id}/status

Request

Path parameters

idstring required

Budget ID

Response

Budget status

used_usdnumber double

Amount spent in current period

remaining_usdnumber double

Remaining budget

percentagenumber double

Percentage of budget used

period_startstring date-time
period_endstring date-time
is_exceededboolean

Whether budget limit has been exceeded

is_blockedboolean

Whether requests are being blocked

Changes

No recorded changes to this operation across all 1 revision of this API.