Contents
On this page

Create Rate Plan - Plugixa Car Rental

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

Create a rate.

The user needs the plugixa_car_rental_create capability.

Request

POST https://your-site.example/wp-json/plugixa-car-rental/v1/rate-plans

Request body

Content type: application/json

Field Type Required Description
vehicle_model_id integer Yes An existing vehicle model.
daily_rate number Yes More than 0. Rounded to 2 decimals.
location_id integer No A location, so the rate applies only to rentals picked up there. 0 or omitted: every location.
min_days integer No 1 to 1000. Defaults to 1.
max_days integer No 0 (the default) for “and longer”, else from min_days to 1000.
name string No Your label, up to 100 characters.
status string No published (the default) or unpublished.

The day ranges of a model’s rates for the same location (or for every location) must not overlap, so each rental length has one price. Unpublished and published rates are both counted.

{
  "vehicle_model_id": 4,
  "name": "Short rental",
  "min_days": 1,
  "max_days": 6,
  "daily_rate": 65
}

Responses

201 Created. data is the new rate.

{
  "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
  }
}
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
data.name string Your label for it
data.status string published or unpublished. Only a published rate prices a booking
data.created_at string UTC datetime the record was created
data.modified_at string UTC datetime of the last change. Send it back on an update to be warned of a conflicting edit
data.deleted_at string|null null unless the record is in the trash

Errors

Status Code When
422 plugixa_car_rental_invalid vehicle_model_id is missing or not a model, location_id is not a location, the day range is out of bounds, or daily_rate is not above 0. data.field names the field.
409 plugixa_car_rental_rate_overlap Another rate for the same model and location covers some of the same days. data.conflict is its id.
422 plugixa_car_rental_invalid_choice status is not published or unpublished. data.allowed lists the accepted values.
422 plugixa_car_rental_not_a_number A number field was sent as something else. data.field names it.
422 plugixa_car_rental_negative_number A number field that cannot be negative is. data.field names it.
422 plugixa_car_rental_too_long A text field is longer than its column. data.field names it and data.max gives the limit.

Plus the errors every endpoint can return.

Examples

curl -s -X POST "https://your-site.example/wp-json/plugixa-car-rental/v1/rate-plans" \
  -u "admin:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"vehicle_model_id":4,"name":"Short rental","min_days":1,"max_days":6,"daily_rate":65}'

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-car-rental/v1/rate-plans');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
    CURLOPT_HTTPHEADER     => [
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => json_encode([
        'vehicle_model_id' => 4,
        'name'             => 'Short rental',
        'min_days'         => 1,
        'max_days'         => 6,
        'daily_rate'       => 65,
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const auth = Buffer.from(`admin:${process.env.WP_APP_PASSWORD}`).toString('base64');
const response = await fetch('https://your-site.example/wp-json/plugixa-car-rental/v1/rate-plans', {
  method: 'POST',
  headers: {
    'Authorization': `Basic ${auth}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    vehicle_model_id: 4,
    name: 'Short rental',
    min_days: 1,
    max_days: 6,
    daily_rate: 65,
  }),
});
const { data } = await response.json();

Quick Links

Share