Skip to main content
POST
Create a per-currency budget for a group

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"

Body

application/json
spendingLimitCents
string
required

Spend ceiling for the period, in minor units (cents of currency).

Example:

"150000"

currency
enum<string>

Currency of this budget (one budget per currency per group). Defaults to usd. Enforcement matches the charge currency exactly — a usd budget does NOT cap usdc spend.

Available options:
usd,
eur,
usdc,
eurc
Example:

"usd"

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