Number settings

#Release a number

Permanent. The number goes back to the carrier and you can’t get it back. Releasing stops the monthly fee; the current month isn’t refunded. Needs the manage_phones permission.

Parameters

idinteger · pathRequired: The number id.

Returns { "success": true }.

Errors

HTTP	Code	When
202	`RELEASE_PENDING`	The carrier hasn’t let the number go yet. We stopped its monthly charge and will finish the release for you. The number stays on your account until the carrier confirms.
404	`NUMBER_NOT_FOUND`	Not on your account, or a self-paying client’s number. A number you released that kept its record (it had messages or a payment) is released again on a second call; one without answers 404.
409	`NUMBER_RESERVED`	A protected number. Contact support.
409	`NUMBER_SETTING_UP`	The number is still being set up. Try again once it is active.
409	`NUMBER_KEY_UNKNOWN`	Ready couldn’t confirm the number with the carrier. Nothing released; contact support.
409	`REPLACEMENT_IN_FLIGHT`	A replacement for this number is on its way; it is released for you once the new one is live.
409	`LAST_NUMBER_CONFIRM`	Your only number that can text, or the last on its campaign. Nothing released; release it in the dashboard, which asks you to confirm.
500	`RELEASE_INCOMPLETE`	Didn’t finish. Check `GET /v1/numbers/:id`.
503	`permission_check_unavailable`	Ready couldn’t check the number. Nothing released; retry.
502	`BILLING_CANCEL_FAILED`	Fee not stopped, so nothing released.

curl -X DELETE "https://api.tryready.com/v1/numbers/2647" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/v1/numbers/2647', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
  },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.delete(
    "https://api.tryready.com/v1/numbers/2647",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true
}

#Forward calls

Rings another phone, like your cell, when someone calls this number. Send an empty forward_to_number to turn it off. The older path /numbers/:id/forwarding still works, but it is not under /v1, so X-Sub-Account-Id isn’t accepted there. Needs the manage_phones permission.

Parameters

forward_to_numberstring | nullRequired unless calls_to is sent: A US or Canadian number. Not another Ready number, which could loop. "" or null turns forwarding off.
calls_tostringOptional: "sip" rings your SIP trunk instead of a phone. "phone" takes the number off the trunk and forwards to forward_to_number. "off" takes it off the trunk and turns forwarding off.

Returns

data.id, data.forward_to_numberinteger, string | null: The number’s id and where its calls now go.
data.routedboolean: true when forwarding was turned on with the carrier. Absent when you turn it off.

Errors

HTTP	Code	When
400	`FORWARD_TO_REQUIRED`	No `forward_to_number` in the body.
400	no code	The number isn’t valid, isn’t US or Canadian, is a Ready number, or this number can’t take calls.
403	`SIP_TRUNKING_UNAVAILABLE`	`calls_to` is `"sip"` and SIP trunking isn’t on for your account.
409	`SIP_TRUNK_NOT_SET_UP`	`calls_to` is `"sip"` and you have no SIP trunk yet.
403	`CALL_FORWARDING_UNAVAILABLE`	Call forwarding isn’t switched on for Ready yet. Turning it off always works.
404	`NUMBER_NOT_FOUND`	No number with this id on your account.
500	`FORWARD_ON_NOT_SAVED`	Calls forward now, but the number’s record didn’t update. Send the same request again in a minute; it sets the same target.
500	`FORWARD_OFF_NOT_SAVED`	Forwarding is off with the carrier, but the number’s record may still show it on. Send the same request again in a minute; it sets the same target.
502	`FORWARD_SET_UNCONFIRMED`	We couldn’t confirm it with the carrier, so it may not be on. Try again.
502	`FORWARD_CLEAR_UNCONFIRMED`	We couldn’t turn it off with the carrier. Try again.
503	`FORWARD_CHECK_UNAVAILABLE`	Couldn’t check the forwarding number. Nothing changed; retry.

curl -X PUT "https://api.tryready.com/v1/numbers/2647/forwarding" \
  -H "X-API-Key: $READY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "forward_to_number": "+12175550142"
  }'

const res = await fetch('https://api.tryready.com/v1/numbers/2647/forwarding', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "forward_to_number": "+12175550142"
  }),
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.put(
    "https://api.tryready.com/v1/numbers/2647/forwarding",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    json={
        "forward_to_number": "+12175550142"
    },
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "id": 2647,
    "forward_to_number": "+12175550142",
    "routed": true
  }
}

#Read your SIP trunk

Your SIP trunk settings and the numbers that ring it. SIP trunking is switched on per account; ask support. Without it you get available: false and nothing else.

