Get Venue Rate Plan Booking Rules

Get Rate Plan Booking Rules

Get Rate Plan Booking Rules

POST [PlatformAddress]/api/1.0/venue?action=getRatePlanBookingRules

Return the rate plan booking rules for the given date and optionally room ids.

Request Body

Name	Type	Description
venueId*	integer	The unique id of the venue to which the room belongs.
startDate*	date	The start date of the rate plan rule which it applies to.
endDate*	date	The end date of the rate plan rule which it applies to.
roomIds	array	The room ids to filter the rate plan rule.

200

{
    "meta": {
        "totalResults": 3,
        "start": 0,
        "perPage": 3,
        "count": 3
    },
    "results": [
        {
            "barId": 1,
            "roomId": 6,
            "date": "2026-05-09",
            "closeOutStatus": 2
        },
        {
            "barId": 1,
            "roomId": 6,
            "date": "2026-05-10",
            "closeOutStatus": 2
        },
        {
            "barId": 1,
            "roomId": 6,
            "date": "2026-05-11",
            "closeOutStatus": null
        }
    ]
}

Date Range Restrictions

• startDate and endDate: The maximum date range is 31 days. Past dates are not allowed.

Returns

A collection object with the following properties in result

Property	Data Type	Description
barId	string	The unique id of the rate plan
date	date	The date of the rate plan rule which it applies to
roomId	integer	The unique id of the room
closeOutStatus	integer	The close out status of the rate plan rule on the given date