Freeze a budget (ACTIVE → FROZEN)
Transitions a budget from ACTIVE to FROZEN. Frozen budgets block all fund operations and new reservations, but can still be updated (overdraft_limit, commit_overage_policy, metadata).
AUTHORIZATION: - Requires admin key (X-Admin-API-Key)
TRANSITION RULES: - ACTIVE → FROZEN: Allowed - FROZEN → FROZEN: 409 (already frozen) - CLOSED → FROZEN: 409 (closed is irreversible)
EVENTS: - Emits budget.frozen event on successful transition.
Authorizations
Administrative API key with full system access. Also accepted as an alternative to ApiKeyAuth on an explicit per-operation allowlist — the authoritative list is the union of operations whose security: block declares AdminKeyAuth (consult per-operation security blocks rather than this prose, which has historically drifted as the dual-auth surface expanded). When using AdminKeyAuth on list or fund endpoints, a tenant scoping parameter (typically tenant or tenant_id) is required for scoping (400 if missing) — the per-operation description specifies which. Lookup-style endpoints that uniquely identify a resource by non-tenant key (e.g. GET /v1/admin/budgets/lookup, where the (scope, unit) pair is unique) do NOT require a tenant parameter. Allowlisting is per-operation (exact method:path matching — no prefix matching, no wildcards) so new endpoints do not accidentally inherit admin-accessible status.
Parameters
Query Parameters
Canonical scope identifier
"USD_MICROCENTS""TOKENS""CREDITS""RISK_POINTS"Request Body
Responses
Budget frozen