Returns

data.availableboolean: Whether SIP trunking is on for your account.
data.host, data.allow_ipsstring, string[]: Our SIP host and the addresses your SBC should allow.
data.codec_choicesstring[]: The codecs you can pick.
data.trunkobject | null: sbc_ip, sbc_port, codecs, channel_limit, created_at and numbers (each id and phone_number). null until you turn it on. The channel limit starts at 10 and goes up on its own when calls get close to it.

curl "https://api.tryready.com/v1/sip-trunk" \
  -H "X-API-Key: $READY_API_KEY"

Returns:

{
  "success": true,
  "data": {
    "available": true,
    "host": "sip.tryready.com",
    "allow_ips": ["185.255.9.23", "185.255.11.170"],
    "codec_choices": ["PCMU", "PCMA", "G729"],
    "trunk": {
      "sbc_ip": "203.0.114.10",
      "sbc_port": 5060,
      "codecs": ["PCMU", "PCMA"],
      "channel_limit": 10,
      "created_at": "2026-11-14T18:02:11.000Z",
      "numbers": [{ "id": 2647, "phone_number": "+12175550142" }]
    }
  }
}

#Turn on or change your SIP trunk

Sets up one SIP trunk for your account, or changes its settings. Then point numbers at it with calls_to: "sip". Calls your SBC places out are billed per minute at your calling rate. Needs the manage_phones permission. Safe to repeat.

Parameters

sbc_ipstringRequired: Your SBC’s public IPv4 address. Private and local addresses are refused.
sbc_portintegerRequired: Your SBC’s SIP port, 1025 to 65535. Most use 5060.
codecsstring[]Required: One or more of PCMU, PCMA, G729.

Returns

The same body as Read your SIP trunk.

Errors

HTTP	Code	When
400	`invalid_field`	The IP, port or codecs aren’t valid. The message says which.
403	`SIP_TRUNKING_UNAVAILABLE`	SIP trunking isn’t on for your account.
409	`SIP_TRUNK_SBC_IN_USE`	That SBC address is set up on another account.
502	`SIP_TRUNK_CARRIER_FAILED`	The carrier didn’t finish it. Send the same request again in a minute.
503	`SIP_TRUNK_BUSY`	Another change is saving. Nothing changed; try again.

curl -X PUT "https://api.tryready.com/v1/sip-trunk" \
  -H "X-API-Key: $READY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sbc_ip": "203.0.114.10",
    "sbc_port": 5060,
    "codecs": ["PCMU", "PCMA"]
  }'

#Turn off your SIP trunk

Every number on the trunk goes back to no forwarding, then the trunk is removed. Needs the manage_phones permission. Safe to repeat: a second call answers deleted: false.

Returns

data.deletedboolean: true when a trunk was turned off.

#Rename a number

Gives the number a label, shown as name on the number and on the Numbers page. Needs the manage_phones permission.

Path parameters

idintegerRequired: The number id.

Body parameters

namestring | nullRequired: Up to 100 characters. "" or null clears the label.

Errors

HTTP	Code	When
400	`NAME_REQUIRED`	No `name` in the body.
400	`invalid_field`	`name` isn’t a string, or is longer than 100 characters.
404	`NUMBER_NOT_FOUND`	No number with this id on your account.
500	`SETTING_SAVE_UNCONFIRMED`	Ready couldn’t confirm the change. Read the number with `GET /v1/numbers/:id` to see whether it saved.

curl -X PUT "https://api.tryready.com/v1/numbers/2647/name" \
  -H "X-API-Key: $READY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Front desk"
  }'

const res = await fetch('https://api.tryready.com/v1/numbers/2647/name', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Front desk"
  }),
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.put(
    "https://api.tryready.com/v1/numbers/2647/name",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    json={
        "name": "Front desk"
    },
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true
}

#Use a number for texting or calling

Chooses what Ready picks this number for. A number with texting off isn’t picked as a sender when you leave out from, and one with calling off isn’t offered as a caller ID. One of the two must stay on; to stop using the number, release it. Needs the manage_phones permission.

Path parameters

idintegerRequired: The number id.

Body parameters

use_for_textingboolean: true or false. Leave it out to keep it as it is.
use_for_callingboolean: true or false. Leave it out to keep it as it is.

Returns

dataobject: { id, use_for_calling, use_for_texting }, each switch as 1 or 0.

Errors

