get_key_balance
Read-onlyIdempotent
FREE. Remaining allowance for an API key (free, card or metered): plan, quota, used, remaining, reset date and what the key covers. Never metered. Pass api_key, or send the key as the X-API-Key header on /mcp.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| api_key | No | API key. Optional when sent as the X-API-Key header on /mcp. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan | No | ||
| used | No | ||
| error | No | Present on a free refusal or error; no charge | |
| quota | No | ||
| covers | No | ||
| no_charge | No | ||
| price_usd | No | ||
| remaining | No | ||
| resets_on | No | ||
| disclaimer | No | ||
| how_to_pay | No | ||
| bind_series | No | ||
| explanation | No | ||
| x_next_bind | No | ||
| http_endpoint | No | ||
| payment_required | No | true when the call needs payment; how_to_pay explains x402 or card |