Get a budget for the organization.
https://cloud.elastic.co
(Public)
- GET /api/v1/billing/organization/{organization_id}/budgets/{budget_id}
Retrieves a budget for the specified organization. Admins receive any budget in the organization. Non-admins receive organization-scoped budgets with 403 Forbidden; cloud-resource-scoped budgets are returned only when all scope values are instances they can access, otherwise 403 Forbidden.
Path Parameters
-
organization_idstringrequired -
The organization ID
-
budget_idintegerrequired -
The budget ID
Responses
Budget successfully retrieved
-
activebooleanrequired -
alertsBudgetAlertrequired -
created_atstring -
idintegerrequired -
last_exceeded_atstring -
operator -
Values:
gte -
thresholdintegerrequired -
threshold_type -
Values:
percentage -
amountintegerrequired -
created_atstring -
idintegerrequired -
namestring -
period -
Values:
monthly -
recipient_group -
Values:
organization-adminsbilling-adminsresource-viewersresource-editorsresource-admins -
scope_type -
Values:
organizationcloud_resource -
scope_valuesstringrequired -
windowBudgetWindow -
Recurring budget window. Allowed (repeat_unit, repeat_every) pairs: daily (day, 1), weekly (week, 1), monthly (month, 1), quarterly (month, 3), yearly (year, 1). Windows reset at 00:00 UTC; spend is counted from the later of the window start and the budget creation time.
-
repeat_everyintegerrequired -
repeat_unit -
Values:
dayweekmonthyear -
reset_onBudgetResetOnrequired -
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).
-
start_datestringrequired -
Read-only. Start of the current window as a UTC date (YYYY-MM-DD), computed by the server from reset_on.
Not allowed to read this budget
Budget not found
Internal server error