Check car rental availability Beta

Use the /cars/availability endpoint to retrieve detailed availability, pricing, and policy information for a specific car rental offer returned by the /cars/search endpoint.

The /cars/availability endpoint returns the latest details for a car rental offer identified in a previous /cars/search response.

The response can include:

• The current vehicle price and price breakdown.
• Payment timing and credit card requirements.
• Cancellation, fuel, mileage, deposit and excess policies.
• Optional extras and their availability.
• Deal and special-offer information.
• Pickup and drop-off route details.
• Available third-party insurance and legal documents.
• Estimated commission, when enabled for the partner.

Use this endpoint before presenting the final offer to the traveller and before starting the booking flow.

Use /cars/availability after calling /cars/search and before calling /orders/preview.

A typical flow is:

1. Call /cars/search.
2. Let the traveller select a car offer.
3. Call /cars/availability using the selected offer and matching search_token.
4. Display the latest price, policies, payment requirements and available extras.
5. Optionally select insurance and extras.
6. Call /orders/preview using the availability information.
7. Create the order using /orders/create.

{
  "offer": 740171366,
  "search_token": "eyJhbGciOiJIUzI1NiJ9.eyJwIjp7InNlYXJjaF9rZXkiOiJleU...",
  "language": "en-gb",
  "currency": "GBP"
}

A successful response returns HTTP 200 and includes a request_id for troubleshooting and a data object containing the offer details:

The policies object describes the rules that apply to the selected vehicle.

The cancellation.type field indicates whether the rental is refundable:

• free_cancellation – Free cancellation is available under the conditions in details.
• non_refundable – The rental is non-refundable.

For free-cancellation policies, use the following fields to create a traveller-friendly description:

• details.context – The context in which free cancellation applies, such as before_pickup.
• details.duration – The applicable period in ISO 8601 duration format, such as PT48H or P7D.

For example, PT48H with before_pickup means that free cancellation is available up to 48 hours before pickup.

The following fields can contain monetary amounts or null:

• deposit.amount – The amount temporarily pre-authorised or blocked on the traveller’s credit card at the rental location.
• damage_excess.amount – The maximum amount the traveller may be charged for damage.
• theft_excess.amount – The maximum amount the traveller may be charged if the vehicle is stolen.

Always display the currency returned with the amount.

insurance_package indicates the supplier insurance package included with the vehicle. Possible values are:

• basic
• inclusive
• zero_excess

fuel identifies the fuel policy. Possible values include:

• return_same
• return_same_or_prepay_no_refunds
• return_same_preauth
• free_tank
• prepay_no_refunds
• prepay_part_refunds
• prepay_refunds

The values correspond to the fuel policies returned by /cars/constants.

The mileage object describes the distance included in the rental.

• type – limited or unlimited.
• distance_limit – Maximum distance allowed when the policy is limited. This can be null.
• distance_unit – kilometers or miles.
• amount – Amount charged when the distance limit is exceeded. This can be null.
• currency – Currency of the excess mileage charge. This can be null.

Display the original distance unit returned by the supplier. If you convert it for display, also show the original unit because the rental agreement is based on it.

The payment.timing field indicates when the vehicle payment is made:

• pay_online_now
• pay_partial_online_now
• pay_at_pickup

The price object contains the vehicle price and charge breakdown.

• base – Base price of the vehicle.
• total – Total price of the vehicle.
• credit_card_required – Indicates whether a credit card is required as a guarantee.
• extra_charges – Additional charges included in the total price.

The credit_card_required field indicates whether a credit card is required as a guarantee:

• true – A credit card must be provided as a guarantee to the supplier.
• false – A credit card is explicitly not required.
• null – The information is unavailable or not applicable.

Use the currency returned in each monetary amount. Do not assume that the display amount and payment amount are always the same.

The products array lists optional extras available for the vehicle, such as additional drivers, child seats and GPS devices.

Each product can include:

• id – Unique identifier of the optional product. Use this identifier when selecting the product for the order.

• type – Type of optional extra (e.g., baby_seat_included, gps)

• mode – How the price is calculated:

  • each_per_day
  • each_per_rental
  • per_day
  • per_rental

• maximum_available – Maximum number of units that can be selected for the booking.

• price.unit_amount.display– Amount displayed to the traveller for one unit.

• price.unit_amount.pay – Amount to be paid, including payment timing.

The pay object can include:

• value
• currency
• timing

The deal object contains information about applied deals. It is null when no deal applies.

It can include:

• tags – Applied deal tags, such as black_friday, getaway_deal or mobile_rate.
• discount_percentage – Discount percentage applied.
• public_price – Original price before the discount.

special_offer identifies a special offer included with the vehicle. Possible values include:

• one_additional_driver
• two_additional_drivers
• three_additional_drivers
• all_additional_drivers
• gps
• baby_or_child_seat
• priority_pickup
• wifi_device
• sim_card
• upgrade
• black_friday
• getaway_deal
• mobile_rate

The value is null when no special offer applies.

The route object identifies the pickup and drop-off locations for the offer.

Each route point can include:

