Skip to main content
POST
/
v1
/
channels
/
phone-numbers
Provision a phone number
curl --request POST \
  --url https://api.cuadra.ai/v1/channels/phone-numbers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "<string>",
  "numberType": "local",
  "countryCode": "US",
  "region": "<string>"
}
'
{
  "success": true,
  "phoneNumberId": "<string>",
  "phoneNumber": "<string>",
  "monthlyCostCents": 123,
  "error": "<string>"
}

Authorizations

​
Authorization
string
header
required

JWT token from Stytch B2B authentication (magic link, SSO, or M2M)

Body

application/json

Request schema for provisioning a phone number.

​
phoneNumber
string
required

E.164 phone number to provision

​
numberType
string
default:local
​
countryCode
string
default:US
​
region
string | null

Response

Successful Response

Response schema for provisioning result. Note: Stripe billing for phone numbers is handled by the frontend via Stripe Checkout. The monthly_cost_cents field provides pricing info for the frontend to initiate the checkout flow.

​
success
boolean
required
​
phoneNumberId
string | null
required
​
phoneNumber
string | null
required
​
monthlyCostCents
integer | null
required

Monthly cost in cents for frontend checkout

​
error
string | null