Skip to main content
Buys a number from the carrier for this project. Free inside the plan allowance; past it, the first month of rent is charged now and monthly after that.
Calls POST /v1/phone-number

​
Options

​
string
required
The number to buy, in E.164 format, from a search result.
​
string
A label for the number.
​
string
The agent to assign the number to.
​
switch
Whether you expect this number to be free (from the allowance). The purchase is refused with 409 if that has changed since you checked.
​
integer
The monthly rent you expect for a paid number, in micros (from the allowance). The purchase is refused with 409 if that has changed since you checked.

​
Example

Every command also takes the global options and sets one of the exit codes.