GetAllCancelledPolicies

What it does: Returns a paginated list of all cancelled policies associated with your account.

POST /insurances/getAllCancelledPolicies

Example request

POST

curl -i -X POST \
  -H "X_API_KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"FromDate": "2025-01-01 00:00:00", "ToDate": "2025-06-30 23:59:59", "Page": 1}' \
  https://api-staging.rentalcover.com/insurances/getAllCancelledPolicies

Response

{
   "MetaData":{
      "TotalItems":1,
      "TotalPages":1,
      "CurrentPage":1,
      "ItemsPerPage":1000,
      "Links":{
         "FirstPage":"https://api-testing.rentalcover.com/insurances/getAllCancelledPolicies/page/1"
      }
   },
   "Bookings":[
      {
         "Booking":{
            "BookingId":"2395636",
            "Reference":"026J-88W5-INS",
            "CancelledOn":"2018-06-28 15:23:39"
         }
      }
   ]
}{
   "MetaData":{
      "TotalItems":1,
      "TotalPages":1,
      "CurrentPage":1,
      "ItemsPerPage":1000,
      "Links":{
         "FirstPage":"https://api-testing.rentalcover.com/insurances/getAllCancelledPolicies/page/1"
      }
   },
   "Bookings":[
      {
         "Booking":{
            "BookingId":"2395636",
            "Reference":"026J-88W5-INS",
            "CancelledOn":"2018-06-28 15:23:39"
         }
      }
   ]
}

Request Parameters

Parameter	Required?	Description
FromDate	Optional	Start of the modification-date filter.
ToDate	Optional	End of the modification-date filter.
Page	Optional	Page index. Default: 1. Each page contains up to 1,000 items.

Date filter

FromDate and ToDate filter by each booking's last-modification date, not by protection start or end date.

Response

Pagination metadata

Field	Type	Description
MetaData.TotalItems	integer	Total number of matching cancelled bookings.
MetaData.TotalPages	integer	Total number of pages.
MetaData.CurrentPage	integer	Current page index.
MetaData.ItemsPerPage	integer	Number of items per page (1,000 max).

Booking items

Each entry in the Bookings array

Field	Type	Description
Bookings[].Booking.BookingId	string	Internal booking ID.
Bookings[].Booking.Reference	string	Booking reference.
Bookings[].Booking.CancelledOn	datetime	Date and time the protection was cancelled.