Create budget

Create a new budget to track cloud spending.

Budgets monitor actual spend against a target amount and notify subscribers when configurable thresholds are breached. Three amount types are supported:

  • Specified amount — A fixed dollar value for each period.
  • Variable amount — Each periods entry supplies an amount for one period of the budget's cadence. Use key: YYYY-MM for months, YYYY-Qn for quarters, YYYY for years, or FYyyyy-Mn, FYyyyy-Qn, and FYyyyy for fiscal periods (month and quarter are unpadded). The legacy month field is only for calendar-month budgets.
  • Hierarchical amount — Dimension-level allocations within the total.

Returns the budgetID of the newly created budget.

Threshold cadence must fit the resulting budget period: MONTH permits DAILY_SPEND and MONTHLY_SPEND; QUARTER also permits QUARTERLY_SPEND; YEAR also permits YEARLY_SPEND. Forecasted spend is allowed only for the threshold matching the full budget period; shorter daily/checkpoint thresholds use actual spend. These rules also apply to sub-budget alerts. percent is a numeric percentage, not a monetary amount.

limitVersions selects LATEST or HIGHLIGHTED budget amounts. Actual daily/checkpoint spend is compared with a percentage of the whole budget-period amount. Numeric percent is not restricted to the UI editor's 1–100 range. Incompatible cadence/forecast rules return 400 without changing the budget.

Body Params
uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

A unique identifier for an organization

number | null

Dollar value of the budget

hierarchicalAmount
object
boolean

Whether the budget uses variable amounts by period. When true, a top-level numeric amount is rejected; this does not mean a fixed recurring amount.

string
required
length ≥ 1

Budget measure

string
required
length ≥ 1

Budget name

period
object

Budget period; a calendar month when omitted

periods
array of objects

Period versions

periods
scopes
array of objects
required
length ≥ 1
scopes*
slackChannelIDs
array of strings

Slack channel IDs to receive budget notifications

slackChannelIDs
subscribers
object
required
thresholds
array of objects
required
thresholds*
webhookIDs
array of uuids, unique
length ≤ 10

Webhook IDs to receive budget notifications

webhookIDs
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json