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.eyJzdWIiOjIwLCJhdWQiOlsiY3VzdG9tZXItdjEiXSwiZXhwIjoxNzEwMjU0MjAyfQ.ptC1R52niUHXJVvNTyVwbCHHvaGQZxQP4kq2_8FYB3k
Host: example.org
Cookie: 

Route

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

Body

{"data":{"type":"check-rates","attributes":{"rateplan-id":"cd7afe56-e07d-11ee-bf85-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/"6083f1ed45d27de935d0de94841fe0ba"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 5f384f8e-4b75-4ec8-8937-7b831ff280a6
X-Runtime: 0.010985
Content-Length: 570

Status

201 Created

Body

{
  "data": {
    "id": "4eb1e9dd-1f7a-4785-941f-a358947a9d24",
    "type": "check-rates",
    "links": {
      "self": "http://example.org/api/rest/customer/v1/check-rates"
    },
    "attributes": {
      "rateplan-id": "cd7afe56-e07d-11ee-bf85-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-03-11T14:35:42.202Z",
          "valid_till": "2024-03-13T14:35:42.202Z",
          "network_prefix_id": 948,
          "routing_tag_names": [
            "ua_cli",
            "us_cli"
          ],
          "id": "cdba4d04-e07d-11ee-bf85-0242ac120003"
        }
      ]
    }
  }
}