Get a budget for the organization.

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

GET /api/v1/billing/organization/{organization_id}/budgets/{budget_id}

Retrieves a budget for the specified organization. Callers with org-wide budget access receive any budget in the organization. Others receive cloud-resource-scoped budgets only when all scope values are resources they can access; otherwise 403 Forbidden. Scope values referring to deleted instances are ignored.

Path parameters

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

Responses

Budget successfully retrieved

application/json

active boolean required
alerts object[] required
amount integer required
created_at string
id integer required
name string
period enum required: Values: monthly
recipient_group enum[] required: Values: organization-admins billing-admins resource-viewers resource-editors resource-admins
scope_type enum required: Values: organization cloud_resource
scope_values string[] required
window object: 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. reset_on is omitted for daily windows.

403

Not allowed to read this budget

404

Budget not found

500

Internal server error

{ "active": false, "alerts": [ { "created_at": "string", "id": 0, "last_exceeded_at": "string", "operator": "gte", "threshold": 0, "threshold_type": "percentage" } ], "amount": 0, "created_at": "string", "id": 0, "name": "string", "period": "monthly", "recipient_group": [ "organization-admins" ], "scope_type": "organization", "scope_values": [ "string" ], "window": { "repeat_every": 0, "repeat_unit": "day", "reset_on": { "day": 0, "month": "jan", "weekday": "mon" } } }