Skip to content
Everruns Cloud is open in early access. Run agents without operating the platform.

Spending limits for sessions, agents, users and organizations.

CommandWhat it does
budgets checkCheck budget status for a session-scoped budget.
budgets createCreate a budget for a subject (session, agent, user, org).
budgets deleteDelete a budget.
budgets getGet a single budget by ID.
budgets listList budgets.
budgets updateUpdate a budget limit, status, or metadata.
budgets ledger listList ledger entries for a budget.
budgets top-up topAdd credits to a budget.

Check budget status for a session-scoped budget.

Terminal window
everruns budgets check [OPTIONS] --budget-id <budget_id>
FlagDescription
--budget-id <BUDGET_ID>Required. Budget’s prefixed public identifier.

Example:

Terminal window
# Check whether a budget still has room before starting expensive work
everruns budgets check --budget-id bdgt_01h9

Create a budget for a subject (session, agent, user, org). Sets a spending cap in the given currency.

Terminal window
everruns budgets create [OPTIONS] --currency <currency> --limit <limit> --subject-id <subject_id> --subject-type <subject_type>
FlagDescription
--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:

Terminal window
# Cap an agent's spend with an early warning before the hard limit
everruns budgets create --subject-type agent --subject-id agent_01h9 --currency usd --limit 100 --soft-limit 80 --reason 'Monthly spend cap for the triage agent'

Delete a budget.

Terminal window
everruns budgets delete [OPTIONS] [BUDGET_ID]
FlagDescription
--budget-id <BUDGET_ID>Budget’s prefixed public identifier.

Example:

Terminal window
# Remove a cap that no longer applies
everruns budgets delete bdgt_01h9 --reason 'Agent retired'

Get a single budget by ID.

Terminal window
everruns budgets get [OPTIONS] [BUDGET_ID]
FlagDescription
--budget-id <BUDGET_ID>Budget’s prefixed public identifier.

Example:

Terminal window
# Inspect a budget's limit, balance and status
everruns budgets get bdgt_01h9

List budgets. Filter by subject_type and subject_id.

Terminal window
everruns budgets list [OPTIONS]
FlagDescription
--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:

Terminal window
# Find the budgets that apply to one agent
everruns budgets list --subject-type agent --subject-id agent_01h9

Update a budget limit, status, or metadata.

Terminal window
everruns budgets update [OPTIONS] --budget-id <budget_id>
FlagDescription
--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:

Terminal window
# Raise a budget's hard limit
everruns budgets update --budget-id bdgt_01h9 --limit 150 --reason 'Higher volume expected'

List ledger entries for a budget.

Terminal window
everruns budgets ledger list [OPTIONS] --budget-id <budget_id>
FlagDescription
--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:

Terminal window
# Audit what drew down a budget, newest entries first
everruns budgets ledger list --budget-id bdgt_01h9 --limit 20

Add credits to a budget. Reactivates exhausted or paused budgets if balance becomes positive.

Terminal window
everruns budgets top-up top [OPTIONS] --amount <amount> --budget-id <budget_id>
FlagDescription
--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:

Terminal window
# Add credits to an exhausted budget so work can continue
everruns budgets top-up top --budget-id bdgt_01h9 --amount 25 --description 'Extra allowance for the launch week' --reason 'Launch week'