API Reference

Field Reference

type: Identifies the type of response. Always "rate-plans" for this endpoint.

count: Number of rate plan objects returned in the data array.

data: An array containing rate plan objects.


ratePlanId: Unique identifier for the rate plan (typically a combination of group ID and room type).

ratePlanName: The display name of the rate plan (e.g., "Summer Bundle").

roomTypeId: The room type ID this rate plan applies to.

ratePlanGroupId: Identifier for the group the rate plan belongs to (used to logically group related rate plans).

defaultRate: The base nightly rate for the plan (used when no dynamic pricing overrides are set).

defaultMinStay: The minimum number of nights required to book under this rate plan by default.

includedOccupancy: Number of guests included in the base rate (if 0, occupancy-based pricing may not apply).

maximumOccupancy: Maximum number of guests allowed under this rate plan (if 0, follows room type default).

extraAdultRate: Additional charge per adult beyond the included occupancy (usually per night).

lockOffBedrooms: Number of bedrooms that are open/available when this rate is used (for partial availability or cost reduction).

isRateDerived: Boolean indicating whether this rate is derived from another rate plan (e.g., percentage adjustment).

isDefaultStopSell: Boolean indicating whether the rate plan is marked as stop-sell by default (i.e., not available for booking unless enabled).