Get list of Rate Plans API

List rate plans

get

/rate_plans

List rate plans, including those a channel created for its own mapping. Results are paginated; the meta block carries the page, limit, total and ordering.

Authorizations

user-api-keystringRequired

API key for programmatic access, sent in the user-api-key header.

Query parameters

filter[property_id]string · uuidOptional

Return only the rate plans of this property.

Example: 716305c4-561a-4561-a187-7f5b8aeb5920

filter[room_type_id]string · uuidOptional

Return only the rate plans of this room type.

Example: 716305c4-561a-4561-a187-7f5b8aeb5920

pagination[page]integer · int32 · min: 1Optional

Page to return, counted from 1.

pagination[limit]integer · int32 · min: 1 · max: 100Optional

Number of items per page. Maximum is 100.

order[title]string · enumOptional

Sort direction for list results.

Possible values:

order[inserted_at]string · enumOptional

Sort direction for list results.

Possible values:

Responses

200

The request has succeeded.

application/json

JSON:API document wrapping a collection of resources with pagination meta.

401

Authentication credentials are missing or invalid.

application/json

422

The request has missing or invalid arguments; details lists the messages per argument.

application/json

get/rate_plans

GET /api/v1/rate_plans HTTP/1.1
Host: app.channex.io
user-api-key: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "type": "rate_plan",
      "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
      "attributes": {
        "id": "bab451e7-9ab1-4cc4-aa16-107bf7bbabb2",
        "title": "Best Available Rate",
        "sell_mode": "per_room",
        "rate_mode": "manual",
        "currency": "USD",
        "meal_type": "none",
        "tax_set_id": "716305c4-561a-4561-a187-7f5b8aeb5920",
        "cancellation_policy_id": "716305c4-561a-4561-a187-7f5b8aeb5920",
        "ui_read_only": true,
        "meta": {},
        "inherit_rate": true,
        "inherit_closed_to_arrival": true,
        "inherit_closed_to_departure": true,
        "inherit_stop_sell": true,
        "inherit_min_stay_arrival": true,
        "inherit_min_stay_through": true,
        "inherit_max_stay": true,
        "inherit_max_availability": true,
        "inherit_availability_offset": true,
        "options": [
          {
            "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
            "occupancy": 3,
            "is_primary": true,
            "inherit_rate": true,
            "inherit_closed_to_arrival": true,
            "inherit_closed_to_departure": true,
            "inherit_stop_sell": true,
            "inherit_min_stay_arrival": true,
            "inherit_min_stay_through": true,
            "inherit_max_stay": true,
            "inherit_max_availability": true,
            "inherit_availability_offset": true,
            "derived_option": {
              "rate": [
                [
                  "increase_by_percent",
                  "5.00"
                ],
                [
                  "increase_by_amount",
                  "12.00"
                ]
              ]
            },
            "rate_category_id": "716305c4-561a-4561-a187-7f5b8aeb5920",
            "rate": "100.00"
          }
        ],
        "auto_rate_settings": {
          "increase_mode": "$",
          "decrease_mode": "$",
          "increase_value": "10.00",
          "decrease_value": "5.00"
        },
        "children_fee": "0.00",
        "infant_fee": "0.00",
        "max_stay": [
          1
        ],
        "min_stay_arrival": [
          1
        ],
        "min_stay_through": [
          1
        ],
        "closed_to_arrival": [
          true
        ],
        "closed_to_departure": [
          true
        ],
        "stop_sell": [
          true
        ]
      },
      "relationships": {
        "room_type": {
          "data": {
            "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
            "type": "room_type"
          }
        },
        "property": {
          "data": {
            "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
            "type": "property"
          }
        },
        "tax_set": {
          "data": {
            "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
            "type": "tax_set",
            "attributes": {
              "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
              "title": "text"
            }
          }
        },
        "parent_rate_plan": {
          "data": {
            "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
            "type": "rate_plan"
          }
        },
        "channel": {
          "data": {
            "id": "716305c4-561a-4561-a187-7f5b8aeb5920",
            "type": "channel"
          }
        }
      }
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10,
    "total": 1,
    "order_by": "inserted_at",
    "order_direction": "desc"
  }
}