• depot – Identifier of the depot.
• depot_location_type – Type of location, such as in_terminal, car_rental_centre, shuttle_bus or meet_greet.

Use this information together with /cars/depots to display the relevant pickup and drop-off details.

The insurance object contains a bookable third-party insurance product when insurance is available for the selected offer and enabled for the partner. It is null when insurance is unavailable.

When present, the object includes:

• quote_reference – Unique reference for the insurance quote. The quote expires after 90 minutes.
• name – Display name of the insurance product.
• id – Insurance product identifier.
• price.display – Price displayed to the traveller.
• price.pay – Amount to be paid and payment timing.
• coverage_amount – Maximum coverage amount.
• documents – Legal insurance documents.

The documents array contains the legal documents available for the insurance product, including policy_document and, where applicable, ipid.

Display or link to the legal documents before the traveller confirms the insurance product.

The optional estimated_commission object contains a predictive estimate of the commission the partner may earn if the traveller books the vehicle.

It is returned only when:

• The estimated commission feature is enabled for the partner.
• A reliable estimate is available.

The estimate includes an amount and currency. It is not returned when the feature is unavailable or when an estimate cannot be produced.

{
  "request_id": "01k1deq3e5b41da80f28yybhz0",
  "data": {
    "offer": 740171366,
    "currency": "GBP",
    "policies": {
      "cancellation": {
        "type": "free_cancellation",
        "details": {
          "context": "before_pickup",
          "duration": "PT48H"
        }
      },
      "deposit": {
        "amount": 1500
      },
      "damage_excess": {
        "amount": 1500
      },
      "theft_excess": {
        "amount": 1500
      },
      "insurance_package": "inclusive",
      "fuel": "return_same",
      "mileage": {
        "type": "limited",
        "distance_limit": 200,
        "distance_unit": "miles",
        "amount": 0.3,
        "currency": "GBP"
      },
      "payment": {
        "timing": "pay_online_now"
      }
    },
    "price": {
      "base": 74.4,
      "total": 194.4,
      "credit_card_required": false,
      "extra_charges": [
        {
          "charge": "aged_driver_fee",
          "total_amount": 120
        }
      ]
    },
    "products": [
      {
        "id": "14383444201010",
        "type": "additional_driver",
        "maximum_available": 3,
        "mode": "each_per_rental",
        "price": {
          "unit_amount": {
            "display": {
              "value": 20,
              "currency": "GBP"
            },
            "pay": {
              "value": 20,
              "currency": "GBP",
              "timing": "pay_at_pickup"
            }
          }
        }
      }
    ],
    "deal": null,
    "special_offer": "upgrade",
    "supplier": 3486,
    "route": {
      "pickup": {
        "depot": 243816,
        "depot_location_type": "meet_greet"
      },
      "dropoff": {
        "depot": 243816,
        "depot_location_type": "meet_greet"
      }
    },
    "insurance": {
      "quote_reference": "38ddeef-a7fb-4e24-a1e2-66fc3af23d76#1t0juiba8h6n2",
      "name": "Full Protection",
      "id": "999",
      "price": {
        "display": {
          "value": 114.24,
          "currency": "GBP"
        },
        "pay": {
          "value": 114.24,
          "currency": "EUR",
          "timing": "pay_online_now"
        }
      },
      "coverage_amount": {
        "value": 60000,
        "currency": "EUR"
      },
      "documents": [
        {
          "name": "policy_document",
          "url": "https://example.com/policy-document.pdf"
        },
        {
          "name": "ipid",
          "url": "https://example.com/ipid.pdf"
        }
      ]
    },
    "estimated_commission": {
      "amount": 12.5,
      "currency": "GBP"
    }
  }
}

✅ Use the matching offer and search token.

• Always send the offer ID and the search_token returned by the same /cars/search response. If the token is invalid or expired, run the search again.

✅ Display payment requirements clearly.

• Use both:
  • policies.payment.timing
  • price.credit_card_required

This allows travellers to understand when payment is due and whether a credit card is required as a guarantee.

✅ Preserve the original currencies and units.

• Display the currency and mileage unit returned by the API.
• If you convert values for localisation, also show the original value where it is relevant to the rental agreement.

✅ Handle optional values.

The following fields may be null or omitted depending on the offer and partner configuration:

• deal
• insurance
• estimated_commission
• credit_card_required
• Deposit and excess amounts.
• Mileage distance limits and excess charges.

✅ Store identifiers required for order creation.

• offer
• search_token
• Product id values for selected extras.
• Insurance quote_reference when insurance is selected.

These values may be required by /orders/preview and /orders/create.

✅ Interpret cancellation rules:

• Use the context and duration fields to generate user-friendly cancellation messages (for example: “Free cancellation up to 48 hours before pickup”).

✅ Log the request_id:

• Log request_id for troubleshooting and include it when contacting support.

After retrieving availability and displaying the latest offer details:

1. Let the traveller select any optional extras or insurance.
2. Use /orders/preview to validate the selected offer and calculate the final order price.
3. Use /orders/create to create the order.