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

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjIwLCJhdWQiOlsiY3VzdG9tZXItdjEiXSwiZXhwIjoxNzQwODUyNTA1fQ.ofKUKKrvURPHIxdg_-1Rt57OD02Wma11eB8gFZe2rCc
Host: example.org
Cookie: 

Route

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

Body

{"data":{"type":"check-rates","attributes":{"rateplan-id":"07c6149a-f6c8-11ef-b447-0242ac120003","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
Vary: Accept
ETag: W/"f228f20df0ed13041030a3a48e0c8e09"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 5d1a069b-cb63-4b3f-871b-24423ae017f0
X-Runtime: 0.013640
Content-Length: 573

Status

201 Created

Body

{
  "data": {
    "id": "6d64d2f4-17eb-4a72-8c42-ef1eda923128",
    "type": "check-rates",
    "links": {
      "self": "http://example.org/api/rest/customer/v1/check-rates"
    },
    "attributes": {
      "rateplan-id": "07c6149a-f6c8-11ef-b447-0242ac120003",
      "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": "2025-02-28T18:07:25.784Z",
          "valid_till": "2025-03-02T18:07:25.784Z",
          "network_prefix_id": 241998,
          "routing_tag_names": [
            "ua_cli",
            "us_cli"
          ],
          "id": "07e2af88-f6c8-11ef-b447-0242ac120003"
        }
      ]
    }
  }
}