Balance

See how many SMS units your organisation has left.

GEThttps://api.cloudmetis.com/v1/sms/balancescope: wallet:read

Request

curl https://api.cloudmetis.com/v1/sms/balance \
  -H "Authorization: Bearer cm_live_your_key"

Response (200)

{"units_available": 4937, "sandbox": false}

Field	Description
units_available	Whole SMS units left. One unit sends one SMS part to one number.
sandbox	true for test keys, which always report 1000

You don't need to check the balance before every send — send requests check it for you and return 402 insufficient_units without sending anything if it is too low. Use this endpoint for dashboards and low-balance alerts in your own system.

Units are bought in the CloudMetis app. See SMS units.