Buying SMS credits and dedicated numbers with the API
An API key can buy SMS credits and dedicated numbers for your account, charged to a card you've saved. This suits platforms and integrations that top up automatically or give each of their own customers a number.
Purchases are off for every API key until you turn them on.
Turning purchases on for a key
- In your dashboard, go to Settings > API.
- Choose Purchases on the API key you want to use.
- Turn on Allow this key to make purchases.
- Set the daily spending limit for the key, then choose Save.
Only users who can manage billing can turn purchases on or raise a limit. Anyone who can manage API keys can turn purchases off or lower a limit.
The account owner is emailed when purchases are turned on for a key or a limit is raised.
When a purchase through the API goes through, its tax invoice is emailed to the Billing Notification Email in Settings > My Profile and names the API key that made it. If no billing email is set, or the payment is held for review, the account owner is emailed about the purchase instead.
The daily spending limit
Each key has its own limit in AUD, including GST, starting at $500. A purchase that would take the key's spending over the limit in any 24 hours is declined, and the response says how much is left.
Which card is charged
Cards are saved on the Billing page in your dashboard. If you have one saved card, purchases use it. If you have more than one, each request includes the last 4 digits of the card to charge.
Buying dedicated numbers
Claim your free dedicated number on the Sender IDs page first. That's where we collect the service address every Australian number needs, and numbers bought through the API use the same address.
After that, your integration can list the numbers available to buy and buy one for 12 months. Numbers renew yearly on the same card.
For developers
The endpoints are POST /v1/credit-purchases, GET /v1/available-numbers and POST /v1/dedicated-numbers. Send an Idempotency-Key header with each purchase so a retried request is never charged twice.
The API documentation covers the request fields, responses and error codes.