Skip to main content

Get your account balance

GET 
/api/v1/balance

Returns your account credit. Three amounts, and the one that matters is available:

  • balance — what sits in your wallet.
  • reserved — credit held by calls currently in progress. Each live call holds an estimate up front; the hold is released and replaced by the real cost when the call ends.
  • available — balance minus reserved, floored at zero. This is what you can commit to a new campaign.

Reading balance alone would overstate what you can spend: with 1000 in the wallet and 300 held by a running campaign, you can only commit 700.

Amounts carry four decimal places. Credit is checked call by call, so keeping an eye on available before launching a large campaign is the way to avoid it stalling halfway through — and the low_credit notification tells you when the balance crosses your alert threshold.

This endpoint needs no capability: every account has a wallet and is billed, so you can always read your own balance.

Responses​

Your account credit.