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

OAuth Scopes:

public

Name	Type	Read/Write	Description
account	Integer	Read	Account's ID related to the Rental Cancelation Policy Item
rental_cancelation_policy	Integer	Read	Rental Cancelation Policy's ID related to the Rental Cancelation Policy Item
id	Integer	Read	Rental cancelation policy item's ID.
eligible_days	Integer	Read	Number 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_percentage	Decimal	Read	Percentage of penalty from the booking price.
created_at	Time	Read	Rental cancelation policy item's create time.
updated_at	Time	Read	Rental 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

OAuth Scopes:

public

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": "2025-03-17T22:18:31.166Z",
      "updated_at": "2025-03-24T22:18:31.166Z"
    }
  ]
}

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

OAuth Scopes:

public

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": "2025-03-17T22:18:31.167Z",
      "updated_at": "2025-03-24T22:18:31.167Z"
    }
  ]
}