v171

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0726249111.7 MB
Budgets

Update a budget

Updates mutable fields of a budget: limits, rate limit, activation, and expiration. The scope is immutable — to change a budget's target, delete and recreate it. Omitted fields keep their current values.

patch/v2/budgets/{budget_id}

Path parameters

budget_idstring required

Budget id to update.

Request body

is_activeboolean

New active state. Omit to keep current.

expires_atstring date-time

New expiration. Omit to keep current. Set clear_expires_at = true to remove an existing expiration.

clear_expires_atboolean

Force-clear the expiration. Mutually exclusive with expires_at.

clear_alertsboolean

Force-clear every alert. Mutually exclusive with a non-empty alerts.

Response

OK