latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-21163196628.8 KB

2d6e4912e230

scoped-budgets

Update Scoped Budget

Relabel a ceiling, or point it at a different budget.

The scope and the provider narrowing are not editable: changing either would move the ceiling to a different identity while carrying its spend, which is a delete and a create, not an update.

There is no limit or period to set here any more. Both are properties of the budget, so changing what a ceiling allows is either editing that budget, which moves every ceiling naming it, or naming a different one.

patch/v1/scoped-budgets/{budget_id}

Path parameters

budget_idstring required

Request body

budget_idstring nullable

namestring nullable

Response

Successful Response

budget_duration_secinteger nullable required

budget_idstring required

created_atstring required

current_spendnumber required

idstring required

max_budgetnumber nullable required

namestring nullable required

period_endstring nullable required

period_startstring nullable required

provider_key_idstring nullable required

reserved_spendnumber required

reset_alignmentstring nullable required

scope_idstring required

scope_typestring required

updated_atstring required