Create a budget for the organization.
https://cloud.elastic.co
(Public)
- POST /api/v1/billing/organization/{organization_id}/budget
Create a new budget for an organization
Path Parameters
-
organization_idstringrequired -
The organization ID
Request
-
activeboolean · default: true -
Whether the budget is active
-
alertsobjectrequired -
List of budget alerts. The service enforces a server-side limit on the number of alerts per budget.
-
thresholdintegerrequired -
Alert threshold value
-
threshold_type· default: percentage -
Type of alert threshold; only percentage is supported
-
Values:
percentage -
amountintegerrequired -
Budget amount in ECU
-
namestring -
Optional name for the budget
-
period -
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 -
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. organization-admins, billing-admins are included by default if recipient_group is not provided.
-
Values:
organization-adminsbilling-adminsresource-viewersresource-editorsresource-admins -
scope_valuesstringrequired -
List of scope values
-
windowobject -
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). The current window start is returned as window.start_date and cannot be set by the client.
-
repeat_everyinteger · min: 1required -
Number of units between resets
-
reset_onBudgetResetOn -
The user's reset selection. Only the fields required by the window frequency are set: weekly uses weekday, monthly uses day, quarterly uses month, yearly uses month and day. Days 29-31 clamp to the last day of shorter months, recomputed every period from this selection (day 31 resets on Jan 31, Feb 28, Mar 31, Apr 30; Feb 29 resets on Feb 28 in non-leap years).