Skip to main content
PATCH
Update a budget's limit / interval / alert threshold

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orgId
string
required
Example:

"org-abc123"

groupId
string
required
Example:

"grp-abc123"

budgetId
string
required
Example:

"bdg-abc123"

Body

application/json
spendingLimitCents
string
required

Spend ceiling for the period (minor units)

Example:

"150000"

interval
enum<string>
Available options:
month,
year,
one_shot
Example:

"month"

alertThresholdPct
number

Alert when spend crosses this % of the limit

Example:

80

maxTransactions
number | null

Optional cap on the number of charges per period

Response

Envelope { success, budget: GroupBudgetResponseDto }

success
boolean
required
Example:

true

budget
object
required