Update a budget for the organization.

Base URL: https://cloud.elastic.co Public

POST /api/v1/billing/organization/{organization_id}/budget/{budget_id}

Update an organization's existing budget. Callers with org-wide budget access may update any budget; others may update only cloud-resource-scoped budgets for which they have update access on all scoped resources.

Path parameters

organization_id string required: The organization ID
budget_id integer required: The budget ID

Request body

active boolean · default: true: Whether the budget is active
alerts object[] required: List of budget alerts. The service enforces a server-side limit on the number of alerts per budget.
amount integer required: Budget amount in ECU
name string: Optional name for the budget
period enum deprecated: Deprecated, use window instead. period=monthly is equivalent to a monthly window with reset_on.day=1. If both period and window are sent they must describe the same schedule.; Values: monthly
recipient_group enum[]: Optional list of recipient types who receive budget alerts (organization-admins, billing-admins, resource-viewers, resource-editors, resource-admins). resource-viewers, resource-editors and resource-admins cannot be used with scope_type=organization.; Values: organization-admins billing-admins resource-viewers resource-editors resource-admins
scope_type enum required: The scope type of the budget; Values: organization cloud_resource
scope_values string[] required: List of scope values
window object: Recurring budget window. Allowed (repeat_unit, repeat_every) pairs and the reset_on fields each one requires: daily (day, 1) with no reset_on; weekly (week, 1) with reset_on.weekday; monthly (month, 1) with reset_on.day; quarterly (month, 3) with reset_on.month, resetting on the 1st; yearly (year, 1) with reset_on.month and reset_on.day. Any other combination, or a missing or extra reset_on field, returns 400. Windows reset at 00:00 UTC. Days 29-31 clamp to the last day of shorter months, recomputed every period (day 31 resets on Jan 31, Feb 28, Mar 31, Apr 30).

Responses

204

Budget updated successfully

400

Invalid request

403

Not allowed to update this budget

404

Budget not found

500

Internal Server Error

Path parameters

Request body { }

Responses

Request body