Skip to main content

octopus balance list

octopus balance list​

List balance shards for an account

Synopsis​

Show the available and held balance per shard for each purpose.

Looks the account up by UUID by default; use --by external-ref to look it up by external reference.

octopus balance list <identifier> [flags]

Examples​

octopus balance list 019d8880-1e46-... --tenant acme-bank
octopus balance list A0000000-0000-0000-0000-000000000001 --by external-ref --tenant acme-bank
octopus balance list A0000000-... --by external-ref -o json --tenant acme-bank

Options​

      --by string   Lookup field: id, external-ref (default "id")
  -h, --help        help for list

Options inherited from parent commands​

  -c, --correlation string       Correlation ID for request tracing (UUID, auto-generated if omitted)
  -g, --global                   Shorthand for --tenant global
  -i, --idempotency-key string   Idempotency key for exactly-once execution (UUID, auto-generated per operation if omitted)
  -o, --output string            Output format: human, json (default "human")
  -p, --profile string           Override active config profile for this command.
  -t, --tenant string            Tenant code. Overrides default_tenant from config.
  -v, --verbose                  Enable verbose output

SEE ALSO​