Skip to content

Get Budget Status

GET /budgets/{workspace_id}/status

Spend, limit, enforcement, threshold state and the projection.

source says whether the spend figure came from the ledger or from the 60-second cache in front of it. On the wire because “the number is a minute old” and “the number is now” are different answers to the question a customer is actually asking.

NameInTypeNotes
workspace_idpathstring (uuid)required—
StatusDescriptionBody
200Successful ResponseBudgetStatusView
422Validation ErrorHTTPValidationError
Terminal window
curl -X GET https://your-deployment.example.com/budgets/{workspace_id}/status \
-H "Authorization: Bearer $COBRE_TOKEN"
FieldTypeNotes
workspace_idstring (uuid)required—
periodmonth | dayrequired—
period_startstring (date-time)required—
period_endstring (date-time)required—
spendstringrequired—
limit_amountstring | nulloptional—
currencystringoptionalDefault "USD".
is_enforcedbooleanoptionalDefault false.
alert_threshold_pctintegeroptionalDefault 80.
exceededbooleanoptionalDefault false.
threshold_reachedbooleanoptionalDefault false.
remainingstring | nulloptional—
projected_spendstring | nulloptional—
projection_methodstringoptionalDefault "linear".
sourceledger | cacheoptionalDefault "ledger".