Overview
What Billing API does
Finance and ops teams often want wallet and plan data in their own dashboards. The Billing API exposes it read-only.
GET /api/billing returns the current subscription, per-channel wallet balances and usage counts. The full response also includes billing profile and payment-method summaries (card brand and last 4 only) — treat those as merchant PII and read only what you need.
GET /api/billing/plans lists available plans localized to the workspace’s billing country and currency.
Step by step
How it works
- 1
Create a billing-scoped key
In Settings → Developer API keys.
- 2
Poll the snapshot
GET /api/billing on a schedule.
- 3
Alert on thresholds
Notify your team when a wallet drops below your limit.
In the product
See it in action
Sample data shown for illustration.
Sample data shown for illustration.
Reference
Endpoints
/api/billingCurrent subscription, wallet and usage snapshot.
/api/billing/plansAvailable plans, localized to the workspace’s billing country and currency.
GET /api/billing
Authorization: Bearer nxk_live_your_key_here
{
"success": true,
"data": {
"subscription": { "planId": "growth", "status": "active", "billingCycle": "monthly" },
"wallets": {
"whatsapp": { "balance": 1250, "currency": "INR" },
"instagram": { "balance": 400, "currency": "INR" }
},
"usage": { "whatsapp": { "utility": 312, "marketing": 88 } }
}
}Before you start
Good to know
- Billing changes (upgrades, top-ups) are made in the dashboard, not through the API.
Nexlerate Technologies Pvt LtdParent company, NexlerAI
Nexlerate Technologies Pvt Ltd is the parent company and engineering team behind NexlerAI. The company builds on the official WhatsApp Cloud API, Meta’s Instagram and Messenger platforms, and the Shopify app ecosystem, and writes these guides from how the product works today.