> For the complete documentation index, see [llms.txt](https://docs.channex.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.channex.io/api-v.1-documentation/rate-plans-collection/get-list-of-rate-plan-options-api.md).

# Get list of Rate Plan Options API

## List rate plan options

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

```json
{"openapi":"3.1.0","info":{"title":"Channex.io — Public API","version":"0.0.0"},"tags":[{"name":"Rate Plans","description":"Manage Rate Plans — pricing plans of how to sell Room Types: prices per occupancy, rate derivation rules, and per-weekday restriction defaults."}],"servers":[{"url":"https://app.channex.io/api/v1","description":"Production server","variables":{}},{"url":"https://staging.channex.io/api/v1","description":"Staging server","variables":{}}],"security":[{"UserApiKeyAuth":[]}],"components":{"securitySchemes":{"UserApiKeyAuth":{"type":"apiKey","in":"header","name":"user-api-key","description":"API key for programmatic access, sent in the `user-api-key` header."}},"schemas":{"Common.Scalars.id":{"type":"string","format":"uuid"},"Common.Pagination.OrderDirection":{"type":"string","enum":["asc","desc"],"description":"Sort direction for list results."},"RatePlans.RatePlanOptionResource":{"type":"object","required":["type","id","attributes"],"properties":{"type":{"type":"string","enum":["rate_plan"]},"id":{"$ref":"#/components/schemas/Common.Scalars.id"},"attributes":{"$ref":"#/components/schemas/RatePlans.RatePlanOption"}},"description":"A lightweight rate plan option for selectors — no relationships or pagination."},"RatePlans.RatePlanOption":{"type":"object","required":["id","title","occupancy","currency","meal_type","sell_mode","ui_read_only","parent_rate_plan_id","property_id","rate_category_id","room_type_id"],"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/Common.Scalars.id"}]},"title":{"type":"string"},"occupancy":{"allOf":[{"$ref":"#/components/schemas/Common.Scalars.positiveInt"}],"description":"Guest count of the primary occupancy option."},"currency":{"allOf":[{"$ref":"#/components/schemas/Common.Scalars.currency"}],"description":"Rate plan currency."},"meal_type":{"anyOf":[{"$ref":"#/components/schemas/RatePlans.MealType"},{"type":"null"}],"description":"Meal plan included in the rate plan, or null when none is set."},"sell_mode":{"$ref":"#/components/schemas/RatePlans.SellMode"},"ui_read_only":{"type":"boolean","description":"Whether the rate plan is shown as read-only in the Channex interface."},"parent_rate_plan_id":{"anyOf":[{"$ref":"#/components/schemas/Common.Scalars.id"},{"type":"null"}],"description":"UUID of the parent rate plan, if any."},"property_id":{"allOf":[{"$ref":"#/components/schemas/Common.Scalars.id"}],"description":"UUID of the property the rate plan belongs to."},"rate_category_id":{"anyOf":[{"$ref":"#/components/schemas/Common.Scalars.id"},{"type":"null"}],"description":"UUID of the associated rate category, if any."},"room_type_id":{"allOf":[{"$ref":"#/components/schemas/Common.Scalars.id"}],"description":"UUID of the room type the rate plan sells."}},"description":"A lightweight rate plan, as returned by the `/options` endpoint."},"Common.Scalars.positiveInt":{"type":"integer","format":"int32","minimum":1},"Common.Scalars.currency":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 4217 alphabetic currency code. See the `/currencies` endpoint for supported values."},"RatePlans.MealType":{"type":"string","enum":["none","all_inclusive","breakfast","lunch","dinner","american","bed_and_breakfast","buffet_breakfast","carribean_breakfast","continental_breakfast","english_breakfast","european_plan","family_plan","full_board","full_breakfast","half_board","room_only","self_catering","bermuda","dinner_bed_and_breakfast_plan","family_american","breakfast_and_lunch","lunch_and_dinner"],"description":"Meal plan included in the rate plan."},"RatePlans.SellMode":{"type":"string","enum":["per_room","per_person"],"description":"How the rate plan is sold. `per_room` — one price regardless of guest count; `per_person` — price depends on guest count."},"Common.Errors.Unauthorized":{"type":"object","required":["errors"],"properties":{"errors":{"type":"object","required":["code","title"],"properties":{"code":{"type":"string","enum":["unauthorized"]},"title":{"type":"string","enum":["Unauthorized"]}},"description":"Shape of a single JSON:API error object: a stable machine code plus a human-readable title."}},"description":"Authentication credentials are missing or invalid."},"Common.Errors.InvalidArguments":{"type":"object","required":["errors"],"properties":{"errors":{"$ref":"#/components/schemas/Common.Errors.InvalidArgumentsObject"}},"description":"The request has missing or invalid arguments; `details` lists the messages per argument."},"Common.Errors.InvalidArgumentsObject":{"type":"object","required":["code","title","details"],"properties":{"code":{"type":"string","enum":["bad_request"]},"title":{"type":"string","enum":["Bad Request"]},"details":{"type":"object","unevaluatedProperties":{"type":"array","items":{"type":"string"}},"description":"Maps each invalid argument to the list of validation messages for that argument."}},"description":"Error object for invalid request arguments, adding per-argument messages."}}},"paths":{"/rate_plans/options":{"get":{"operationId":"RatePlans_options","summary":"List rate plan options","description":"List rate plans as lightweight options for selectors. Not paginated. Rate plans a channel created for its own mapping are not listed.","parameters":[{"name":"filter[property_id]","in":"query","required":false,"description":"Return only the rate plans of this property.","schema":{"$ref":"#/components/schemas/Common.Scalars.id"},"explode":false},{"name":"filter[room_type_id]","in":"query","required":false,"description":"Return only the rate plans of this room type.","schema":{"$ref":"#/components/schemas/Common.Scalars.id"},"explode":false},{"name":"order[title]","in":"query","required":false,"description":"Order rate plans by title. Applied by default, ascending.","schema":{"$ref":"#/components/schemas/Common.Pagination.OrderDirection"},"explode":false}],"responses":{"200":{"description":"The request has succeeded.","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RatePlans.RatePlanOptionResource"}}},"description":"A plain data-array envelope without pagination — used by reference/dictionary endpoints."}}}},"401":{"description":"Authentication credentials are missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Common.Errors.Unauthorized"}}}},"422":{"description":"The request has missing or invalid arguments; `details` lists the messages per argument.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Common.Errors.InvalidArguments"}}}}},"tags":["Rate Plans"]}}}}
```
