Sign in

v1

latestSwagger 2.02026-07-14214688.6 KB
RatePlans

Get all the details for a specific rateplan in the hotel.

Read the details about a specific rateplan for the defined hotel.

get/api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}

Path parameters

hotelIdinteger required

The hotel id the rateplan belongs to.

rateplanCodestring required

The code of the rateplan you want to see details for.

Headers

App-Idstring required

Application identifier

App-Keystring required

Application key.

Response

Rateplan details for the given rateplan and hotel.

_linksobject

Collection of links to related resources

activeboolean

Defines if the rateplan has been ended and is expired

codestring

Code of the rateplan

commissionableboolean

Defines if this rateplan is setup with a commission

createdstring date-time

Timestamp the rateplan was created

day_useboolean

Defines if this rateplan is used for day use reservations

descriptionstring

Description of the rateplan

folio_namestring

Text defining how the room charges for this rateplan are shown on the folio and invoice for the guest

included_servicesstring[]

List of codes for the included services sold with this rateplan

is_yieldableboolean

Gives the information if this rateplan is Yieldable rateplan

market_codestring

The code of the market segment the rate plan is linked to

namestring

Name of the rateplan

noshow_policystring

The code of the noshow policy for this rateplan

suspendedboolean

Defines if a rateplan is suspended and no new reservations can be created for this rateplan at the moment

taxes_includedboolean

Defines if the daily rates include VAT or not

updatedstring date-time

Timestamp of when the rateplan was changed the last time

visibility'Public' | 'Negotiated'

Defines if this rateplan is visible to the public or only for specific customers