> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# deepline billing

> See your plan and credits, buy more, and manage billing.

## billing

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing [options] [command]

See your plan and credits, buy more, and manage billing.

Options:
  -h, --help                             display help for command

Commands:
  quote [options]                        Quote a sandbox session in Deepline credits; excludes provider tools and Customer DB compute.
  balance [options]                      Show current billing balance.
  usage [options]                        Show current usage plus recent calls.
  limit [options]                        Show configured monthly usage cap.
  set-limit [options] <credits>          Set monthly usage cap.
  off [options]                          Disable monthly usage cap.
  ledger                                 Inspect and export billing ledger rows.
  history [options]                      Export billing ledger history to CSV.
  checkout [options]                     Create a checkout session and optionally open it in your browser.
  top-up [options] <credits>             Charge the saved payment method and add Deepline credits.
  buy [options] <credits>                Buy credits through the target billing contract.
  top-up-recover [options] <credits>     Inspect or retire an original top-up intent without starting a payment.
  status [options]                       Show plan, payment, and recharge state; use usage for charges.
  entitlements [options]                 Show workspace benefits, remaining people search profiles, and effective rate limits.
  compute [options]                      Show Play compute pricing and minutes used; --enable turns on included compute.
  auto-recharge                          Inspect and manage automatic Deepline credit recharge.
  change-plan [options] <plan_sku>       Start or change the target billing plan.
  cancel-plan [options]                  Cancel a target subscription at period end, or undo it.
  portal [options]                       Open the Stripe-hosted billing recovery portal.
  plans [options]                        Show published plans and the plan you are on.
  subscribe [options] <plan_version_id>  Start a subscription checkout for a plan and optionally open it in your browser.
  subscription                           Inspect and manage subscription state for the workspace.
  invoices [options]                     List subscription invoices and credit purchase receipts.
  redeem-code [options]                  Redeem a billing code.
  help [command]                         display help for command
```

## billing quote

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing quote [options]

Quote a sandbox session in Deepline credits; excludes provider tools and
Customer DB compute.

Options:
  --sandbox-timeout <duration>  Runtime timeout, such as 30m or 2h
  --sandbox-size <size>         Runtime memory profile (choices: "standard",
                                "large", "xlarge", "1gb", "4gb", "8gb", default:
                                "standard")
  --quantity <sessions>         Number of sandbox sessions (default: "1")
  --json                        Emit the bounded component quotation as JSON
  -h, --help                    display help for command
```

## billing balance

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing balance [options]

Show current billing balance.

Options:
  --json      Emit the full balance record as JSON
  --verbose   Add reservations and usage awaiting settlement
  -h, --help  display help for command
```

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Explanation:
  Purpose:
    Read the workspace's current Deepline credit balance.
  When:
    Once at the start of a task, before the first paid call, and after a run
    reports a balance or insufficient-credits error.
  Input:
    No arguments. Prints the posted balance, spendable credits and pending
    spending. --verbose adds exposure details; --json returns the full record.
  Output (JSON):
    balance (Deepline credits), balance_display, rough_usd_balance,
    balance_status, posted_balance_credits, pending_spend_credits,
    spendable_balance_credits, spendable_balance_status and render.sections.
    The three credit amounts come from the same admission snapshot. Spendable
    credits subtract pending spending; a partial exposure diagnostic is not
    spendable capacity. Null/unavailable means complete capacity could not be read.
    Spending limits can still block a funded call. The balance includes other activity
    in the workspace, so a before and after difference does not isolate one
    command; use billing usage for that.
  Cost:
    Free.
```

## billing usage

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing usage [options]

Show current usage plus recent calls.

Options:
  --events               Read a raw usage-event page instead of the billing
                         summary
  --recent-only          Read recent billing activity without spend totals
  --limit <n>            Page size (1–500 with --events)
  --offset <n>           Recent-call offset
  --cursor <cursor>      Recent-call cursor from the previous response
  --run-id <run_id>      Show recent usage for one play run
  --request-id <job_id>  Show the exact Deepline charge for one execution job_id
  --json                 Emit JSON output
  -h, --help             display help for command
