Cancel a reservation

Moves a reservation from open, quote, pending, pending-reserved, no-show, no-show-paid or cancelled-paid to cancelled. Any other status (for example rental, completed or cancelled) returns a business error.

Cancellation fee. cancellation_fee is calculated and saved on the reservation: the price of the cancellation insurance when the customer booked one, otherwise the cancellation fee from your settings (a fixed amount, an amount per day, a percentage of the total price or a number of days at the base daily rate).

Side effects

Sends the cancellation email to the customer, unless cancellation emails are disabled.

Detaches the assigned vehicle.

Saves a cancelled revision of the rental agreement and recalculates the reservation totals.

Fires the car_rental_reservation_cancelled and car_rental_reservation_status_updated webhooks.

Clears every stored Idempotency-Key of your account, not only this reservation's. A confirm retried after any cancellation is not deduplicated.

Returns data.reservation, the updated reservation record.

Responses

🟢200OK

application/json

The reservation is now cancelled, or a business error with success: false when the current status does not allow it or check_payments found payments. The error message also mentions a zero total paid; that only applies when you send check_payments=1. HTTP 200 is also used for failures: always check success. When it is false, the body is an ErrorBusinessRule (status_code 410) or an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Examples

Reservation cancelledStatus does not allow cancelling

{
    "success": true,
    "status_code": 200,
    "errors": [],
    "data": {
        "reservation": {
            "id": 1052,
            "prefixed_id": "MIA1052",
            "status": "cancelled",
            "cancellation_fee": "25.00"
        }
    }
}

🟠404Record Not Found

🟠422Parameter Error

Request

Responses