Get a rate plan list
Get the list of rate plans depending on client scopes.
If a client has no additional scopes, only public rate plans are returned.
The 'rateplans.read-corporate' scope adds corporate rate plans to the response.<br>You must have at least one of these scopes: 'rateplans.read, setup.read, setup.manage'.
Query parameters
Return rate plans for the specific property
Return rate plans filtered by requested codes
Return rate plans that have any of the requested included services
Return rate plans that are sold though any of the specified channels
Return rate plans that have any of the requested promo codes
Return rate plans filtered by requested companies
Return rate plans derived from any of the specified rate plans
Return rate plans with any of the specified unit groups
Return rate plans with any of the specified time slice definitions
Return rate plans with any of the specified unit group types
The time slice template, defaults to 'over night'
Return rate plans with any of the specified min guarantee types
Return rate plans with any of the specified cancellation policies
Return rate plans with any of the specified no-show policies
Return only derived or base rate plans
This will filter rate plans based on their derivation level.<br />You can provide an array of string expressions which all need to apply.<br />Each expression has the form of 'OPERATION_VALUE' where VALUE needs to be of the valid format of the property type and OPERATION can be:<br />'eq' for equals<br />'neq' for not equals<br />'lt' for less than<br />'gt' for greater than<br />'lte' for less than or equals<br />'gte' for greater than or equals<br />For instance<br />'eq_5' would mean the value should equal 5<br />'lte_7' would mean the value should be less than or equal to 7
Return archived rate plans. Defaults to false
Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
Items per page. Default: 500. Maximum: 500.
List of all embedded resources that should be expanded in the response. Possible values are: property, unitGroup, cancellationPolicy, services, bookingPeriods, surcharges, ageCategories. All other values will be silently ignored.
Response
Return all rate plans available within the client scopes.
Example response
{
"ratePlans": [
{
"id": "MUC-NONREF-DBL",
"code": "NONREF",
"name": "Non Refundable",
"description": "Non Refundable",
"minGuaranteeType": "PM6Hold",
"priceCalculationMode": "Truncate",
"property": {
"id": "MUC",
"code": "MUC",
"name": "Demo Hotel Munich",
"description": "This is the demo hotel Munich"
},
"unitGroup": {
"id": "MUC-DBL",
"code": "DBL",
"name": "Double",
"description": "Double",
"type": "BedRoom"
},
"cancellationPolicy": {
"id": "MUC-FLE",
"code": "FLE",
"name": "Flexible",
"description": "Free cancellation until 36 hours before arrival."
},
"noShowPolicy": {
"id": "MUC-NONREF",
"code": "NONREF",
"name": "Non Refundable",
"description": "Non Refundable"
},
"channelCodes": [
"Direct",
"BookingCom",
"Ibe"
],
"promoCodes": [
"APA55100"
],
"timeSliceDefinition": {
"id": "MUC-NIGHT",
"name": "Over Night",
"template": "OverNight",
"checkInTime": "17:00:00",
"checkOutTime": "10:00:00"
},
"isBookable": false,
"isSubjectToCityTax": false,
"isDerived": false,
"derivationLevel": 0,
"ratesRange": {
"from": "2026-09-13",
"to": "2026-09-23"
},
"accountingConfigs": [
{
"state": "Unknown",
"vatType": "ReducedCovid19",
"serviceType": "FoodAndBeverages",
"validFrom": "2026-09-03"
}
],
"marketSegment": {
"id": "CORP",
"code": "CORP",
"name": "Corporate Groups"
}
},
{
"id": "MUC-FLEX-DBL",
"code": "FLEX",
"name": "Flexible",
"description": "Flexible",
"minGuaranteeType": "PM6Hold",
"priceCalculationMode": "Round",
"property": {
"id": "MUC",
"code": "MUC",
"name": "Demo Hotel Munich",
"description": "This is the demo hotel Munich"
},
"unitGroup": {
"id": "MUC-DBL",
"code": "DBL",
"name": "Double",
"description": "Double",
"type": "BedRoom"
},
"cancellationPolicy": {
"id": "MUC-FLE",
"code": "FLE",
"name": "Flexible",
"description": "Free cancellation until 36 hours before arrival."
},
"noShowPolicy": {
"id": "MUC-NONREF",
"code": "NONREF",
"name": "Non Refundable",
"description": "Non Refundable"
},
"channelCodes": [
"Direct",
"BookingCom",
"Ibe"
],
"timeSliceDefinition": {
"id": "MUC-NIGHT",
"name": "Over Night",
"template": "OverNight",
"checkInTime": "17:00:00",
"checkOutTime": "10:00:00"
},
"isBookable": false,
"isSubjectToCityTax": false,
"isDerived": false,
"derivationLevel": 0,
"accountingConfigs": [
{
"state": "Unknown",
"vatType": "ReducedCovid19",
"serviceType": "FoodAndBeverages",
"validFrom": "2026-09-03"
}
],
"marketSegment": {
"id": "LEISURE",
"code": "LEISURE",
"name": "Leisure Travelers"
},
"isArchived": true
}
],
"count": 0
}Changes
No recorded changes to this endpoint across all 2 revisions of this API.