HTTP	Code	When
400	`toggle_invalid`	A switch you sent isn’t `true` or `false`.
400	`calling_or_texting_required`	Both switches are off.
404	`NUMBER_NOT_FOUND`	No number with this id on your account.
500	`SETTING_SAVE_UNCONFIRMED`	Ready couldn’t confirm the change. Read the number with `GET /v1/numbers/:id` to see whether it saved.

curl -X PUT "https://api.tryready.com/v1/numbers/2647/usage" \
  -H "X-API-Key: $READY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "use_for_texting": true,
    "use_for_calling": false
  }'

const res = await fetch('https://api.tryready.com/v1/numbers/2647/usage', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "use_for_texting": true,
    "use_for_calling": false
  }),
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.put(
    "https://api.tryready.com/v1/numbers/2647/usage",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    json={
        "use_for_texting": True,
        "use_for_calling": False
    },
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "id": 2647,
    "use_for_calling": 0,
    "use_for_texting": 1
  }
}

#Set a number’s daily cap

The most texts this number sends in a day. When it reaches the cap, Ready sends from another of your numbers that has room. Needs the manage_phones permission.

Path parameters

idintegerRequired: The number id.

Body parameters

capinteger | nullRequired: A whole number of texts. 0, null or leaving it out removes the cap.

Returns

data.daily_cap_smsinteger | null: The cap now. null means no cap.
data.sent_todayinteger | null: Texts this number sent today. null when Ready couldn’t count them; the cap is saved either way.

Errors

HTTP	Code	When
400	`DAILY_CAP_INVALID`	Not a whole number.
404	`NUMBER_NOT_FOUND`	No number with this id on your account.
500	`SETTING_SAVE_UNCONFIRMED`	Ready couldn’t confirm the change. Read the number with `GET /v1/numbers/:id` to see whether it saved.

curl -X PUT "https://api.tryready.com/v1/numbers/2647/daily-cap" \
  -H "X-API-Key: $READY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "cap": 250
  }'

const res = await fetch('https://api.tryready.com/v1/numbers/2647/daily-cap', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "cap": 250
  }),
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.put(
    "https://api.tryready.com/v1/numbers/2647/daily-cap",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    json={
        "cap": 250
    },
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "id": 2647,
    "phone_number": "+14155550100",
    "daily_cap_sms": 250,
    "sent_today": 31
  }
}

#Set a number’s webhook

Sends this number’s texting events to its own URL instead of your account webhook, like a per-number SMS URL on Twilio. Send null to go back to the account webhook.

Save your account webhook first. A number’s URL uses its events, its on/off switch and its signing secret, so pausing or changing them there applies to every number.

Path parameters

idintegerRequired: The number id.

Body parameters

webhook_urlstring | nullRequired: Your endpoint for this number. null or "" clears it.

Details
The same URL rules as the account webhook: a public address, never a private or internal host. Use https://: a new http:// URL is refused with invalid_url, since it would send your customers' messages unencrypted (the http:// URL a number already has keeps working). It gets inbound_reply for texts to this number and message_delivered / message_failed for texts sent from it, when those events are on in your account webhook. Everything else (calls, opt-outs, new contacts, registration, and the delivery status of an iMessage, which names no sending number) still goes to the account webhook. Events are signed with the account’s secret, so one X-Signature check works for every URL. Only a number your account holds itself: for a sub-account’s number, call with X-Sub-Account-Id. Moving the number to another account or releasing it clears its URL. Up to 1,000 numbers per account can have one.

Returns

dataobject: The number, the same shape as Get a number.

Errors

HTTP	Code	When
400	`nothing_to_update`	No `webhook_url` in the body.
400	`invalid_url`	Not a URL, not http or https, or a private or internal host.
400	`invalid_field`	`webhook_url` isn’t a string or `null`, or is longer than 2,000 characters.
403	`permission_denied`	The key’s user lacks `manage_integrations`.
403	`OWNER_ONLY`	The key isn’t the account owner’s or an admin seat’s.
404	`number_not_found`	Not a number your account holds, or released.
409	`account_webhook_required`	No account webhook saved yet. Save one with `PUT /v1/webhooks`.
409	`number_webhook_limit`	1,000 numbers already have their own URL.

curl -X PUT "https://api.tryready.com/v1/numbers/2647" \
  -H "X-API-Key: $READY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "webhook_url": "https://app-b.example.com/ready-webhook"
  }'

