latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-21163196628.8 KB

2d6e4912e230

budgets

Create Budget

Create a new budget.

post/v1/budgets

Request body

budget_duration_secinteger nullable

Budget duration in seconds (e.g., 86400 for daily, 604800 for weekly)

max_budgetnumber nullable

Maximum spending limit

namestring nullable

Admin-facing label for the budget

reset_alignment'calendar_day' | 'calendar_week' | 'calendar_month' nullable

Reset on a UTC calendar boundary instead of a fixed number of seconds, which is the only way to express a calendar month. Mutually exclusive with budget_duration_sec

Response

Successful Response

budget_duration_secinteger nullable required
budget_idstring required
created_atstring required
max_budgetnumber nullable required
namestring nullable required
reset_alignmentstring nullable required
total_reservednumber
total_spendnumber
updated_atstring required
user_countinteger