credits:balance
Read balance_cents, balance_dollars and lifetime_purchased_cents, lifetime_gifted_cents and lifetime_spent_cents; all are 0 when you have no credit record. Credits pay for managed compute and the model-backed exports export:summary, export:summary:stream and export:summary:pdf.
Reference for flywheel credits:balance.
Command Group
Account & Credits Commands
Summary
Read balance_cents, balance_dollars and lifetime_purchased_cents, lifetime_gifted_cents and lifetime_spent_cents; all are 0 when you have no credit record. Credits pay for managed compute and the model-backed exports export:summary, export:summary:stream and export:summary:pdf.
Effect
read-only
Usage
flywheel credits:balance [FLAGS]Required flags
None.
Optional flags
| Flag | Value | Default | Choices | Description |
|---|---|---|---|---|
--format | FORMAT | json, tsv, csv, table | Output format for command results. | |
--env | PROFILE | Select a CLI profile; unconfigured default requires FLYWHEEL_BASE_URL. | ||
--out | PATH | Write output to a file path, or use - for stdout. | ||
--open | Open browser-bound URLs when supported. | |||
--no-retry | Disable transient-error retries. | |||
--retry-max | N | Maximum transient-error retry attempts. | ||
--wait | Block on async operations until a terminal state is reached. | |||
--wait-timeout | SECONDS | 600 | Seconds to wait for --wait before timing out. Defaults to 600. | |
--allow-self | Allow mutating the currently active credential. | |||
--timeout | SECONDS | Set the per-request timeout budget in seconds. | ||
--idempotency-key | KEY | Reuse an Idempotency-Key so ambiguous write failures can be retried with the same key. | ||
--force | Force safety-gated operations where supported. | |||
--yes | Confirm forced compute:release-all --force. Other runtime commands do not read --yes. | |||
--debug | Print structured request debugging with secrets masked. | |||
--verbose | Print verbose progress for long-running operations. | |||
-h, --help | Show this help. |
Examples
Check balance.
flywheel credits:balanceOutput
Default format: json.
| Field | Type |
|---|---|
balance_cents | integer |
balance_dollars | number |
lifetime_purchased_cents | integer |
lifetime_gifted_cents | integer |
lifetime_spent_cents | integer |
account:merge:proof
Mint a merge proof token from a source session token. Requires a browser session; API-key callers receive session_auth_required with /app?settings=user.
credits:billing-portal
Open the Stripe billing portal for the current user and return browser_flow_required JSON with url, opened, and next_action.