Rateplans API

get listing

GET /api/rest/admin/rateplans

Parameters

Name	Description
filter[id]	id filter
filter[name]	name 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
filter[profit-control-mode-id-eq]	profit control mode id eq filter
filter[profit-control-mode-id-not-eq]	profit control mode id not eq filter
filter[profit-control-mode-id-gt]	profit control mode id gt filter
filter[profit-control-mode-id-gteq]	profit control mode id gteq filter
filter[profit-control-mode-id-lt]	profit control mode id lt filter
filter[profit-control-mode-id-lteq]	profit control mode id lteq filter
filter[profit-control-mode-id-in]	profit control mode id in filter
filter[profit-control-mode-id-not-in]	profit control mode id not in filter

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE4MCwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc2NzM1ODU2OX0.y2VabcxIP0KxR8-nl7a_TA5shriLrf2i1JVMZR7pZjg
Host: example.org
Cookie: 

Route

GET /api/rest/admin/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/"26360a97ad9124a5fcae4fdd221df239"
cache-control: max-age=0, private, must-revalidate
x-request-id: 8d913bb5-3547-4804-b2f9-fefa19645830
x-runtime: 0.007285
content-length: 772

Status

200 OK

Body

{
  "data": [
    {
      "id": "21",
      "type": "rateplans",
      "links": {
        "self": "http://example.org/api/rest/admin/rateplans/21"
      },
      "attributes": {
        "name": "rateplan8",
        "profit-control-mode-id": 2
      },
      "relationships": {
        "rate-groups": {
          "links": {
            "related": "http://example.org/api/rest/admin/rateplans/21/rate-groups"
          }
        }
      }
    },
    {
      "id": "22",
      "type": "rateplans",
      "links": {
        "self": "http://example.org/api/rest/admin/rateplans/22"
      },
      "attributes": {
        "name": "rateplan9",
        "profit-control-mode-id": 2
      },
      "relationships": {
        "rate-groups": {
          "links": {
            "related": "http://example.org/api/rest/admin/rateplans/22/rate-groups"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/rateplans?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/rateplans?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}