Billing

1 endpoints in this family.

See what this month will cost

GET/api/v1/billing/summary

Returns this month's bill so far for your account: your plan, the WhatsApp numbers connected against those included, the messages included and used, the media storage used, and the estimated total.

A connected number is an active, non-test WhatsApp number of any of your clients. Messages are counted across the account: every message received or sent, templates included, test channels excluded. Beyond the allowance, a plan either bills each started block of eventsPerOverageUnit messages, up to the overage cap you set (capCents), or blocks sends until the month ends (blocking, error quota_exceeded).

The total is an estimate before tax; the invoice is the reference. Meta's messaging fees are never included: your clients pay them to Meta directly.

Response

This month's plan, numbers, messages, media and estimated total.

data.planobject
Your plan: key, name, nameEn. null when no plan applies.
data.numbersobject
Connected numbers: connected, included (null = no limit), extra (billed), priceCents (per extra number per month).
data.messagesobject
Messages: allowance (null = no quota), used, overageUnits (billed blocks), overagePriceCents, eventsPerOverageUnit, blocking, capCents (your overage cap), ceiling (where sends stop).
data.mediaobject
Media storage: usedMb, includedMb (null = no quota), extraGb (billed), priceCents (per extra GB per month).
data.basePriceCentsinteger
The fixed monthly price, in cents. null for a custom plan.
data.estimatedTotalCentsinteger
The estimated total so far, in cents, before tax.
data.currencystring
ISO 4217 currency code.
data.periodEndstring
When the month ends (UTC, ISO 8601): the allowance resets and the invoice is issued.

curl https://nodium.io/api/v1/billing/summary \ -H "Authorization: Bearer $NODIUM_KEY"

Response

200 OK

{  "data": {    "plan": {},    "numbers": {},    "messages": {},    "media": {},    "basePriceCents": 0,    "estimatedTotalCents": 0,    "currency": "EUR",    "periodEnd": "…"  }}