Bookings

Preview a cancellation

What the guest would get back if they cancelled now. Changes nothing. Tell the guest the refund and get their go-ahead before cancelBooking.

get/v1/bookings/{booking_id}/cancellation_preview

Request

  • Base URL: https://threshold.rentals/api
  • URL: https://threshold.rentals/api/v1/bookings/{booking_id}/cancellation_preview
  • Auth: HTTP bearer

Path parameters

booking_idstring required

Response

The refund if cancelled now

booking_idstring
statusstring
cancellableboolean
tier_ends_atstring date-time nullable
as_ofstring date-time
notestring

Example response

{
  "refund": {
    "currency": "USD"
  },
  "retained": {
    "currency": "USD"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.