Skip to main content

Get Rates

This request returns monthly rental fees for a phone number matching the defined criteria.

get /phonenumber/rates
get /dids/ratesdeprecated

Sample​

A sample GET request to get phone number rates matching the criteria in the request URL:

curl -X GET \
'https://api.carrierx.com/core/v2/phonenumber/rates?limit=1' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response​

200 status code with phone number rates:

{
    "active": "yes",
    "count": 1,
    "effective_date": "2017-08-03T00:00:00.000Z",
    "has_more": false,
    "items": [
        {
            "classification_sid": "3306c614-772b-4477-8f29-714676c6d52c",
            "country_code": null,
            "country_name": null,
            "prefix": null,
            "price_0": "0.15",
            "price_1": "0.12",
            "price_2": "0.1",
            "price_3": "0.07",
            "price_4": "0.05",
            "price_5": "0.02",
            "price_6": "0.01",
            "quantity_0": 0,
            "quantity_1": 3,
            "quantity_2":5,
            "quantity_3": 6,
            "quantity_4": 8,
            "quantity_5": 9,
            "quantity_6": 11
        }
    ],
    "limit": 1,
    "offset": 0,
    "pagination": {},
    "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
    "rates_plan": {
        "name": "did_retail-2017-08-03.txt",
        "rates_plan_sid": "326d2ec0-c58c-43e2-85f3-a92d647e46ac"
    },
    "total": 1
}

This request is enabled for Pagination, Result Filtering, and Field Filtering.

Required Scopes​

To get information about rates the partner must have one of the following scopes enabled:

  • phonenumber.manage
  • phonenumber.read