Sign in

v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
numbers

Find a specific lease

Returns a single NumberLease instance for a given number

get/numbers/leases/{number}

Path parameters

numberstring required

A phone number in E.164 format (11-digit). Example: 12132000384

Query parameters

fieldsstring

Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at partial response page.

Response

successful operation

numberstring

A phone number in E.164 format (11-digit). Example: 12132000384

sendEmailOnCreateboolean

~

nationalFormatstring

Formatted number with a country code

tollFreeboolean

A toll-free number

leaseBegininteger

A date and time of a lease start. Timestamp, formatted in unix time milliseconds (read only). Example: 1473781817000

leaseEndinteger

A data and time of a lease finish. Timestamp, formatted in unix time milliseconds (read only). Example: 1473781817000

autoRenewboolean

Enables the auto renewal of number lease at end of each billing cycle

status'PENDING' | 'ACTIVE' | 'RELEASED' | 'UNAVAILABLE'

A lease status. Available values: PENDING, ACTIVE, RELEASED, UNAVAILABLE

callFeatureStatus'UNSUPPORTED' | 'PENDING' | 'DISABLED' | 'ENABLED'

A status of a call feature. Available values: DISABLED, ENABLED

textFeatureStatus'UNSUPPORTED' | 'PENDING' | 'DISABLED' | 'ENABLED'

A status of a text feature. Available values: DISABLED, ENABLED

labelsstring[]

~

type'PLAN' | 'EXTRA'

~