set_cost_budget
Create a monthly cost budget, or change one. To create, give name, scope_kind (organisation, project, cluster, environment or application), scope_id (the project, cluster or application id, or the environment label; omit for the organisation), monthly_amount in whole units of currency, and currency; a scope holds one budget. To change, give budget_id and only the fields that change - the scope never changes, the rest keeps its value, and owner_user_id null or clear_owner true clears the owner. notify_at_pct (default 80) is the share of the budget at which its card is raised. Organisation admins only (billing.manage); every change is audited. Reversible by setting the previous values back (read get_cost_budgets first).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | 1 to 120 characters. | |
| currency | No | usd, eur, gbp, sek, nok, dkk, chf, pln, czk, jpy, cad, aud or inr. | |
| scope_id | No | The project, cluster or application id, or the environment label; omit for the organisation. Only on a create. | |
| budget_id | No | The budget to change; omit to create one. | |
| scope_kind | No | What the budget covers; only on a create. A project budget covers the clusters the project holds now. | |
| clear_owner | No | Clear the owner on a change. | |
| notify_at_pct | No | Raise the budget's card when the projection reaches this percent of the budget. Defaults to 80 on a create. | |
| owner_user_id | No | An active member of the organisation the budget is for; null clears. | |
| monthly_amount | No | The budget per month in whole units of currency, like 5000 for 5,000 EUR. |