Cancellation conditions
Make it flexible
- Configure cancellation policies per apartment
- If you have the same cancellation policies for each apartment, they can be configured on your account level.
- To update the cancellation policies, you need to push the entire object, partially updates are not possible.
How to use cancellation policies
- There has to be at least one cancellation policy defined with
"daysBeforeArrival":0, which covers cancellations on the check-in day. Cancellations after that, including no-shows, and any cancellation after your last policy are charged 100%. - We recommend to not configure more than 3 different policies in order to keep the structure clear and understandable for the customer.
- Be aware that your payment rates and cancellation policies are configured in sync.
The object cancellation policy
| Field | Type | Required | Usage |
|---|---|---|---|
"daysBeforeArrival" | int32 | YES | Last day of this policy, counted in days before arrival: the fee applies to cancellations up to and including that day, starting the day after the policy with the next larger value ends |
"cancellationFeeInPercent" | double | YES | A percentage of the booking amount that is cancellation fee, meaning this percentage need to be paid by the customer |
Examples
No free cancellation offered
The apartment doesn't offer a free cancellation option and the total booking amount is 1000€.
[
{
"daysBeforeArrival": 30,
"cancellationFeeInPercent": 50
},
{
"daysBeforeArrival": 7,
"cancellationFeeInPercent": 80
},
{
"daysBeforeArrival": 0,
"cancellationFeeInPercent": 100
}
]
- If the customer cancels 30 or more days before check-in (from the day of booking up to and including the 30th day before check-in), the cancellation fee is 50% of the total booking amount (500€).
- If the customer cancels 29 to 7 days before check-in, the cancellation fee is 80% of the total booking amount (800€).
- If the customer cancels 6 days or less before check-in, on the check-in day or does not show up, the customer has to pay the total booking amount 100% (1000€) as the cancellation fee.
Free cancellation offered
The apartment offeres a free cancellation option and the total booking amount is 1000€.
[
{
"daysBeforeArrival": 60,
"cancellationFeeInPercent": 0
},
{
"daysBeforeArrival": 30,
"cancellationFeeInPercent": 50
},
{
"daysBeforeArrival": 7,
"cancellationFeeInPercent": 80
},
{
"daysBeforeArrival": 0,
"cancellationFeeInPercent": 100
}
]
- If the customer cancels 60 or more days before check-in (from the day of booking up to and including the 60th day before check-in), the cancellation fee is 0% of the total booking amount (0€).
- If the customer cancels 59 to 30 days before check-in, the cancellation fee is 50% of the total booking amount (500€).
- If the customer cancels 29 to 7 days before check-in, the cancellation fee is 80% of the total booking amount (800€).
- If the customer cancels 6 days or less before check-in, on the check-in day or does not show up, the customer has to pay the total booking amount 100% (1000€) as the cancellation fee.
- When you work with Holidu Payment it is necessary that you set 100% cancellation fee at least for the check-in date. Until 1 day before checkin date cancellation fee can be any percentage (from 0 to 100%).
Using optional fieldrateId with Cancellation Conditions (only to be used when pushingNON_REFUNDABLE and REFUNDABLE rates in LOS)
a) Delete Cancellation Conditions for an apartment (DELETE/v2/apartments/cancellation-policy)
You can delete cancellation conditions for a specific rate by adding rateId in your DELETE request:
Example Request:
DELETE v2/apartments/cancellation-policy?providerApartmentId=ABC123&rateId=NON_REFUNDABLE
Notes:
- If
rateIdis provided, only cancellation conditions for that specific rate will be deleted. - If
rateIdis omitted, the default/main cancellation conditions will be affected.
b) Get Cancellation Conditions for an apartment (GETv2/apartments/cancellation-policy)
You can retrieve cancellation conditions for a specific rate by including rateId:
Example Request:
GET v2/apartments/cancellation-policy?providerApartmentId=ABC123&rateId=NON_REFUNDABLE
Response:
- You will receive cancellation conditions filtered for the provided rateId.
- If
rateIdis omitted, you will get the default/main cancellation conditions.
c) Create or Update Cancellation Conditions for an apartment (POSTv2/apartments/cancellation-policy)
When creating or updating cancellation conditions, you can assign conditions to a specific rate by including rateId in the body:
Example Request Body:
[
{
"daysBeforeArrival": 30,
"cancellationFeeInPercent": 0,
"rateId": "REFUNDABLE"
},
{
"daysBeforeArrival": 15,
"cancellationFeeInPercent": 50,
"rateId": "REFUNDABLE"
},
{
"daysBeforeArrival": 1,
"cancellationFeeInPercent": 100,
"rateId": "REFUNDABLE"
},
{
"daysBeforeArrival": 0,
"cancellationFeeInPercent": 100,
"rateId": "NON_REFUNDABLE"
}
]
| Field | Type | Description |
|---|---|---|
"rateId" | string | Identifier of the rate (optional) |
"daysBeforeArrival" | integer | Last day of this policy, counted in days before arrival (inclusive); the policy starts the day after the one with the next larger value ends |
"cancellationFeeInPercent" | number | Booking percentage which is non-refundable |
✅ If you provide rateId → only affect that rate’s cancellation conditions.
✅ If you omit it → affect the default/main one.