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

# getRate

`GET /getRate`

Returns the rate of the room type selected, based on the provided parameters

## Query parameters

- `roomTypeID` string, required
- `startDate` string, date, required
- `endDate` string, date, required
- `adults` integer
- `children` integer
- `detailedRates` boolean
- `promoCode` boolean

## Response `200`

200 Response

- GetRateResponse
  - `success` boolean — Returns if the request could be completed
  - `data` object — Rates details
    - `rateID` string — Rate ID
    - `isDerived` boolean — This rate has been derived from another rate
    - `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).
    - `roomRate` number — Base rate for the room, calculated based on the Room Type ID, selected dates, and promo code. This does not include additional guest charges
    - `totalRate` number — Total rate for the room, which includes the base rate (roomRate) plus additional costs for extra guests (adults and children)
    - `roomsAvailable` integer — Number of rooms available, based on the parameters provided
    - `daysOfWeek` string[], nullable
    - `roomRateDetailed` object[], nullable — Detailed information on the rates, if requested
      - `date` string, date
      - `rate` number — Base 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
      - `closedToDeparture` boolean
      - `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

---

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