Billing API
Read the wallet ledger, receipts, invoices, this period's usage against your limits, your plan and your prices.
- GETList wallet transactions
/v1/billing/transactionsEvery row of the team's wallet, as the billing page's ledger lists it: top-ups, Pro months, units, SMS charges and releases, sender ID fees and refunds,…
- GETList receipts
/v1/billing/receiptsThe receipts in the team's wallet: paid top-ups, Pro months paid from the wallet (with their invoice number), sender ID fees and their refunds.
- GETGet a receipt
/v1/billing/receipts/{reference}One receipt by its reference (a transaction's receiptReference), with the figures the printable receipt shows.
- GETList invoices
/v1/billing/invoicesThe team's latest 12 card subscription invoices, newest first, as the billing page lists them: id, number, date, amounts in cents and status.
- GETGet an invoice
/v1/billing/invoices/{id}One card subscription invoice of the team, by its id (in_...).
- GETGet the plan
/v1/billing/subscriptionThe team's plan and how it is paid: the card subscription (status, period, whether it cancels at the period's end), the wallet's state (renewal date,…
- GETGet usage
/v1/billing/usageThe figures the Usage and billing pages show: this billing period's emails against the monthly and daily limits (the daily limit is the one enforced…
- GETGet prices
/v1/billing/pricingThe package price list the billing page's Pricing table shows, in the team's billing currency (USD for a team that has not chosen one): each channel's…
- GETGet spend and limits
/v1/billing/spendWhat the Spend and limits page shows: this calendar month's spend (UTC, from the 1st) on texts (SMS), one-time codes (OTP), pay-as-you-go email (EMAIL)…
- PUTSet or lower a monthly budget
/v1/billing/spend/budgets/{channel}Creates the monthly budget for SMS, OTP or EMAIL, in the wallet currency's minor unit, or tightens the one it has.
- DELRemove a monthly budget (dashboard only)
/v1/billing/spend/budgets/{channel}Removing a budget lifts a limit, so the API refuses it: a channel that has a budget answers 403 FORBIDDEN ("Raising or removing a budget can only be done…