HostMentor Docs

Retrieve your message credit balance

GEThttps://wa.hostmentor.com/v3/{phone_number_id}/balance

Returns the message credit left on the number your key is for, in your wallet's currency (INR or USD). Each number has its own wallet; top it up on the dashboard on the number's Credit page.

The balance is refreshed at most once a minute, so polling faster returns the same value. updated_at says when it was last read.

It works even when the number's API plan has lapsed or the number is suspended, so you can always see what credit is left.

Authorization

apiKey
apikey<token>

Your HostMentor API key, from the dashboard under Messaging → WhatsApp → API keys.

In: header

Path Parameters

phone_number_id*string

ID of your WhatsApp number, from the dashboard or List your phone numbers. It isn't the phone number itself.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://wa.hostmentor.com/v3/106540352242922/balance" \  -H "apikey: YOUR_API_KEY"
{  "phone_number_id": "106540352242922",  "currency": "INR",  "balance": {    "value": 153000,    "offset": 100  },  "updated_at": "2026-09-30T10:00:00.000Z",  "stale": false}