Skip to content
clearance.rest

Get the price of a number

GET
/numbers/catalog/prices
curl --request GET \
  --url 'https://api.clearance.rest/numbers/catalog/prices?type=temporary&country=example&line_type=local' \
  --header 'X-API-Key: <X-API-Key>'

Returns your price (not the supplier cost). Temporary numbers: the price of one rental, which is also the first price a rental tries (sending it as max_price never fails with max_price_too_low). Monthly numbers: the monthly price.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
type
required
string
Allowed values: temporary monthly
country
required
string
>= 2 characters <= 2 characters

ISO 3166-1 alpha-2 country code (e.g. US).

service
string
>= 1 characters

Target service code (required for temporary numbers).

line_type
string
Allowed values: local mobile national toll_free

Line type for monthly numbers (default local).

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
success
required
boolean
price
required

Your price for a number type, country and service.

object
type
required
string
Allowed values: temporary monthly
country
required
string
service
required
string | null
line_type
required
Any of:
string
Allowed values: local mobile national toll_free
price
required
Any of:

Amount in USD.

number
available
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
period
required

Temporary: price of one rental; monthly: price per month.

string
Allowed values: rental month
Example
{
  "success": true,
  "price": {
    "type": "temporary",
    "line_type": "local",
    "period": "rental"
  }
}

400

Section titled “400”

Default Response

Media typeapplication/json

Error envelope returned by every JSON endpoint.

object
success
required
boolean
error
required
object
code
required

Machine-readable error code (snake_case).

string
message
required

Human-readable message.

string
details

Extra context for the error.

object
key
additional properties
Example
{
  "success": false
}

401

Section titled “401”

Default Response

Media typeapplication/json

Error envelope returned by every JSON endpoint.

object
success
required
boolean
error
required
object
code
required

Machine-readable error code (snake_case).

string
message
required

Human-readable message.

string
details

Extra context for the error.

object
key
additional properties
Example
{
  "success": false
}

403

Section titled “403”

Default Response

Media typeapplication/json

Error envelope returned by every JSON endpoint.

object
success
required
boolean
error
required
object
code
required

Machine-readable error code (snake_case).

string
message
required

Human-readable message.

string
details

Extra context for the error.

object
key
additional properties
Example
{
  "success": false
}

500

Section titled “500”

Default Response

Media typeapplication/json

Error envelope returned by every JSON endpoint.

object
success
required
boolean
error
required
object
code
required

Machine-readable error code (snake_case).

string
message
required

Human-readable message.

string
details

Extra context for the error.

object
key
additional properties
Example
{
  "success": false
}

502

Section titled “502”

Default Response

Media typeapplication/json

Error envelope returned by every JSON endpoint.

object
success
required
boolean
error
required
object
code
required

Machine-readable error code (snake_case).

string
message
required

Human-readable message.

string
details

Extra context for the error.

object
key
additional properties
Example
{
  "success": false
}

503

Section titled “503”

Default Response

Media typeapplication/json

Error envelope returned by every JSON endpoint.

object
success
required
boolean
error
required
object
code
required

Machine-readable error code (snake_case).

string
message
required

Human-readable message.

string
details

Extra context for the error.

object
key
additional properties
Example
{
  "success": false
}