Balance & pricing
Sending consumes credit from your account balance. Routeon does not expose a public per-country rate card over the API — your rates are agreed with your account manager. What the API does give you is your current balance and the actual cost of each message after it is sent.
Balance
GET /balance returns the account balance (Alaris GET:balance). It is an attribute of the account, not a separate agreement ledger.
{
"balanceId": 34,
"name": "Main",
"amount": 12345.67,
"currency": "USD"
}
| Field | Meaning |
|---|---|
balanceId |
Identifier of the account balance ledger. |
name |
Human-readable balance name. |
amount |
Current available funds. |
currency |
ISO currency of the amount. |
Check the balance before a large campaign — an empty or insufficient balance causes sends to be rejected (see FAQ and errors).
What a message costs
Cost is reported after the fact, in two places:
- Per-message
cost— included in themessageStatuswebhook payload on terminal statuses (delivered,failed, …). It is the billed amount for that single message in the account currency. rateandfinalCostper EDR row — returned byGET /edrs:rate/finalCost— the amount charged for that message, in the account currency (Alarisclient_rate/vendor_rate). This is already the message cost. It is not a unit price that you multiply by the segment count yourself.
Surfacing pricing in your product
Without a rate-card endpoint, the recommended pattern is:
- Capture
rate/finalCostfrom each EDR into your own store. - Aggregate to compute an effective unit price per channel, country and sender.
- Reconcile against the contractual rates held with your account manager.
Related API
- API Reference → Single messages (
GET /balance,GET /edrs) - Guide: Track delivery — reading EDRs