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

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjM1LCJhdWQiOlsiY3VzdG9tZXItdjEiXSwiZXhwIjoxNzQwODUyNTA3fQ.qISYOEcXv-Yplrv-zXdeyXNFds3eomfKXItWLvR1OCk
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/"c0eeef993b6664520964481ed61339ba"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 44a69296-0ced-4813-925b-dbc93c13981f
X-Runtime: 0.009889
Content-Length: 444

Status

200 OK

Body

{
  "data": [
    {
      "id": "08e53b30-f6c8-11ef-b447-0242ac120003",
      "type": "rateplans",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/rateplans/08e53b30-f6c8-11ef-b447-0242ac120003"
      },
      "attributes": {
        "name": "rateplan17"
      }
    }
  ],
  "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"
  }
}