---
title: "GetRatePlans"
method: POST
path: "/GetRatePlans"
tags: ["Rooms & Rate Plans"]
---

# GetRatePlans

`POST /GetRatePlans`

Cloudbeds uses this call to retrieve a list of rate plans, which are
either specific to each room, or global for all rooms.

## Request body

- object
  - `mya_property_id` integer, required — Property ID on the Cloudbeds channel manager
  - `ota_property_id` string, required — Username, login or property ID on the OTA
  - `ota_property_password` string, required — Password for property on your OTA. In case the OTA does not use passwords this will be an empty string.
  - `ota_property_sub_id` string, required — Property ID on the OTA, if OTA supports multiple properties under one `ota_property_id`/`ota_property_password` combination. See `GetSubProperties` for more details.
  - `guid` string, required — Request reference ID, used for debugging and support requests.
  - `shared_secret` string, required — Authentication between the OTA and the channel. Identical for all requests. Not to be shared with customers.
  - `ota_cid` string, required — OTA ID as given by Cloudbeds
  - `verb` 'GetRatePlans', required

## Response `200`

GetRatePlans

- union
  - object
    - `success` true, required
    - `RatePlans` object[], required — List of rate plans on the OTA.
      - `ota_room_id` string, required — Room ID on the OTA tied to the rate plan. If the rate plan is available to all rooms set this to `0`.
      - `ota_rate_id` string, required — Rate plan ID on the OTA. Cannot be `0`, empty string or otherwise falsy.
      - `title` string, required — Name, label or short summary of the rate plan
  - ResponseError
    - `errors` object[], required — Array of error objects.
      - `id` integer, required — Error code. Check the "Error Codes" section of the specification for valid codes.
      - `msg` string — Optional error string to give more details about the error. Myallocator localises errors into different langauges, so this field is generally ignored and only useful for debugging.
    - `success` false, required

---

[API](https://skmtc.net/cloudbeds/apis/cloudbeds-api.md) · [All operations](https://skmtc.net/cloudbeds/apis/cloudbeds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudbeds/cloudbeds-api/revisions/2faa857793e8/schema)