Update a budget
Changes the amount, thresholds or behavior. Send the version you read as expected_version; a newer
stored version, for instance after the customer edited it, is refused with 409.
Beta: the request and response shapes of this endpoint may change before general availability.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Required; reuse it only to retry the same request
Body
The currency or credit unit, and the subscription, are fixed at creation.
The version you read; a newer stored version is refused with 409.
What reaching the amount does. A SOFT budget only sends alerts; a HARD budget also makes the entitlement check answer BUDGET_EXCEEDED for the features whose usage counts in its spend. A HARD budget on one subscription refuses the checks naming that subscription, and the checks naming none once every subscription charging the feature's metric is refused by its own.
SOFT, HARD x >= 0Response
Budget updated
A spending limit for one currency, set by you or by the customer, with alerts at percentages of it. It counts the customer's whole spend, or one subscription's. A HARD budget also refuses access once reached. A budget never charges the customer.
In minor units of the currency or credit unit.
What reaching the amount does. A SOFT budget only sends alerts; a HARD budget also makes the entitlement check answer BUDGET_EXCEEDED for the features whose usage counts in its spend. A HARD budget on one subscription refuses the checks naming that subscription, and the checks naming none once every subscription charging the feature's metric is refused by its own.
SOFT, HARD Who set the budget: you (TENANT) or the customer, from the portal (CUSTOMER).
TENANT, CUSTOMER Always false: the estimate prices usage that is not yet invoiced.
Percentages of the amount at which an alert is sent.
x >= 0Send it back as expected_version when patching.
When estimated_spend was last measured.
The credit unit (its code) whose usage the budget counts; absent for a currency.
Decimal places of credit_unit: amounts are integers of 10^-precision credit.
x >= 0The currency the budget counts spend in; absent for a budget in a credit unit.
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNH, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL "EUR"
Spend in the current billing period, including usage not invoiced yet, in minor units. Absent until first measured.
The current billing period: of subscription_id when set. Absent for an archived budget, or
without an active subscription to measure it on.
The subscription whose spend the budget counts; null when it counts the whole customer's.