Skip to main content
PATCH
Update budget

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

budget_id
string<uuid>
required

Budget ID. A budget you cannot manage is masked as missing and fails with resource-not-found (404).

Body

application/json

API keys and runtime credentials are refused. A member cap cannot target the caller.

monthly_limit_credits
number

New monthly AI spending limit in credits. Usage already recorded this month is retained; if the new limit is below it, the next call in the scope is rejected. Supply exactly one of the credit or the deprecated USD limit. At most 8589934591.999999 credits, with at most six decimal places. Provide exactly one of monthly_limit_credits or monthly_limit_usd.

Required range: 0 <= x <= 8589934591.999999
Example:

500

monthly_limit_usd
number
deprecated

Deprecated. Use monthly_limit_credits. Monthly limit in USD, converted to credits at the published credit price. At most 858993459.1999999 USD, the most that converts within the credit maximum. Usage already recorded this month is retained. Provide exactly one of monthly_limit_credits or monthly_limit_usd.

Required range: 0 <= x <= 858993459.1999999
Example:

50

Response

Budget updated

id
string<uuid>
required
scope
object
required
monthly_limit_usd
number
required

The monthly AI spend limit, in USD

monthly_limit_credits
number
required

The same limit in credits, the unit spend is counted in

status
object
required

Usage against the budget for the current month, or null if the subject has no budget.

created_at
string
required
updated_at
string
required