Despegar.com - Hotels, flights, packages, cars, and more!

## Lists Rate Plans

**URL**: ```/v1/hotels/rate-plans/list```

### Goals

To list all the rate plans for a hotel.

### Notes

#### Linked Rate Plans

Rate plans can be linked, forming a parent ↔ child relationship. A linked (or child) rate plan may
adjust the rates of the parent rate plan, and inherit zero or more restrictions.

Inherited values cannot be updated.

Since there is no concept of inherited rate plans in the OpenTravel specification, 
this is the only place so far where the Despegar.com API has deviated from it.

#### Charge Type Code

Pay attention to the value of `@ChargeTypeCode`. It determines the way in which you
[update rates][Update Rates] later.

### Message Detail

#### Input: OTA_HotelRatePlanRQ

| Element                                       | Number | Description      |
|:----------------------------------------------|:-------|:-----------------|
| OTA_HotelRatePlanRQ                           |   1    | Root element |
| OTA_HotelRatePlanRQ / RatePlans               |   1    | Rate plan collection |
| RatePlans / RatePlan                          |   1    | Defines the criteria to identify the rate plan to be returned. |
| RatePlan / HotelRef                           |  0..1  | |
| @HotelCode                                    |   1    | The code of the hotel to query the rate plan. |

#### Output: OTA_HotelRatePlanRS

| Element                                       | Number | Description      |
|:----------------------------------------------|:-------|:-----------------|
| OTA_HotelRatePlanRS                           |   1    | Root element |
| OTA_HotelRatePlanRQ / RatePlans               |   1    | Rate plan collection |
| @HotelCode                                    |   1    | The code of the hotel to be queried. |
| RatePlans / RatePlan                          |        | All the information of a specific rate plan.|
| @RatePlanCode                                 |   1    | Identifier code of the rate plan. |
| @ChargeTypeCode                               |   1    | Indicates how the rate is applied. Refer to OpenTravel [Charge Type (CHG)](http://adriatic.pilotfish-net.com/ota-modelviewer/model/codelists/ota?term=CHG) code table. Despegar.com supports only the following values:  <ul><li>"19": Per room per night </li><li>"21": Per person per night </li></ul> | 
| @CurrencyCode                                 |   1    | ISO 4217 currency code. Example: USD, ARG, EUR.| 
| @AdjustedAmount                               |  0..1  | The amount used to determine the price of the linked rate plan |
| @AdjustedPercentage                           |  0..1  | The percentage used to determine the price of the linked rate plan|
| @AdjustUpIndicator                            |  0..1  | Indicates if the adjustment is positive or negative. Possible values: <ul><li> True: indicates the adjustment is positive </li><li> False: indicates the adjustment is negative </li></ul>|
| @BaseRatePlanCode                             |   1    | The rate plan from which rates are derived |
| RatePlan / Description                        | | |
| Description / Text                            |        | Rate Plan name |
| RatePlan / Rates                              |        | |
| Rates / Rate                                  |  0..n  | Rate element included for age range definition purposes only.|
| @AgeQualifyingCode                            |   1    | The age qualifier to be defined. Refer to OpenTravel [Age Qualifying Code (AQC)](http://adriatic.pilotfish-net.com/ota-modelviewer/model/codelists/ota?term=AQC) code table. Despegar.com supports only the following values: <ul><li>"10": Adult</li><li>"8": Child </li><li>"7": Infant </li></ul>|
| @AgeTimeUnit                                  |   1    | The age time unit. Possible values: <ul><li>"Year": Ages expressed in years</li></ul> |
| @MinAge                                       |   1    | The minimum age considered in this range. This value is **inclusive**. |
| @MaxAge                                       |  0..1  | The maximum age considered in this range. This value is **exclusive** and is not defined for the adult range. |
| RatePlan / LinkedRestrictions                 |  0..1  | Indicates if this is a linked rate plan, which restrictions are inherited. Values of inherited restrictions: <ul><li> MinLos </li><li> MaxLos </li><li> CloseToArrival </li><li> CloseToDeparture </li></ul> |
| @MinLos                                       |   1    | Indicates if minimum nights is inherited or not. Values: <ul><li> True: Indicates restriction is inherited and cannot be updated. </li><li> False: Indicates restriction is not inherited and can be updated.</li></ul> |
| @MaxLos                                       |   1    | Indicates if maximum nights is inherited or not. Values: <ul><li> True: Indicates restriction is inherited and cannot be updated. </li><li> False: Indicates restriction is not inherited and can be updated. </li></ul> |
| @CloseToArrival                               |   1    | Indicates if close to arrival is inherited or not. Values: <ul><li> True: Indicates restriction is inherited and cannot be updated. </li><li> False: Indicates restriction is not inherited and can be updated. </li></ul> |
| @CloseToDeparture                             |   1    | Indicates if close to arrival is inherited or not. Values: <ul><li> True: Indicates restriction is inherited and cannot be updated. </li><li> False: Indicates restriction is not inherited and can be updated. </li></ul> |

[Update Rates]: </portal/documentation/update-rates>