getAccountBalance
Check your organization's wallet balance, plan, concurrency headroom, and auto-recharge status before campaigns to avoid failed calls from insufficient credit.
Instructions
Read your organization's wallet: the remaining balance, the minutes it buys at your rates, your plan, your concurrency headroom, and whether auto-recharge will refill it.
Use it before a campaign, or on a schedule, so you find out you are
low on credit from this endpoint rather than from a call failing
with 402 payment_required.
The response always describes the organization the API key belongs to. There is no parameter for reading another account; resellers read a client's figures through the Reseller endpoints.
A balance at or below zero does not always mean calls will stop. An
organization on usage-based billing (plan.is_usage_based) keeps
placing calls and is metered to its payment method instead, so check
that flag before treating a zero balance as a stop condition.
The API key's user needs Billing access in your organization. If
you get a 403, an administrator can grant it when Billing is
enabled for your organization; when it is not, contact support.
(Tags: Account)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||