Balance, usage and your prices (free)
get_balanceCheck your account balance, month-to-date usage, and actual per-operation prices for free. Use it before paid work to budget and after to report spending accurately.
Instructions
Account balance, month-to-date usage and THIS account's real per-operation prices. FREE — this call never spends credits. balance_usd is the wallet; grants_usd is bonus and plan credit (sign-up bonus, perks, plan allowance), reported apart. Grants are spent first, but only on the operations each one covers: a promo perk or a plan allowance may not pay for API calls, and a perk never pays for phone numbers. Report both figures; do not add them up as what the user can spend. Call it before a batch of paid work (so you can tell the user what they can afford) and after (so you can report exactly what was spent). The prices it returns beat any number in a tool description — those are list prices.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| timeout_ms | No | Request timeout in milliseconds. | |
| include_usage | No | Also return the month-to-date credit usage broken down by operation type. Free. | |
| include_prices | No | Include this account's per-operation prices. Default true. | |
| include_transactions | No | Also return the N most recent transactions (each shows the operation type and dollar amount). | |
| include_token_analytics | No | Also return per-API-token request counts for the last 30 days (by endpoint and status). Free. Useful for answering "which integration is making these calls?". |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cost | No | ||
| No | |||
| usage | No | ||
| test_mode | No | ||
| grants_usd | No | ||
| balance_usd | No | ||
| preview_tier | No | ||
| prices_source | No | ||
| token_analytics | No | ||
| your_prices_usd | No | ||
| test_mode_notice | No | ||
| recent_transactions | No | ||
| used_this_month_usd | No | ||
| vocabulary_warnings | No | ||
| deprecated_params_ignored | No |