CLcloudbeds
Rate

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. Rate plans attached to an allotment block are never returned by this endpoint, even when their IDs are passed in rateIDs. Allotment-block rates are group inventory, not publicly sellable inventory. Their IDs do appear elsewhere (for example the rateID of a room on a group reservation), so an ID that cannot be resolved here is not a mapping error: use /getAllotmentBlocks, which returns the block's rate plan ID as ratePlanId and the rate IDs that reservations carry as allotmentIntervals[].rateId, together with allotmentBlockCode, allotmentBlockName, allotmentBlockStatus and the per-interval rates. Deleted rate plans are not returned by this endpoint and /getAllotmentBlocks omits deleted blocks, so an ID that resolves in neither endpoint belongs to a deleted rate plan or a deleted (archived) allotment block. ### Group account support

get/getRatePlans

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/getRatePlans
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code
      Scopes: read:rate

Query parameters

propertyIDsstring

List of property IDs, comma-separated, i.e. 37,345,89

rateIDsstring

List of Rate IDs, comma-separated, i.e. 37,345,89

roomTypeIDstring

List of Room Type IDs, comma-separated, i.e. 37,345,89

promoCodestring

List of Promo Codes, comma-separated, i.e. 37,345,89

includePromoCodeboolean

Include rate plans with promo code

startDatestring date required

Check-in date

endDatestring date required

Check-out date

adultsinteger

Number of adults

childreninteger

Number of children

detailedRatesboolean

If the rates need detailed information

includeSharedRoomsboolean

Include shared rooms in the result for multiple adults/children

Response

200 Response

successboolean

Returns if the request could be completed

messagestring nullable

To be used in case any error occurs (if success = false). If success = true, it does not exist.

Changes

No recorded changes to this operation across all 2 revisions of this API.