everruns budgets
Applies toFramework (not available)Self-hostedEverruns Cloud
Spending limits for sessions, agents, users and organizations.
| Command | What it does |
|---|---|
budgets check | Check budget status for a session-scoped budget. |
budgets create | Create a budget for a subject (session, agent, user, org). |
budgets delete | Delete a budget. |
budgets get | Get a single budget by ID. |
budgets list | List budgets. |
budgets update | Update a budget limit, status, or metadata. |
budgets ledger list | List ledger entries for a budget. |
budgets top-up top | Add credits to a budget. |
budgets check
Section titled “budgets check”Check budget status for a session-scoped budget.
everruns budgets check [OPTIONS] --budget-id <budget_id>| Flag | Description |
|---|---|
--budget-id <BUDGET_ID> | Required. Budget’s prefixed public identifier. |
Example:
# Check whether a budget still has room before starting expensive workeverruns budgets check --budget-id bdgt_01h9budgets create
Section titled “budgets create”Create a budget for a subject (session, agent, user, org). Sets a spending cap in the given currency.
everruns budgets create [OPTIONS] --currency <currency> --limit <limit> --subject-id <subject_id> --subject-type <subject_type>| Flag | Description |
|---|---|
--currency <CURRENCY> | Required. Unit in which usage and the limit are measured. |
--limit <LIMIT> | Required. Hard spending ceiling for the budget. |
--metadata <METADATA> | Free-form metadata attached to this resource. |
--period <PERIOD> | |
--soft-limit <SOFT_LIMIT> | Optional threshold that triggers a warning or pause before exhaustion. |
--subject-id <SUBJECT_ID> | Required. Public identifier of the constrained resource. |
--subject-type <SUBJECT_TYPE> | Required. Kind of resource constrained by the budget. |
Example:
# Cap an agent's spend with an early warning before the hard limiteverruns budgets create --subject-type agent --subject-id agent_01h9 --currency usd --limit 100 --soft-limit 80 --reason 'Monthly spend cap for the triage agent'budgets delete
Section titled “budgets delete”Delete a budget.
everruns budgets delete [OPTIONS] [BUDGET_ID]| Flag | Description |
|---|---|
--budget-id <BUDGET_ID> | Budget’s prefixed public identifier. |
Example:
# Remove a cap that no longer applieseverruns budgets delete bdgt_01h9 --reason 'Agent retired'budgets get
Section titled “budgets get”Get a single budget by ID.
everruns budgets get [OPTIONS] [BUDGET_ID]| Flag | Description |
|---|---|
--budget-id <BUDGET_ID> | Budget’s prefixed public identifier. |
Example:
# Inspect a budget's limit, balance and statuseverruns budgets get bdgt_01h9budgets list
Section titled “budgets list”List budgets. Filter by subject_type and subject_id.
everruns budgets list [OPTIONS]| Flag | Description |
|---|---|
--subject-id <SUBJECT_ID> | Only budgets on this subject’s prefixed public identifier. |
--subject-type <SUBJECT_TYPE> | Only budgets on this kind of subject (session, agent, user, org, …). |
Example:
# Find the budgets that apply to one agenteverruns budgets list --subject-type agent --subject-id agent_01h9budgets update
Section titled “budgets update”Update a budget limit, status, or metadata.
everruns budgets update [OPTIONS] --budget-id <budget_id>| Flag | Description |
|---|---|
--budget-id <BUDGET_ID> | Required. Budget’s prefixed public identifier. |
--limit <LIMIT> | Maximum number of items returned in this page. |
--metadata <METADATA> | Free-form metadata attached to this resource. |
--soft-limit <SOFT_LIMIT> | Replacement soft threshold, or null to remove it. |
--status <STATUS> | Current lifecycle status. |
Example:
# Raise a budget's hard limiteverruns budgets update --budget-id bdgt_01h9 --limit 150 --reason 'Higher volume expected'budgets ledger list
Section titled “budgets ledger list”List ledger entries for a budget.
everruns budgets ledger list [OPTIONS] --budget-id <budget_id>| Flag | Description |
|---|---|
--budget-id <BUDGET_ID> | Required. Budget’s prefixed public identifier (a path parameter). |
--limit <LIMIT> | Maximum number of items returned in this page. |
--offset <OFFSET> | Zero-based offset into the result set. |
Example:
# Audit what drew down a budget, newest entries firsteverruns budgets ledger list --budget-id bdgt_01h9 --limit 20budgets top-up top
Section titled “budgets top-up top”Add credits to a budget. Reactivates exhausted or paused budgets if balance becomes positive.
everruns budgets top-up top [OPTIONS] --amount <amount> --budget-id <budget_id>| Flag | Description |
|---|---|
--amount <AMOUNT> | Required. Credits to add, in the budget’s currency. |
--budget-id <BUDGET_ID> | Required. Budget’s prefixed public identifier. |
--description <DESCRIPTION> | Human-readable description. |
Example:
# Add credits to an exhausted budget so work can continueeverruns budgets top-up top --budget-id bdgt_01h9 --amount 25 --description 'Extra allowance for the launch week' --reason 'Launch week'