Balance, usage and your prices (free)
get_balanceRetrieve account wallet balance, separate bonus and plan grants, month-to-date usage, and account-specific per-operation prices to check spend before or after paid API work.
Instructions
Account balance, month-to-date usage and this account's own 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, so the two figures do not add up to what the account can spend. Useful before a batch of paid work (what the user can afford) and after it (what was spent). These are the account's real rates; prices in tool descriptions 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 |