```

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Explanation:
  Purpose:
    Read what the workspace, or one run, has spent in Deepline credits.
  When:
    After a run finishes, to report its actual cost: billing usage --run-id
    <run-id>. This is the canonical per-run cost read; runs get does not
    include cost unless you pass --full.
  Input:
    --run-id <run-id> scopes the spend to one play run. --limit and --cursor
    page the recent-call list. --json prints JSON.
    --recent-only returns just the recent billing activity page and workspace ID.
    --events reads raw usage-event history instead of the spend summary. Combine
    it with --run-id, --limit (1–500), and --cursor; not --offset or --request-id.
    Follow next_cursor until null, even when entries is empty.
  Output (JSON):
    balance, usage.last_30_days_usage_credits, usage.month_spent_credits, and
    with --run-id: run.spent_credits, run.rough_usd_spent, run.event_count.
    render.sections includes a "Run spend: N Deepline Credits" line.
    With --events: org_id, run_id, entries, next_cursor, and next.page. Entries
    retain original run attribution and nullable recorded Deepline credits;
    raw event history is not final settlement evidence.
  Cost:
    Free.
  Avoid:
    Do not grep a runs get payload for cost; use this command.

  Output fields:
    balance, balance_display, rough_usd_balance   credits available now.
    plan.usd_per_credit                            conversion used for rough USD.
    usage.month_spent_credits                      spend in the current period.
    usage.last_30_days_usage_credits               trailing-30-day spend.
    usage.temporary_hold_credits                   credits held by active runs.
    run (only with --run-id)                       {run_id, spent_credits,
                                                    rough_usd_spent, event_count};
                                                    null when the run has no
                                                    billing events yet.
    quota.*                                        monthly cap, when enabled.
    recent activity                                one line per billed call in
                                                    render.sections, newest first.
  Cases:
    A run that is still active shows a partial spend; read it again after the
    run reaches completed or failed.
    A failed run with row failures still shows spend for the rows that ran.
```

## billing limit

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing limit [options]

Show configured monthly usage cap.

Options:
  --json      Emit JSON output
  -h, --help  display help for command
```

## billing set-limit

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing set-limit [options] <credits>

Set monthly usage cap.

Arguments:
  credits     Monthly credits limit

Options:
  --json      Emit JSON output
  -h, --help  display help for command
```

## billing off

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing off [options]

Disable monthly usage cap.

Options:
  --json      Emit JSON output
  -h, --help  display help for command
```

## billing ledger

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing ledger [options] [command]

Inspect and export billing ledger rows.

Options:
  -h, --help      display help for command

Commands:
  export          Export billing ledger rows.
  help [command]  display help for command
```

## billing ledger export

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing ledger export [options] [command]

Export billing ledger rows.

Options:
  -h, --help      display help for command

Commands:
  all [options]   Export all available billing ledger rows to CSV.
  help [command]  display help for command
```

## billing ledger export all

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing ledger export all [options]

Export all available billing ledger rows to CSV.

Options:
  --output <path>      Write CSV to an explicit path
  --run-id <run_id>    Export ledger rows for one play run.
  --operation <id>     Export rows for one tool operation.
  --since <timestamp>  Only export rows since ISO-8601 time or Unix
                       milliseconds.
  --json               Emit JSON output
  -h, --help           display help for command
```

## billing history

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing history [options]

Export billing ledger history to CSV.

Options:
  --time <window>  Rolling time window: 1d, 1w, 1m, or 1y
  --json           Emit JSON output
  -h, --help       display help for command
```

## billing checkout

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing checkout [options]

Create a checkout session and optionally open it in your browser.

Options:
  --tier <tierId>         Named pricing tier
  --credits <credits>     Custom credit amount
  --discount-code <code>  Apply a discount code
  --no-open               Print the checkout URL without opening a browser
  --json                  Emit JSON output
  -h, --help              display help for command
```

## billing top-up

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing top-up [options] <credits>

Charge the saved payment method and add Deepline credits.

Arguments:
  credits                  Positive integer Deepline credit amount

Options:
  --idempotency-key <key>  Stable retry key for the same intended top-up (1–200
                           characters, no padding, valid HTTP header text)
  --dry-run                Print the planned top-up without charging
  --compact                Keep only high-signal fields in JSON output
  --json                   Emit JSON output
  -h, --help               display help for command
```

## billing buy

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing buy [options] <credits>

Buy credits through the target billing contract.

Arguments:
  credits                  Positive integer Deepline credit amount

Options:
  --idempotency-key <key>  Stable retry key
  --json                   Emit JSON output
  -h, --help               display help for command
```

## billing top-up-recover

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing top-up-recover [options] <credits>

Inspect or retire an original top-up intent without starting a payment.

Arguments:
  credits                           Original positive integer Deepline credit
                                    amount

Options:
  --org-id <original-org>           Original workspace ID (must match the
                                    authenticated workspace)
  --idempotency-key <original-key>  Original purchase key; never generates a new
                                    key
  --dry-run                         Print the recovery request without changing
                                    state
  --json                            Emit JSON output
  -h, --help                        display help for command
```

## billing status

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing status [options]

Show plan, payment, and recharge state; use usage for charges.

Options:
  --json      Emit JSON output
  -h, --help  display help for command
```

## billing entitlements

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing entitlements [options]

Show workspace benefits, remaining people search profiles, and effective rate
limits.

