List rates (v2)

Version 2 of List rates: a paginated list of rates, newest first, with prices as Money objects and the lowest, average and highest interval prices already computed. Rates of Rate Calendar seasons are not included.

Send Accept: application/vnd.api.v2+json. The path is the same as List rates (/car-rental/rates; call it without the trailing slash); the Accept header selects this version. Without it you get the version 1 response.

Rows do not include the season or the vehicle class. To build a price table, filter by season_id and vehicle_class_id, or get the full rate with Get a rate.

The page URLs in the response (next_page_url, links, ...) contain only page: request the next page yourself with the same parameters and page + 1, up to data.last_page.

Responses

🟢200OK

application/json

One page of rates in data.data, with the page details in data. HTTP 200 is also used for failures: always check success. When it is false, the body is an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Example

{
    "success": true,
    "status_code": 200,
    "errors": [],
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 2648,
                "rate_type_id": 2,
                "rate_code": "CORP",
                "decreasing_rates_based_on_intervals": true,
                "decreasing_rates_based_on_intervals_hourly": true,
                "hourly_rate": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "12.00",
                    "usd_amount": "12.00",
                    "amount_for_display": "$12.00"
                },
                "daily_rate": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "60.00",
                    "usd_amount": "60.00",
                    "amount_for_display": "$60.00"
                },
                "weekly_rate": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "300.00",
                    "usd_amount": "300.00",
                    "amount_for_display": "$300.00"
                },
                "monthly_rate": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "1100.00",
                    "usd_amount": "1100.00",
                    "amount_for_display": "$1,100.00"
                },
                "daily_intervals": [
                    {
                        "order": 1,
                        "price": 65,
                        "end_interval": 3,
                        "start_interval": 1
                    },
                    {
                        "order": 2,
                        "price": 55,
                        "end_interval": 7,
                        "start_interval": 4
                    }
                ],
                "hourly_intervals": [],
                "daily_interval_lowest_rate": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "55.00",
                    "usd_amount": "55.00",
                    "amount_for_display": "$55.00"
                },
                "daily_interval_avg_rate": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "60.00",
                    "usd_amount": "60.00",
                    "amount_for_display": "$60.00"
                },
                "daily_interval_highest_rate": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "65.00",
                    "usd_amount": "65.00",
                    "amount_for_display": "$65.00"
                },
                "hourly_interval_lowest_rate": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "0.00",
                    "usd_amount": "0.00",
                    "amount_for_display": "$0.00"
                },
                "hourly_interval_avg_rate": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "0.00",
                    "usd_amount": "0.00",
                    "amount_for_display": "$0.00"
                },
                "hourly_interval_highest_rate": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "0.00",
                    "usd_amount": "0.00",
                    "amount_for_display": "$0.00"
                },
                "final_daily_rate": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "55.00",
                    "usd_amount": "55.00",
                    "amount_for_display": "$55.00"
                }
            }
        ],
        "first_page_url": "https://api.hqrentals.app/api/car-rental/rates?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "https://api.hqrentals.app/api/car-rental/rates?page=1",
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "https://api.hqrentals.app/api/car-rental/rates?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "page": null,
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "https://api.hqrentals.app/api/car-rental/rates",
        "per_page": 50,
        "prev_page_url": null,
        "to": 1,
        "total": 1
    }
}

Request

Responses