const res = await fetch('https://api.tryready.com/v1/numbers/2647', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "webhook_url": "https://app-b.example.com/ready-webhook"
  }),
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.put(
    "https://api.tryready.com/v1/numbers/2647",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    json={
        "webhook_url": "https://app-b.example.com/ready-webhook"
    },
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "id": 2647,
    "phone_number": "+14155550100",
    "status": "active",
    "created_at": "2026-07-29T00:12:04.512Z",
    "webhook_url": "https://app-b.example.com/ready-webhook",
    "spam": {
      "sms_flagged": false,
      "sms_reports": 0,
      "sms_checked_at": "2026-10-30T08:00:12.004Z",
      "caller_flagged": false,
      "caller_flagged_at": null
    }
  }
}

{
  "success": false,
  "error": "Save your account webhook first with PUT /v1/webhooks. A number's webhook_url uses its events, on/off switch and signing secret.",
  "error_code": "account_webhook_required",
  "code": "account_webhook_required"
}

#Rest a number

Stops Ready from picking this number as a sender, so texts without a from go out from your other numbers. You can still send from it by naming it in from. It costs nothing and keeps the number. Needs the manage_phones permission.

Path parameters

idintegerRequired: The number id.

Body parameters

hoursinteger: How long to rest it, in whole hours. Leave it out to rest it until you resume it. To keep Ready from ever picking it for texts, turn texting off instead.

Returns

dataobject: { id, phone_number, friendly_name, rested_until }.
hoursinteger | null: The hours you sent, or null for until resumed.

Errors

HTTP	Code	When
400	`LAST_SENDING_NUMBER`	It’s your only number still sending. Buy or resume another number first.
400	`REST_HOURS_INVALID`	`hours` isn’t a whole number in range.
404	`NUMBER_NOT_FOUND`	No number with this id on your account.
500	`SETTING_SAVE_UNCONFIRMED`	Ready couldn’t confirm the change. Read the number with `GET /v1/numbers/:id` to see whether it saved.

curl -X POST "https://api.tryready.com/v1/numbers/2647/rest" \
  -H "X-API-Key: $READY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "hours": 24
  }'

const res = await fetch('https://api.tryready.com/v1/numbers/2647/rest', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "hours": 24
  }),
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.post(
    "https://api.tryready.com/v1/numbers/2647/rest",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    json={
        "hours": 24
    },
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true,
  "data": {
    "id": 2647,
    "phone_number": "+14155550100",
    "friendly_name": "Front desk",
    "rested_until": "2026-11-12T18:00:00.000Z"
  },
  "hours": 24
}

#Resume a number

Ends a rest, so Ready picks the number as a sender again. Safe to call on a number that isn’t resting. Needs the manage_phones permission.

Path parameters

idintegerRequired: The number id.

Errors

HTTP	Code	When
404	`NUMBER_NOT_FOUND`	No number with this id on your account.
500	`SETTING_SAVE_UNCONFIRMED`	Ready couldn’t confirm the change. Read the number with `GET /v1/numbers/:id` to see whether it saved.

curl -X POST "https://api.tryready.com/v1/numbers/2647/resume" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/v1/numbers/2647/resume', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
  },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.post(
    "https://api.tryready.com/v1/numbers/2647/resume",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true
}

#Make a number your primary

Ready sends from your primary number when you leave out from and no other rule picks one. Your other numbers stop being primary. Needs the manage_phones permission.

Path parameters

idintegerRequired: The number id.

Errors

HTTP	Code	When
404	`NUMBER_NOT_FOUND`	No number with this id on your account.
500	`SETTING_SAVE_UNCONFIRMED`	Ready couldn’t confirm the change. Read the number with `GET /v1/numbers/:id` to see whether it saved.

curl -X PUT "https://api.tryready.com/v1/numbers/2647/primary" \
  -H "X-API-Key: $READY_API_KEY"

const res = await fetch('https://api.tryready.com/v1/numbers/2647/primary', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.READY_API_KEY,
  },
});
const json = await res.json().catch(() => ({}));
if (!res.ok || json.success === false) {
  throw new Error(`${res.status}${json.error_code || json.code ? ' ' + (json.error_code || json.code) : ''}: ${json.error || json.message || res.statusText}`);
}

import os, requests

r = requests.put(
    "https://api.tryready.com/v1/numbers/2647/primary",
    headers={"X-API-Key": os.environ["READY_API_KEY"]},
    timeout=30,
)
data = r.json() if r.headers.get("content-type", "").startswith("application/json") else {}
if not r.ok or data.get("success") is False:
    raise RuntimeError(f'{r.status_code} {data.get("error_code") or data.get("code") or ""}: {data.get("error") or data.get("message") or r.reason}')

Returns:

{
  "success": true
}

Older paths

POST /phone-numbers/checkout: use POST /v1/numbers/checkout. The alias is limited to 20 a minute and doesn’t accept X-Sub-Account-Id.