Rates API

get listing

GET /api/rest/customer/v1/rates

Parameters

Name	Description
filter[id]	id filter
filter[prefix-eq]	prefix eq filter
filter[prefix-not-eq]	prefix not eq filter
filter[prefix-cont]	prefix cont filter
filter[prefix-start]	prefix start filter
filter[prefix-end]	prefix end filter
filter[prefix-in]	prefix in filter
filter[prefix-not-in]	prefix not in filter
filter[prefix-cont-any]	prefix cont any filter
filter[dst-number-min-length-eq]	dst number min length eq filter
filter[dst-number-min-length-not-eq]	dst number min length not eq filter
filter[dst-number-min-length-gt]	dst number min length gt filter
filter[dst-number-min-length-gteq]	dst number min length gteq filter
filter[dst-number-min-length-lt]	dst number min length lt filter
filter[dst-number-min-length-lteq]	dst number min length lteq filter
filter[dst-number-min-length-in]	dst number min length in filter
filter[dst-number-min-length-not-in]	dst number min length not in filter
filter[dst-number-max-length-eq]	dst number max length eq filter
filter[dst-number-max-length-not-eq]	dst number max length not eq filter
filter[dst-number-max-length-gt]	dst number max length gt filter
filter[dst-number-max-length-gteq]	dst number max length gteq filter
filter[dst-number-max-length-lt]	dst number max length lt filter
filter[dst-number-max-length-lteq]	dst number max length lteq filter
filter[dst-number-max-length-in]	dst number max length in filter
filter[dst-number-max-length-not-in]	dst number max length not in filter
filter[enabled-eq]	enabled eq filter
filter[enabled-not-eq]	enabled not eq filter
filter[reject-calls-eq]	reject calls eq filter
filter[reject-calls-not-eq]	reject calls not eq filter
filter[initial-rate-eq]	initial rate eq filter
filter[initial-rate-not-eq]	initial rate not eq filter
filter[initial-rate-gt]	initial rate gt filter
filter[initial-rate-gteq]	initial rate gteq filter
filter[initial-rate-lt]	initial rate lt filter
filter[initial-rate-lteq]	initial rate lteq filter
filter[initial-rate-in]	initial rate in filter
filter[initial-rate-not-in]	initial rate not in filter
filter[next-rate-eq]	next rate eq filter
filter[next-rate-not-eq]	next rate not eq filter
filter[next-rate-gt]	next rate gt filter
filter[next-rate-gteq]	next rate gteq filter
filter[next-rate-lt]	next rate lt filter
filter[next-rate-lteq]	next rate lteq filter
filter[next-rate-in]	next rate in filter
filter[next-rate-not-in]	next rate not in filter
filter[initial-interval-eq]	initial interval eq filter
filter[initial-interval-not-eq]	initial interval not eq filter
filter[initial-interval-gt]	initial interval gt filter
filter[initial-interval-gteq]	initial interval gteq filter
filter[initial-interval-lt]	initial interval lt filter
filter[initial-interval-lteq]	initial interval lteq filter
filter[initial-interval-in]	initial interval in filter
filter[initial-interval-not-in]	initial interval not in filter
filter[next-interval-eq]	next interval eq filter
filter[next-interval-not-eq]	next interval not eq filter
filter[next-interval-gt]	next interval gt filter
filter[next-interval-gteq]	next interval gteq filter
filter[next-interval-lt]	next interval lt filter
filter[next-interval-lteq]	next interval lteq filter
filter[next-interval-in]	next interval in filter
filter[next-interval-not-in]	next interval not in filter
filter[connect-fee-eq]	connect fee eq filter
filter[connect-fee-not-eq]	connect fee not eq filter
filter[connect-fee-gt]	connect fee gt filter
filter[connect-fee-gteq]	connect fee gteq filter
filter[connect-fee-lt]	connect fee lt filter
filter[connect-fee-lteq]	connect fee lteq filter
filter[connect-fee-in]	connect fee in filter
filter[connect-fee-not-in]	connect fee not in filter
filter[valid-from-eq]	valid from eq filter
filter[valid-from-not-eq]	valid from not eq filter
filter[valid-from-gt]	valid from gt filter
filter[valid-from-gteq]	valid from gteq filter
filter[valid-from-lt]	valid from lt filter
filter[valid-from-lteq]	valid from lteq filter
filter[valid-from-in]	valid from in filter
filter[valid-from-not-in]	valid from not in filter
filter[valid-till-eq]	valid till eq filter
filter[valid-till-not-eq]	valid till not eq filter
filter[valid-till-gt]	valid till gt filter
filter[valid-till-gteq]	valid till gteq filter
filter[valid-till-lt]	valid till lt filter
filter[valid-till-lteq]	valid till lteq filter
filter[valid-till-in]	valid till in filter
filter[valid-till-not-in]	valid till not in filter
filter[uuid-eq]	uuid eq filter
filter[uuid-not-eq]	uuid not eq filter
filter[uuid-in]	uuid in filter
filter[uuid-not-in]	uuid not in filter
filter[rateplan-id-eq]	rateplan id eq filter
filter[account-id-eq]	account id eq filter

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOlsiY3VzdG9tZXItdjEiXSwic3ViIjo1NSwiZXhwIjoxNzY3MzU4MDM3fQ.9CvKK_CYNgrVFRTiF7t-MaG4EhmWSPlB8zx_0MyhEBY
Host: example.org
Cookie: 

Route

GET /api/rest/customer/v1/rates

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/"3a0fae3b89872269694fd74e7ad32d0c"
cache-control: max-age=0, private, must-revalidate
x-request-id: 23bf456e-4524-4315-a2d5-27fc06c08223
x-runtime: 0.010585
content-length: 719

Status

200 OK

Body

{
  "data": [
    {
      "id": "07b2e980-e7d9-11f0-932e-0a63caf27539",
      "type": "rates",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/rates/07b2e980-e7d9-11f0-932e-0a63caf27539"
      },
      "attributes": {
        "prefix": "11",
        "dst-number-min-length": 0,
        "dst-number-max-length": 100,
        "enabled": true,
        "reject-calls": false,
        "initial-rate": "0.0",
        "initial-interval": 60,
        "next-rate": "0.0",
        "next-interval": 60,
        "connect-fee": "0.0",
        "valid-from": "2026-01-01T12:46:17.152Z",
        "valid-till": "2026-01-03T12:46:17.152Z",
        "network-prefix-id": 242388
      }
    }
  ],
  "meta": {
    "total-count": 1
  },
  "links": {
    "first": "http://example.org/api/rest/customer/v1/rates?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/customer/v1/rates?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}