Order a number

Orders a phone number returned by a recent availability search and starts billing for it. This spends money and cannot be undone through this API — to stop paying for an ordered number, disconnect it. The number must still be in the results saved by POST /api/v1/numbers/available/local or /toll_free; one that has aged out of that storage is a 404, so search again and reorder. A 200 means the carrier accepted the order, not that the number is provisioned and taking calls. A key with no billing customer cannot order, and sending customerId does not work around that. Requires an API key with the Admin role.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The number to order. It must be one a recent availability search returned.

string

Billing customer to charge. Must be one of your account's customers; defaults to the first.

string

Subscription to add the number to. Must belong to the selected customer, otherwise one is chosen for you.

Responses

401

Missing or invalid API key.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json