Prints OpenAI credit information in a terminal-friendly format.
Usage:
- npm start
- ./balance.mjs
- npx openai-balance
Options:
- -n, --nano-dollars: print the balance in nano dollars
- -c, --combined: print both USD and nano dollars
- -s, --summary: print the credit history table
- Short flags can be combined, like -sn or -cs.
- -n and -c cannot be used together.
- -v, --version: print the package.json version
- -j, --json: print the full API response as pretty JSON
- -h, --help: show a short help message
Configuration:
- ENDPOINT
- AUTH_HEADER
Precedence:
- Shell environment variables
- .env in the current working directory
- .env in the script directory
Example .env:
- ENDPOINT=https://api.openai.com/v1/dashboard/billing/credit_grants
- AUTH_HEADER=Bearer your-session-token-here
Output:
- Success: OpenAI credit balance: $10.16
- Combined: OpenAI credit balance: $10.16 (10,160,000,000n)
- Nano dollars: OpenAI credit balance: 10,160,000,000n
- Summary: a table of credit history rows
- Version: current package.json version
- JSON: pretty-printed API response body
- Auth failure: OpenAI credit balance: invalid bearer token
- Other errors: one-line OpenAI credit balance: ... message
- Invalid options: one-line OpenAI credit balance: invalid option(s): ...
The API response should include total_available or total_paid_available for balance mode, and grants.data for summary mode.