Account

Get the balance

Your SMS balance, its currency, and whether the account is in test mode.

GEThttps://api.falconzo.com/v1/sms/balance

A send that costs more than the balance is refused with 402 and nothing is sent.

testMode is true until one of your sender IDs is verified. Live keys then only text your verified test numbers.

Permission

The API key needs balance.read (read the sms balance). Without it the answer is 403 MISSING_SCOPE.

Request

curl -X GET "https://api.falconzo.com/v1/sms/balance" \
  -H "Authorization: Bearer fz_test_YOUR_KEY"

Response

{
  "data": {
    "enabled": true,
    "balance": "1240.00",
    "currency": "LKR",
    "testMode": false
  }
}