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.eyJzdWIiOjIwLCJhdWQiOlsiY3VzdG9tZXItdjEiXSwiZXhwIjoxNzMxNTc4MjI3fQ.q-1qKk911JYwuLIm_h9QGgNhKn8iAQoyWSaO4T7hgMY
Host: example.org
Cookie: 

Route

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

Body

{"data":{"type":"check-rates","attributes":{"rateplan-id":"ab3a5d38-a26e-11ef-a008-0242ac120003","number":"44444444"}}}

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
ETag: W/"8a8f17c09a6937d4db6e5fb1a53d61ea"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: a412343b-ebcc-44fa-a037-2cac9caf1998
X-Runtime: 0.011305
Content-Length: 573

Status

201 Created

Body

{
  "data": {
    "id": "174b2aaa-9bee-4dd0-8b5f-0ccb9001fc15",
    "type": "check-rates",
    "links": {
      "self": "http://example.org/api/rest/customer/v1/check-rates"
    },
    "attributes": {
      "rateplan-id": "ab3a5d38-a26e-11ef-a008-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": "2024-11-13T09:56:07.639Z",
          "valid_till": "2024-11-15T09:56:07.640Z",
          "network_prefix_id": 241998,
          "routing_tag_names": [
            "ua_cli",
            "us_cli"
          ],
          "id": "ab5763b0-a26e-11ef-a008-0242ac120003"
        }
      ]
    }
  }
}