Skip to main content

Rental Cancelation Policy Items

Overview​

This resource represents Rental Cancelation Policy Items which describe the rules and penalties for the cancelation of Bookings for the specific Rental Cancelation Policy

Parameters​

NameTypeRead/WriteDescription
accountIntegerReadAccount's ID related to the Rental Cancelation Policy Item
rental_cancelation_policyIntegerReadRental Cancelation Policy's ID related to the Rental Cancelation Policy Item
idIntegerReadRental cancelation policy item's ID.
eligible_daysIntegerReadNumber of days before the check-in from which the penalty applies (For example, if there is only a single Item defined for a Policy with eligible_days as 30, penalty_percentage doesn't apply before 30 days prior to check-in, only from 30 days and less).
penalty_percentageDecimalReadPercentage of penalty from the booking price.
created_atTimeReadRental cancelation policy item's create time.
updated_atTimeReadRental cancelation policy item's update time.

List rental cancelation policy items​

List all rental cancelation policy items for given account(s).

GET /rental_cancelation_policy_items
response.json
{
"links": {
"rental_cancelation_policy_items.rental_cancelation_policy": "https://www.bookingsync.com/api/v3/rental_cancelation_policies/{rental_cancelation_policy_items.rental_cancelation_policy}"
},
"rental_cancelation_policy_items": [
{
"links": {
"rental_cancelation_policy": 1
},
"id": 1,
"eligible_days": 120,
"penalty_percentage": "10.0",
"created_at": "2026-08-12T03:04:38.543Z",
"updated_at": "2026-08-19T03:04:38.543Z"
}
]
}

Get a single rental cancelation policy item​

Returns a single rental cancelation policy item identified by ID.

GET /rental_cancelation_policy_items/:rental_cancelation_policy_item_id
response.json
{
"links": {
"rental_cancelation_policy_items.rental_cancelation_policy": "https://www.bookingsync.com/api/v3/rental_cancelation_policies/{rental_cancelation_policy_items.rental_cancelation_policy}"
},
"rental_cancelation_policy_items": [
{
"links": {
"rental_cancelation_policy": 1
},
"id": 1,
"eligible_days": 120,
"penalty_percentage": "10.0",
"created_at": "2026-08-12T03:04:38.544Z",
"updated_at": "2026-08-19T03:04:38.544Z"
}
]
}