Contents
On this page

List Rate Plans - Plugixa Car Rental

GET /plugixa-car-rental/v1/rate-plans

List rates, one page at a time.

The user needs the plugixa_car_rental_view capability.

Request

GET https://your-site.example/wp-json/plugixa-car-rental/v1/rate-plans?vehicle_model_id__in=4&orderby=min_days&order=asc

Query parameters

This list takes the list parameters every paged list accepts. search matches name. orderby accepts id, name, min_days, daily_rate, status, created_at, modified_at.

Filters, as described in Filtering lists: status (in, ne, empty, not_empty), vehicle_model_id (in, ne, empty, not_empty), location_id (in, ne, empty, not_empty), created_at and modified_at (dates).

Responses

200 OK. data is one page of rates.

{
  "success": true,
  "data": [
    {
      "id": 5,
      "vehicle_model_id": 4,
      "location_id": null,
      "name": "Short rental",
      "min_days": 1,
      "max_days": 6,
      "daily_rate": 65.0,
      "status": "published",
      "created_by": 1,
      "modified_by": 1,
      "created_at": "2026-11-12 09:30:00",
      "modified_at": "2026-11-12 09:30:00",
      "deleted_at": null,
      "vehicle_model_name": "Peugeot 3008",
      "location_name": null
    }
  ],
  "meta": {
    "total": 4,
    "pages": 1
  }
}
Field Type Meaning
data[].id integer The rate’s id
data[].vehicle_model_id integer The model it prices
data[].vehicle_model_name string|null That model’s name
data[].location_id integer|null The pickup location it applies to, or null for every location
data[].location_name string|null That location’s name
data[].min_days integer First rental length it covers, in days
data[].max_days integer Last rental length it covers, 0 for “and longer”
data[].daily_rate number Price per day for a rental in that range
meta.total integer Rate Plans matching the search and filters, before paging
meta.pages integer Number of pages at this per_page

A rental is priced by the one published rate whose day range covers its length, for the car’s model: a rate for the pickup location wins over one for every location. The whole rental is charged at that rate’s daily_rate. See Rates.

Errors

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-car-rental/v1/rate-plans?vehicle_model_id__in=4&orderby=min_days&order=asc" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$query = http_build_query([
    'vehicle_model_id__in' => '4',
    'orderby'              => 'min_days',
    'order'                => 'asc',
]);
$ch = curl_init('https://your-site.example/wp-json/plugixa-car-rental/v1/rate-plans?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const auth = Buffer.from(`admin:${process.env.WP_APP_PASSWORD}`).toString('base64');
const query = new URLSearchParams({ vehicle_model_id__in: '4', orderby: 'min_days', order: 'asc' });
const response = await fetch(`https://your-site.example/wp-json/plugixa-car-rental/v1/rate-plans?${query}`, {
  headers: {
    'Authorization': `Basic ${auth}`,
  },
});
const { data, meta } = await response.json();

Quick Links

Share