Get balance
get_balanceUse when you need the Customer's prepaid Credits before spending: the balance plus each Grant (such as the Starter Grant) with its Credits left and expiry. Not for past charges: use get_usage. For one call's price, pass estimate=true to that tool. Price: Free. Grants are spent first.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_balance"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| grants | No | Unexpired Grants with Credits left, soonest expiry first. | |
| balance_credits | No | The spendable Balance in Credits: active Grants included, an expired Grant's leftover never. |