v54

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-06178189573.7 KB

Purchase a phone number

Purchase an available phone number. Requires a paid plan: the Free plan cannot purchase phone numbers and receives 402 with code paid_plan_required. Paid plans include the first US number at no charge.

post/v1/phone-numbers

Request body

phoneNumberstring required

Phone number in E.164 format.

namestring

Optional custom name for the phone number.

Example request

{
  "phoneNumber": "+15551234567"
}

Response

Phone number purchased successfully.

Example response

{
  "phoneNumber": {
    "phoneNumber": "+15551234567",
    "capabilities": [
      "sms",
      "voice"
    ]
  }
}