Mon-Fri 10am - 6pm
Balance
Base URL for your account: https://cpaas.studio
GET
/api/whatsapp/v1/balance
Your live plan and the allowance left per category, in ₹ and in whole messages (own pot, and with the shared pot).
No parameters.
Request example
curl -X GET "https://cpaas.studio/api/whatsapp/v1/balance" \
-H "X-API-KEY: cpk_xxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Success response (data)
{
"balance": {
"plan": {
"name": "Business 30",
"starts_at": "2026-10-01T00:00:00+00:00",
"expires_at": "2026-10-31T00:00:00+00:00",
"auto_renew": true
},
"currency": "INR",
"categories": [
{
"category": "marketing",
"enabled": true,
"remaining": 2700,
"rate": 1.35,
"messages_left": 2000,
"messages_left_with_shared": 2370,
"used_percent": 32.5
}
]
}
}
Notes
- A category with less than one message's rate left shows remaining ₹ but 0 messages.
Need more context? See Getting started for authentication, the response envelope, and the full error-code reference.