Sign in
organization-budgets

Update Organization Budget

Change a budget's label, figure or period.

Every ceiling naming it is held to the new figure from here on, which is the point of naming a budget rather than typing an amount per place it applies.

patch/v1/organizations/me/budgets/{budget_id}

Path parameters

budget_idstring required

Request body

budget_duration_secinteger nullable

Seconds between resets, counted from the last one. Mutually exclusive with reset_alignment

max_budgetnumber nullable

Maximum spend in USD over one period; null caps nothing

namestring nullable

Admin-facing label for the budget

request_limitinteger nullable

Maximum requests over one period; null caps nothing. Independent of max_budget

reset_alignment'calendar_day' | 'calendar_week' | 'calendar_month' nullable

Reset on a UTC calendar boundary instead of a fixed number of seconds, which is the only way to express a calendar month. Mutually exclusive with budget_duration_sec

token_limitinteger nullable

Maximum tokens over one period; null caps nothing. Independent of max_budget

Response

Successful Response

budget_duration_secinteger nullable required
budget_idstring required
ceiling_countinteger required
created_atstring required
max_budgetnumber nullable required
namestring nullable required
organization_idstring uuid required
request_limitinteger nullable required
reset_alignmentstring nullable required
token_limitinteger nullable required
updated_atstring required

Changes