Skip to main content

Booking Cancelation Protection Summaries

Overview​

This resource represents a read-only summary of a Booking's cancelation-protection related amounts. Each protected Booking has at most one Booking Cancelation Protection Summary, which consolidates the commissionable amount, the eligible protection amount, and the rent revenue amount into a single record alongside the cancelation policy that applied to the Booking.

These summaries are produced to support accounting reconciliation around cancelation protection. The monetary amounts are all expressed in cents in the Booking's currency.

This resource is read-only — it can only be listed and fetched, never created or modified through the API.

Parameters​

NameTypeRead/WriteDescription
bookingIntegerReadBooking's ID related to the Booking Cancelation Protection Summary.
idStringReadBooking Cancelation Protection Summary's id (UUID).
policyStringReadThe cancelation policy that applied to the Booking. One of flexible or non_refundable.
currencyStringReadCurrency code of the monetary amounts (e.g. "EUR").
booking_commissionable_amount_in_centsIntegerReadThe Booking's commissionable amount for computing Cancelation Protection fee amount
eligible_protection_amount_in_centsIntegerReadThe amount eligible for cancelation protection, in cents. Capped at 5,000,000 cents (50,000 in the Booking's currency).
booking_rent_revenue_amount_in_centsIntegerReadThe Booking's rent revenue amount, in cents.
churned_atTimeReadTime at which the Booking's cancelation protection was considered churned, or null if it has not churned.
created_atTimeReadBooking Cancelation Protection Summary's create time.
updated_atTimeReadBooking Cancelation Protection Summary's update time.

List booking cancelation protection summaries​

Required OAuth scope: :bookings_cancelation_protection_read

List all booking cancelation protection summaries for current account(s). Results are limited to summaries whose Booking belongs to a Rental accessible to the requesting application.

Supports the updated_since parameter for incremental synchronization. When updated_since is provided, the response meta includes the ids of records deleted since that timestamp.

GET /booking_cancelation_protection_summaries
response.json
{
  "links": {
    "booking_cancelation_protection_summaries.booking": "https://www.bookingsync.com/api/v3/bookings/{booking_cancelation_protection_summaries.booking}"
  },
  "booking_cancelation_protection_summaries": [
    {
      "links": {
        "booking": 200
      },
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "policy": "flexible",
      "currency": "EUR",
      "booking_commissionable_amount_in_cents": 120000,
      "eligible_protection_amount_in_cents": 100000,
      "booking_rent_revenue_amount_in_cents": 96000,
      "churned_at": null,
      "created_at": "2025-01-20T10:30:00Z",
      "updated_at": "2025-01-20T10:30:00Z"
    }
  ],
  "meta": {}
}

Get a single booking cancelation protection summary​

Required OAuth scope: :bookings_cancelation_protection_read

Returns a single booking cancelation protection summary identified by ID.

GET /booking_cancelation_protection_summaries/:booking_cancelation_protection_summary_id
response.json
{
  "links": {
    "booking_cancelation_protection_summaries.booking": "https://www.bookingsync.com/api/v3/bookings/{booking_cancelation_protection_summaries.booking}"
  },
  "booking_cancelation_protection_summaries": [
    {
      "links": {
        "booking": 200
      },
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "policy": "flexible",
      "currency": "EUR",
      "booking_commissionable_amount_in_cents": 120000,
      "eligible_protection_amount_in_cents": 100000,
      "booking_rent_revenue_amount_in_cents": 96000,
      "churned_at": null,
      "created_at": "2025-01-20T10:30:00Z",
      "updated_at": "2025-01-20T10:30:00Z"
    }
  ],
  "meta": {}
}