Get list of Rate Plan Options API

List rate plan options

get

/rate_plans/options

List rate plans as lightweight options for selectors. Not paginated. Rate plans a channel created for its own mapping are not listed.

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

order[title]string · enumOptional

Sort direction for list results.

Possible values:

Responses

200

The request has succeeded.

application/json

A plain data-array envelope without pagination — used by reference/dictionary endpoints.

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/options

GET /api/v1/rate_plans/options 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",
        "occupancy": 3,
        "currency": "USD",
        "meal_type": "none",
        "sell_mode": "per_room",
        "ui_read_only": true,
        "parent_rate_plan_id": "716305c4-561a-4561-a187-7f5b8aeb5920",
        "property_id": "716305c4-561a-4561-a187-7f5b8aeb5920",
        "rate_category_id": "716305c4-561a-4561-a187-7f5b8aeb5920",
        "room_type_id": "994d1375-dbbd-4072-8724-b2ab32ce781b"
      }
    }
  ]
}