Cargo CLI — Billing

Billing and credit management: pulling usage metrics, checking subscription status, viewing invoices, and managing credits.

See references/response-shapes.md for full JSON response structures. See references/troubleshooting.md for common errors and how to fix them. See references/examples/usage-metrics.md for usage metric and subscription examples.

Prerequisites

See ../cargo/references/prerequisites.md for install, login (--oauth / --token), JSON output conventions, and error shapes. Verify the session with cargo-ai whoami before running any of the commands below.

Admin-only: every command in this skill requires a token with admin access on the workspace. Non-admin tokens return {"errorMessage":"forbidden"}.

Discover resources first

Usage metrics can be filtered and grouped by resource UUID. Discover them before querying.

cargo-ai orchestration play list            # all plays (name, workflowUuid)
cargo-ai orchestration tool list            # all tools (name, workflowUuid)
cargo-ai ai agent list                     # all agents (uuid, name)
cargo-ai connection connector list          # all connectors (uuid, name, integrationSlug)
cargo-ai storage model list                # all models (uuid, name, slug)

Quick reference

cargo-ai billing usage get-metrics --from \x3CYYYY-MM-DD> --to \x3CYYYY-MM-DD>
cargo-ai billing usage get-metrics --from \x3CYYYY-MM-DD> --to \x3CYYYY-MM-DD> --group-by workflow_uuid
cargo-ai billing subscription get
cargo-ai billing subscription get-invoices
cargo-ai billing subscription create-portal-session

Estimating cost before running a batch

Before triggering a large batch, estimate credit consumption to avoid unexpected charges.

Step 1 — Check current credit balance:

cargo-ai billing subscription get
# → subscriptionAvailableCreditsCount - subscriptionCreditsUsedCount = remaining credits

Step 2 — Estimate cost from a sample run:

Run the workflow on a single record first and measure credits consumed:

# Run on one record
cargo-ai orchestration run create --workflow-uuid \x3Cuuid> --data '{...}'
# → poll to completion

# Check credits used for that run
cargo-ai billing usage get-metrics \
  --from \x3Ctoday> --to \x3Ctoday> \
  --workflow-uuid \x3Cuuid>
# → .totalUsage = credits consumed today for this workflow

Step 3 — Project batch cost:

estimated_cost = credits_per_record × number_of_records

Compare against subscriptionAvailableCreditsCount - subscriptionCreditsUsedCount before proceeding.

Step 4 — Monitor during the batch:

# Check running costs mid-batch
cargo-ai billing usage get-metrics \
  --from \x3Cstart-date> --to \x3Ctoday> \
  --workflow-uuid \x3Cuuid>

Cost levers:

Usage metrics

Pull credit and usage data for any time range, optionally filtered and grouped.

# Basic usage for a period
cargo-ai billing usage get-metrics --from \x3Cstart-date> --to \x3Cend-date>

# Group by dimension
cargo-ai billing usage get-metrics --from \x3Cstart-date> --to \x3Cend-date> --group-by workflow_uuid
cargo-ai billing usage get-metrics --from \x3Cstart-date> --to \x3Cend-date> --group-by connector_uuid
cargo-ai billing usage get-metrics --from \x3Cstart-date> --to \x3Cend-date> --group-by integration_slug
cargo-ai billing usage get-metrics --from \x3Cstart-date> --to \x3Cend-date> --group-by model_uuid
cargo-ai billing usage get-metrics --from \x3Cstart-date> --to \x3Cend-date> --group-by agent_uuid

# Filter by specific resource
cargo-ai billing usage get-metrics --from \x3Cstart-date> --to \x3Cend-date> --workflow-uuid \x3Cuuid>
cargo-ai billing usage get-metrics --from \x3Cstart-date> --to \x3Cend-date> --agent-uuid \x3Cuuid>
cargo-ai billing usage get-metrics --from \x3Cstart-date> --to \x3Cend-date> --connector-uuid \x3Cuuid>
cargo-ai billing usage get-metrics --from \x3Cstart-date> --to \x3Cend-date> --integration-slug \x3Cslug>

# Specify unit
cargo-ai billing usage get-metrics --from \x3Cstart-date> --to \x3Cend-date> --unit credits

--group-by values: workflow_uuid, connector_uuid, model_uuid, integration_slug, agent_uuid.

Available filters: --workflow-uuid, --model-uuid, --connector-uuid, --integration-slug, --slug, --agent-uuid. Combine with --group-by and --unit.

Subscription and credits

cargo-ai billing subscription get                    # current plan, credits used/available, period dates
cargo-ai billing subscription get-invoices            # invoice history (amounts in cents)
cargo-ai billing subscription get-credit-card         # card on file
cargo-ai billing subscription create-portal-session   # Stripe portal URL for self-service billing

Remaining credits = subscriptionAvailableCreditsCount - subscriptionCreditsUsedCount from subscription get.

Note: Invoice amounts are returned in cents. Divide by 100 for the dollar value.

Help

Every command supports --help:

cargo-ai billing usage get-metrics --help
cargo-ai billing subscription get --help
cargo-ai billing subscription get-invoices --help