ResellerHQ
Log inTry the sandbox free
GuidesAPI reference
Numbers

List offers

GET
/v1/numbers/offers

Your price for each duration, for a country and product. For single_service there is one offer per service. With customerId, each price also says what that customer pays, promotions counted. A coupon that cannot be used is simply not applied here.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.

Query Parameters

country*string

ISO 3166-1 alpha-2 country code, for example US or GB

Match^[A-Z]{2}$
product?string

any_service receives SMS from anyone; single_service is locked to one sender

Default"any_service"
Value in"any_service""single_service"
service?string

Only this service, for single_service

customerId?string

Also return what this customer pays for each price

coupon?string

Also count the promotion this coupon unlocks, as an order sending it would

Length1 <= length <= 40

Response Body

Success

application/json
  1. response

Success

data*array<>
curl -X GET "https://example.com/v1/numbers/offers?country=US&customerId=cus_01K6XJ4Q8ZT3M9R5V2B7WDHNCA&coupon=LAUNCH25"
{  "data": [    {      "country": "US",      "product": "any_service",      "service": {        "id": "whatsapp",        "name": "WhatsApp"      },      "prices": [        {          "duration": "30d",          "amount": 1200,          "currency": "USD",          "customerPrice": 1500,          "customerCurrency": "USD",          "customerNormalPrice": 1800,          "customerPromotionEndsAt": "2026-12-01T00:00:00.000Z"        }      ]    }  ]}

List ordering options GET

The countries, products and durations this account can order.

Create an order POST

Charges your wallet and returns the order with its numbers. Send an Idempotency-Key header so a retry can never buy twice. Check `status`: an order can be `failed` (nothing charged) or still `provisioning` when this returns. A `coupon` is checked before anything is bought, so an order it cannot be used on is refused with nothing charged, unless you send `couponOptional`.