Options:
  --json      Emit JSON output
  -h, --help  display help for command
```

## billing compute

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing compute [options]

Show Play compute pricing and minutes used; --enable turns on included compute.

Options:
  --enable    Turn on included compute for this workspace (cannot be undone)
  --json      Emit JSON output
  -h, --help  display help for command
```

## billing auto-recharge

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing auto-recharge [options] [command]

Inspect and manage automatic Deepline credit recharge.

Options:
  -h, --help         display help for command

Commands:
  status [options]   Show the canonical automatic recharge configuration.
  set [options]      Enable automatic recharge with a threshold and refill
                     target.
  off [options]      Disable automatic recharge without clearing saved amounts.
  trigger [options]  Evaluate capped automatic recharge and resume any pending
                     purchase.
  help [command]     display help for command
```

## billing auto-recharge status

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing auto-recharge status [options]

Show the canonical automatic recharge configuration.

Options:
  --json      Emit JSON output
  -h, --help  display help for command
```

## billing auto-recharge set

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing auto-recharge set [options]

Enable automatic recharge with a threshold and refill target.

Options:
  --threshold-credits <credits>       Recharge when the balance reaches this
                                      amount
  --refill-to-credits <credits>       Recharge the balance to this amount
  --purchase-limit-credits <credits>  Limit automatic credit purchases over
                                      rolling 30 days (or none to remove)
  --idempotency-key <key>             Stable retry key
  --dry-run                           Print the planned update without applying
                                      it
  --json                              Emit JSON output
  -h, --help                          display help for command
```

## billing auto-recharge off

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing auto-recharge off [options]

Disable automatic recharge without clearing saved amounts.

Options:
  --idempotency-key <key>  Stable retry key
  --dry-run                Print the planned update without applying it
  --json                   Emit JSON output
  -h, --help               display help for command
```

## billing auto-recharge trigger

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing auto-recharge trigger [options]

Evaluate capped automatic recharge and resume any pending purchase.

Options:
  --json      Emit JSON output
  -h, --help  display help for command
```

## billing change-plan

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing change-plan [options] <plan_sku>

Start or change the target billing plan.

Arguments:
  plan_sku                 payg-v1, builder-v1, growth-v1, or team-v1

Options:
  --billing-email <email>  Invoice recipient when the account has no billing
                           email
  --idempotency-key <key>  Stable retry key
  --json                   Emit JSON output
  -h, --help               display help for command
```

## billing cancel-plan

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing cancel-plan [options]

Cancel a target subscription at period end, or undo it.

Options:
  --undo                   Undo a pending period-end cancellation
  --idempotency-key <key>  Stable retry key
  --json                   Emit JSON output
  -h, --help               display help for command
```

## billing portal

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing portal [options]

Open the Stripe-hosted billing recovery portal.

Options:
  --billing-address  Open the billing address editor directly
  --no-open          Print the URL without opening a browser
  --json             Emit JSON output
  -h, --help         display help for command
```

## billing plans

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing plans [options]

Show published plans and the plan you are on.

Options:
  --json      Emit JSON output
  -h, --help  display help for command
```

## billing subscribe

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing subscribe [options] <plan_version_id>

Start a subscription checkout for a plan and optionally open it in your browser.

Arguments:
  plan_version_id  Legacy billing plan version id

Options:
  --no-open        Print the checkout URL without opening a browser
  --json           Emit JSON output
  -h, --help       display help for command
```

## billing subscription

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing subscription [options] [command]

Inspect and manage subscription state for the workspace.

Options:
  -h, --help        display help for command

Commands:
  status [options]  Show active plan, subscription state, and credit pools.
  cancel [options]  Cancel the subscription at period end. Credits are kept.
  help [command]    display help for command
```

## billing subscription status

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing subscription status [options]

Show active plan, subscription state, and credit pools.

Options:
  --json      Emit JSON output
  -h, --help  display help for command
```

## billing subscription cancel

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing subscription cancel [options]

Cancel the subscription at period end. Credits are kept.

Options:
  --undo      Reverse a pending cancellation before period end
  --dry-run   Print the planned cancellation without calling the cancel endpoint
  --json      Emit JSON output
  -h, --help  display help for command
```

## billing invoices

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing invoices [options]

List subscription invoices and credit purchase receipts.

Options:
  --limit <n>  Maximum entries to return (1-100, default 24)
  --compact    Keep only id, date, amount, status, and url
  --json       Emit JSON output
  -h, --help   display help for command
```

## billing redeem-code

```text theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
Usage: deepline billing redeem-code [options]

Redeem a billing code.

Options:
  --code <code>  Code to redeem
  --no-open      Do not open a browser
  --json         Emit JSON output
  -h, --help     display help for command
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.