---
title: "getRatePlans"
method: GET
path: "/getRatePlans"
tags: ["Rate"]
---

# getRatePlans

`GET /getRatePlans`

Returns the rates of the room type or promo code selected, based on the provided parameters. If no parameters are provided, then the method will return all publicly available rate plans. ### Group account support

## Query parameters

- `propertyIDs` string
- `rateIDs` string
- `roomTypeID` string
- `promoCode` string
- `includePromoCode` boolean
- `startDate` string, date, required
- `endDate` string, date, required
- `adults` integer
- `children` integer
- `detailedRates` boolean
- `includeSharedRooms` boolean

## Response `200`

200 Response

- GetRatePlansResponse
  - `success` boolean — Returns if the request could be completed
  - `data` object[] — Rates details
    - `rateID` string — Rate ID
    - `isDerived` boolean — True if this rate is derived from another rate
    - `roomRate` number — Rate for the room, based on the parameters provided
    - `totalRate` number — Total rate for the room, based on the parameters provided. Calculated using base rates and additional costs from extra guests.
    - `roomsAvailable` integer — Number of rooms available for the selected date
    - `roomTypeID` string, nullable — ] room type ID (if not specified in request)
    - `roomTypeName` integer, nullable — ] room type name (if not specified in request)
    - `propertyID` string, nullable — Property ID, used if multiple properties are included in request
    - `ratePlanID` string, nullable — ratePlanID (If rate depends on plan)
    - `ratePlanNamePublic` string, nullable — ratePlanNamePublic
    - `ratePlanNamePrivate` string, nullable — ratePlanNamePrivate
    - `promoCode` string, nullable — Promotional code when rate plan has has it
    - `derivedType` 'fixed' | 'percentage', nullable — type of deriving (only if current rate was derived from other one).
    - `derivedValue` number, nullable — Can be positive or negative (only if current rate was derived from other one).
    - `baseRate` number, nullable — Base rate on given period
    - `parentRateID` string, nullable — Rate ID of the parent rate row (null when rate is not derived).
    - `parentRatePlanID` string, nullable — Package ID of the parent rate plan (null when not derived or derived from the room-type base rate).
    - `parentRatePlanNamePublic` string, nullable — Public name of the parent rate plan (null when parentRatePlanID is null).
    - `parentRatePlanNamePrivate` string, nullable — Private/internal name of the parent rate plan (null when parentRatePlanID is null).
    - `daysOfWeek` string[], nullable — Returns when there is a difference between range given with startDate/endDate and days of week which rate plan applies.
    - `addOns` object[] — addOns information on the rates
      - `addOnID` string — addOnID
      - `addOnName` string — addOnName
      - `itemID` string — itemID
      - `itemName` string — itemName
    - `roomRateDetailed` object[], nullable — Detailed information on the rates, if requested
      - `date` string, date
      - `rateBase` number, nullable — rate for the selected date
      - `totalRate` number — Total rate for the selected date
      - `roomsAvailable` integer — Number of rooms available for the selected date
      - `closedToArrival` boolean — true if day closed to arrival
      - `closedToDeparture` boolean — true if day closed to departure
      - `blocked` boolean — Whether the accommodation is blocked. Mirrors /patchRate `blocked` parameter and reflects the operator-set restriction only.
      - `minLos` integer — Minimum Length Of Stay
      - `maxLos` integer — Maximum Length Of Stay
      - `cutOff` integer
      - `lastMinuteBooking` integer
  - `message` string, nullable — To be used in case any error occurs (if success = false). If success = true, it does not exist.

---

[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)