SimpliSend Developers
Get an API key
GET/public/balance

Check balance

Returns the account's current SMS credit balance. Requires the sms.send or sms.read scope.

Example request

curl
curl https://app.simplisend.co.za/api/v1/public/balance \
  -H "X-API-Key: YOUR_API_KEY"

Response - 200 OK

{
  "smsBalance": 4820
}
FieldTypeDescription
smsBalanceintegerRemaining SMS credits available to send.

* required

Keeping an integration from failing silently

A send call returns 402 PAYMENT_REQUIRED once the balance hits zero rather than sending a message you weren't charged for. If your integration sends at volume, it's worth checking this endpoint proactively (e.g. before a large batch) rather than only reacting to a 402 mid-run.