CheckRate API

get rates for number

POST /api/rest/customer/v1/check-rate

Parameters

Name	Description
data[type]	Resource type (check-rates)
data[attributes][rateplan-id]	Rateplan id
data[attributes][number]	Number

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOlsiY3VzdG9tZXItdjEiXSwic3ViIjoyMywiZXhwIjoxNzY3MzU4MDM0fQ.gXpX69115SMAb3mcvhAXXactLDfO8LfLa86-xqKpTg0
Host: example.org
Cookie: 

Route

POST /api/rest/customer/v1/check-rate

Body

{"data":{"type":"check-rates","attributes":{"rateplan-id":"061278a2-e7d9-11f0-932e-0a63caf27539","number":"44444444"}}}

Response

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/vnd.api+json
location: http://example.org/api/rest/customer/v1/check-rates
vary: Accept
etag: W/"df0c1f264e61bb48e894429417b46d9c"
cache-control: max-age=0, private, must-revalidate
x-request-id: 5497bbfa-4450-4e57-9dde-60f00f661b29
x-runtime: 0.009552
content-length: 573

Status

201 Created

Body

{
  "data": {
    "id": "608bd223-e5ae-400a-af9b-207afdac2ef9",
    "type": "check-rates",
    "links": {
      "self": "http://example.org/api/rest/customer/v1/check-rates"
    },
    "attributes": {
      "rateplan-id": "061278a2-e7d9-11f0-932e-0a63caf27539",
      "number": "44444444",
      "rates": [
        {
          "prefix": "444",
          "initial_rate": "0.0",
          "initial_interval": 60,
          "next_rate": "0.0",
          "next_interval": 60,
          "connect_fee": "0.0",
          "reject_calls": false,
          "valid_from": "2026-01-01T12:46:14.521Z",
          "valid_till": "2026-01-03T12:46:14.521Z",
          "network_prefix_id": 241998,
          "routing_tag_names": [
            "ua_cli",
            "us_cli"
          ],
          "id": "06222c0c-e7d9-11f0-932e-0a63caf27539"
        }
      ]
    }
  }
}