Skip to main content
GET
/
api
/
billing
/
sms
/
balance
Get SMS Balance
curl --request GET \
  --url https://api.example.com/api/billing/sms/balance/
{
  "balance": {
    "credits": 1000,
    "currency": "USD",
    "last_updated": "2025-11-27T10:30:00Z"
  },
  "usage": {
    "used_this_month": 500,
    "remaining": 500
  }
}
Get current SMS balance and usage information.
Requires authentication. Include the access token in the Authorization header.

​
Success Response (200)

​
balance
object
Balance information object
​
balance.credits
integer
Current SMS credits
​
balance.currency
string
Currency code
​
balance.last_updated
string
Last update timestamp (ISO 8601)
​
usage
object
Usage information object
​
usage.used_this_month
integer
SMS credits used this month
​
usage.remaining
integer
Remaining SMS credits
{
  "balance": {
    "credits": 1000,
    "currency": "USD",
    "last_updated": "2025-11-27T10:30:00Z"
  },
  "usage": {
    "used_this_month": 500,
    "remaining": 500
  }
}