Rateplans API

get listing

GET /api/rest/customer/v1/rateplans

Parameters

Name Description
filter[id] id filter
filter[name-eq] name eq filter
filter[name-not-eq] name not eq filter
filter[name-cont] name cont filter
filter[name-start] name start filter
filter[name-end] name end filter
filter[name-in] name in filter
filter[name-not-in] name not in filter
filter[name-cont-any] name cont any filter

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOlsiY3VzdG9tZXItdjEiXSwic3ViIjo1MywiZXhwIjoxNzY3MzU4MDM2fQ.dIyECNbZ6AOG3FcwKuqxi-RJ1m8Ktg2C4rpdy0EV37E
Host: example.org
Cookie: 

Route

GET /api/rest/customer/v1/rateplans

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/"e5bc14975c5c48a83dc114717e03fa5a"
cache-control: max-age=0, private, must-revalidate
x-request-id: ba3902ca-00db-41bd-85e8-339d84c1243b
x-runtime: 0.008714
content-length: 444

Status

200 OK

Body

{
  "data": [
    {
      "id": "07876daa-e7d9-11f0-932e-0a63caf27539",
      "type": "rateplans",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/rateplans/07876daa-e7d9-11f0-932e-0a63caf27539"
      },
      "attributes": {
        "name": "rateplan25"
      }
    }
  ],
  "meta": {
    "total-count": 1
  },
  "links": {
    "first": "http://example.org/api/rest/customer/v1/rateplans?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/customer/v1/rateplans?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}