Bookings

Cancel a booking or request

Cancel for the guest after they agreed to the refund from previewCancellation. Pass that refund as expected_refund; if it has changed, you get 409 refund_changed and nothing is cancelled. Not possible once the stay has started.

post/v1/bookings/{booking_id}/cancel

Request

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

Path parameters

booking_idstring required

Headers

Idempotency-Keystring required

Unique per attempt (e.g. a UUID). Retrying with the same key returns the original response instead of acting twice.

Request body

Response

The cancelled booking

idstring
confirmation_codestring
status'awaiting_payment' | 'pending_host_confirmation' | 'confirmed' | 'declined' | 'expired' | 'cancelled_by_guest' | 'cancelled_by_host' | 'cancelled_unpaid'
property_idstring
check_instring date
check_outstring date
host_confirm_bystring date-time
arrival_info_available_atstring date-time
arrival_info_sent_atstring date-time
special_requestsstring
host_messagestring
created_atstring date-time

Example response

{
  "check_in": "2026-11-13",
  "check_out": "2026-11-13",
  "total": {
    "currency": "USD"
  },
  "amount_paid": {
    "currency": "USD"
  },
  "amount_refunded": {
    "currency": "USD"
  },
  "refund_schedule": [
    {
      "refund": {
        "currency": "USD"
      }
    }
  ]
}

Changes

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