Numbers
Get an order
GET
apiKeyheader
AuthorizationBearer <token>An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.
id*stringSuccess
application/json- response
Success
id*stringstatus*stringcompleted: all numbers delivered. failed: nothing charged. provisioning: the carrier is still assigning some numbers. needs_reconciliation: being verified with the carrier.
Value in
"created""purchasing""provisioning""completed""failed""needs_reconciliation"customerId*|The customer this was bought for, if any
country*stringISO 3166-1 alpha-2 country code, for example US or GB
Match
^[A-Z]{2}$product*stringany_service receives SMS from anyone; single_service is locked to one sender
Value in
"any_service""single_service"service*string|nullduration*stringLength of the rental
Value in
"12h""1d""7d""30d""180d""365d"quantity*integerfulfilledCount*integerNumbers delivered so far
autoRenew*booleanunitPrice*integerAmount in minor units (US cents)
totalPrice*integerCharged for the numbers delivered, in minor units
currency*"USD"Value in
"USD"failure*|Why the order failed, when it did
numbers*array<>actor*|Who placed this order
createdAt*stringISO 8601 timestamp
Format
date-timeupdatedAt*stringISO 8601 timestamp
Format
date-timecurl -X GET "https://example.com/v1/numbers/orders/ord_01K6XJ4Q8ZT3M9R5V2B7WDHNCA"{ "id": "ord_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "status": "completed", "customerId": "cus_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "country": "US", "product": "any_service", "service": null, "duration": "30d", "quantity": 1, "fulfilledCount": 1, "autoRenew": true, "unitPrice": 1200, "totalPrice": 1200, "currency": "USD", "failure": null, "numbers": [ { "id": "num_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "number": "15550100002", "country": "US", "product": "any_service", "service": null, "status": "active", "customerId": "cus_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "orderId": "ord_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "nickname": "Support line", "startsAt": "2026-10-07T11:04:31.000Z", "endsAt": "2026-11-06T11:04:31.000Z", "autoRenew": true, "renewDuration": "30d", "unitPrice": 1200, "customerPrice": null, "paidTotal": 1200, "messageCount": 3, "cancellableFrom": null, "createdAt": "2026-10-07T11:04:31.000Z" } ], "actor": { "kind": "user", "label": "string" }, "createdAt": "2026-10-07T11:04:31.000Z", "updatedAt": "2026-10-07T11:04:31.000Z"}