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.eyJhdWQiOlsiY3VzdG9tZXItdjEiXSwic3ViIjoyNCwiZXhwIjoxNzg2MzU5NzYwfQ.gxLLzpSwR6TFLPPKuPXPFW76JEcAi5XXVV6ZgZcj2X0
Host: example.org
Cookie: 

Route

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

Body

{"data":{"type":"check-rates","attributes":{"rateplan-id":"dd9437a6-94aa-11f1-9684-4e29394502aa","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/"aa6f8968bd33fffcd955c9ee2d734897"
cache-control: max-age=0, private, must-revalidate
x-request-id: c48458aa-593f-45a9-87b8-cd2b7685a068
x-runtime: 0.009900
content-length: 593

Status

201 Created

Body

{
  "data": {
    "id": "2249f3ed-d58f-4fce-a9d3-0c3ef5f77335",
    "type": "check-rates",
    "links": {
      "self": "http://example.org/api/rest/customer/v1/check-rates"
    },
    "attributes": {
      "rateplan-id": "dd9437a6-94aa-11f1-9684-4e29394502aa",
      "number": "44444444",
      "rates": [
        {
          "prefix": "444",
          "initial_rate": "0.0",
          "initial_interval": 60,
          "next_rate": "0.0",
          "next_interval": 60,
          "connect_fee": "0.0",
          "attempt_fee": "0.0",
          "reject_calls": false,
          "valid_from": "2026-08-09T11:01:40.887Z",
          "valid_till": "2026-08-11T11:01:40.887Z",
          "network_prefix_id": 241998,
          "routing_tag_names": [
            "ua_cli",
            "us_cli"
          ],
          "id": "dda2acf0-94aa-11f1-9684-4e29394502aa"
        }
      ]
    }
  }
}