Rates
Nightly rates
Returns nightly rates calendar for rental, requested by houseId and roomTypeId (most rentals on Lodgify have only a single room type id). For a less detailed response (e.g. for quickly building a simple calendar UI), consider using the V1 version of this endpoint.
get/v2/rates/calendar
Request
- Base URLhttps://api.lodgify.com
- AuthAPI key in header X-ApiKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
houseIdinteger required
The ID of the house.
roomTypeIdinteger required
The ID of the room type (details for associated room types can be obtained in responses from Properties endpoints).
startDatestring required
The start date of the calendar. Rates start from this night (inclusive).
endDatestring required
The end date of the calendar. Rates go until this night (inclusive of this night).
Response
Success
Example response
{
"calendar_items": [
{
"prices": [
{
"price_per_day": 123.45,
"price_per_additional_guest": 123.45
}
]
}
],
"rate_settings": {
"fees": [
{
"price": {
"amount": 123.45
}
}
],
"taxes": [
{
"price": {
"amount": 123.45
}
}
],
"promotions": [
{
"price": {
"amount": 123.45
}
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.