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.
Name In Type Notes workspace_idpath string (uuid) required —
Status Description Body 200Successful Response BudgetStatusView422Validation Error HTTPValidationError
Only the success paths are declared
Any operation may also answer any status in the error catalogue , and
every failure body is the platform envelope — including the 422 this document types
as HTTPValidationError.
curl -X GET https://your-deployment.example.com/budgets/{workspace_id}/status \
-H " Authorization: Bearer $COBRE_TOKEN "
Field Type Notes workspace_idstring (uuid) required — periodmonth | dayrequired — period_startstring (date-time) required — period_endstring (date-time) required — spendstring required — limit_amountstring | null optional — currencystring optional Default "USD". is_enforcedboolean optional Default false. alert_threshold_pctinteger optional Default 80. exceededboolean optional Default false. threshold_reachedboolean optional Default false. remainingstring | null optional — projected_spendstring | null optional — projection_methodstring optional Default "linear". sourceledger | cacheoptional Default "ledger".