get_balance
Retrieve the prepaid account balance, low-balance threshold, available top-up amounts, auto top-up setting and billing status to monitor proof request eligibility and prevent balance-empty refusals.
Instructions
Get the prepaid balance (in euro cents and mills), the low-balance threshold, the top-up amounts on offer and the auto top-up setting. Proofs past the plan's included amount are drawn from this balance; once billing is live, an account whose balance is at or below zero is refused new proof requests (402 balance_empty) until it tops up. billing_enabled says whether billing is live. Topping up and changing auto top-up are done by the owner in the dashboard.
ACCESS: needs a Proof account. Set PROOF_API_KEY and restart this server, then call this tool again. start_login does NOT open this tool.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| balance | Yes | ||
| auto_top_up | Yes | ||
| top_up_amounts | Yes | The top-up amounts on offer, in euros. | |
| billing_enabled | Yes | Whether billing is live. While it is off, nothing is drawn from the balance and nothing is paused. | |
| low_balance_threshold | Yes | The balance in euro cents below which the owner is sent a low-balance notice. |