Skip to main content
POST
json

Body

application/json
PhoneNumbers
object[]
required

Numbers to cancel. Each must exist, belong to your account, and be Active.

Response

Cancel order created — review and submit within 5 minutes

OrderId
string

Identifier for this cancel order. Pass it to cancel-order-submit.

OrderDate
string<date-time>

When the order was created (UTC).

OrderStatus
string

Order state — Pending Confirmation until submitted.

AuthCode
string

Single-use confirmation code, valid 5 minutes. Returned once and only as a hash afterwards.

AuthCodeExpiresAt
string<date-time>

UTC expiry of the AuthCode.

NumbersChange
object[]

The numbers that will be cancelled when you submit.

The statement you accept by submitting.

Instructions
string

Human-readable next-step instructions.