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.eyJhdWQiOlsiY3VzdG9tZXItdjEiXSwic3ViIjoyNCwiZXhwIjoxNzkyNjE5Mjc2fQ.Rtnn5eWmiyvsr-IxREJsbB92VSC1_FDlyB6h4gi7gNE
Host: example.org
Cookie: 

Route

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

Body

{"data":{"type":"check-rates","attributes":{"rateplan-id":"efe477aa-cd98-11f1-acef-6a55a9c27822","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/"a8269bb04b821680e62bcd198d561334"
cache-control: max-age=0, private, must-revalidate
x-request-id: 37887dee-12eb-48f3-bb26-ca78aba6ba32
x-runtime: 0.011922
content-length: 593

Status

201 Created

Body

{
  "data": {
    "id": "0b7e4806-62e4-416f-89fa-f6ab425e2013",
    "type": "check-rates",
    "links": {
      "self": "http://example.org/api/rest/customer/v1/check-rates"
    },
    "attributes": {
      "rateplan-id": "efe477aa-cd98-11f1-acef-6a55a9c27822",
      "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-10-20T21:46:56.956Z",
          "valid_till": "2026-10-22T21:46:56.957Z",
          "network_prefix_id": 241998,
          "routing_tag_names": [
            "ua_cli",
            "us_cli"
          ],
          "id": "eff3f176-cd98-11f1-acef-6a55a9c27822"
        }
      ]
    }
  }
}