Hold Car - Plugixa Car Rental

POST /plugixa-car-rental/v1/public/holds

Hold a car of one model for a visitor while they check out. This creates a pending booking and returns the token that opens it.

Public: no sign-in and no nonce. Needs the Booking form app on. Rate limited to 15 requests an hour per visitor address: see Public routes.

The hold lasts as long as the booking rules say (15 minutes by default), counted from now. A visitor books a model: the car is chosen for them, and vehicle_unit_id, the customer fields and notes are ignored here, as the customer’s details are given at checkout. A hold that runs out is set to expired by a scheduled task.

Keep the token. It is shown once and only its fingerprint is stored. Every later step of the flow needs it.

Request

POST https://your-site.example/wp-json/plugixa-car-rental/v1/public/holds

Request body

Content type: application/json

{
  "pickup_location_id": 1,
  "pickup_at": "2026-12-01 10:00",
  "return_at": "2026-12-04 10:00",
  "vehicle_model_id": 4,
  "extras": [
    {
      "id": 3,
      "quantity": 1
    }
  ],
  "website": ""
}

Responses

201 Created. data holds the token and the booking.

{
  "success": true,
  "data": {
    "token": "ca978112ca1bbdcafac231b39a23dc4da786eff8147c4e72b9807785afee48bb",
    "booking": {
      "reference": "CR-2026-0128",
      "status": "pending",
      "vehicle_model_name": "Peugeot 3008",
      "pickup_location_name": "Paris Gare de Lyon",
      "return_location_name": "Paris Gare de Lyon",
      "pickup_local": "2026-12-01 10:00 CET",
      "return_local": "2026-12-04 10:00 CET",
      "days": 3,
      "hold_expires_at": "2026-11-12T09:45:00Z",
      "customer_name": "",
      "customer_email": "",
      "payment_method": "",
      "currency": "EUR",
      "line_items": [
        {
          "type": "rental",
          "label": "Peugeot 3008, 3 days",
          "quantity": 3.0,
          "unit_price": 65.0,
          "total": 195.0
        },
        {
          "type": "extra",
          "label": "Child seat",
          "quantity": 1.0,
          "unit_price": 24.0,
          "total": 24.0
        }
      ],
      "subtotal": 219.0,
      "discount_total": 0.0,
      "tax_total": 0.0,
      "total": 219.0,
      "deposit": 800.0,
      "amount_paid": 0.0,
      "payment_status": "unpaid",
      "payment_options": [
        {
          "type": "full",
          "amount": 219.0,
          "label": ""
        }
      ]
    }
  }
}

Errors

Plus the errors every endpoint can return.

Examples

curl -s -X POST "https://your-site.example/wp-json/plugixa-car-rental/v1/public/holds" \
  -H "Content-Type: application/json" \
  -d '{"pickup_location_id":1,"pickup_at":"2026-12-01 10:00","return_at":"2026-12-04 10:00","vehicle_model_id":4,"extras":[{"id":3,"quantity":1}],"website":""}'

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-car-rental/v1/public/holds');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => json_encode([
        'pickup_location_id' => 1,
        'pickup_at'          => '2026-12-01 10:00',
        'return_at'          => '2026-12-04 10:00',
        'vehicle_model_id'   => 4,
        'extras'             => [
            [
                'id'       => 3,
                'quantity' => 1,
            ],
        ],
        'website'            => '',
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const response = await fetch('https://your-site.example/wp-json/plugixa-car-rental/v1/public/holds', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    pickup_location_id: 1,
    pickup_at: '2026-12-01 10:00',
    return_at: '2026-12-04 10:00',
    vehicle_model_id: 4,
    extras: [{ id: 3, quantity: 1 }],
    website: '',
  }),
});
const { data } = await response.json();