Phone numbers

Rent a phone number from the telephony inventory

View as Markdown
Rents an available number returned by [`GET /product/get-available-numbers`](#operation/searchAvailablePhoneNumbers). Charges the organization the prorated amount returned by [`GET /product/proration-amount`](#operation/getProrationAmount) immediately, then the monthly rate on each billing cycle. Always call `GET /product/proration-amount` first to surface the immediate charge to your customer. The endpoint may return `200` with a body containing `requiresAction: true` when payment requires customer interaction (3-D Secure, etc.) — handle that branch in your client. Released later via [`POST /product/release-number`](#operation/releasePhoneNumber).

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Request

This endpoint expects an object.
phoneNumberstringRequired

The number to rent — exactly as returned by GET /product/get-available-numbers (no leading +).

providerenumRequired
Allowed values:

Response

Rental processed. Inspect data.requiresAction to determine whether the customer needs to complete a payment-method action.

statusboolean
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error