Contents
On this page
View Booking - Plugixa Car Rental
POST /plugixa-car-rental/v1/public/manage
Read the booking a customer’s manage link opens, with its cancellation terms. This is what the customer booking page shows.
Public: no sign-in and no nonce. Needs the Customer portal app on. Rate limited to 60 requests an hour per visitor address: see Public routes.
Request
POST https://your-site.example/wp-json/plugixa-car-rental/v1/public/manage
Request body
Content type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
link |
string |
Yes | The manage token from the customer’s link: the value of pcr_manage in manage_url, in the form <booking id>-<64 hexadecimal characters>. |
{
"link": "128-3e23e8160039594a33894f6564e1b1348bbd7a0088d42c4acb73eeaed59c009d"
}
Responses
200 OK. data holds the booking and its cancellation terms.
{
"success": true,
"data": {
"booking": {
"reference": "CR-2026-0128",
"status": "confirmed",
"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": null,
"customer_name": "Claire Martin",
"customer_email": "claire.martin@example.com",
"payment_method": "pay_at_pickup",
"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
},
{
"type": "coupon",
"label": "Coupon WINTER10",
"quantity": 1.0,
"unit_price": -21.9,
"total": -21.9
}
],
"subtotal": 219.0,
"discount_total": 21.9,
"tax_total": 0.0,
"total": 197.1,
"deposit": 800.0,
"amount_paid": 0.0,
"payment_status": "unpaid",
"payment_options": [
{
"type": "full",
"amount": 197.1,
"label": ""
}
]
},
"cancellation": {
"allowed": true,
"free": true,
"free_until": "2026-11-29T09:00:00Z",
"fee": 0.0,
"refund": 0.0,
"reason": "",
"free_until_local": "2026-11-29 10:00 CET",
"recorded": false
}
}
}
| Field | Type | Meaning |
|---|---|---|
data.booking |
object |
The booking, as on Get Held Booking |
data.cancellation.allowed |
boolean |
Whether the customer may cancel online now: only a pending or confirmed booking, before its pickup time |
data.cancellation.free |
boolean |
Whether cancelling now costs nothing |
data.cancellation.free_until |
string |
Last moment to cancel free of charge, ISO 8601 in UTC |
data.cancellation.free_until_local |
string |
The same on the pickup location’s clock |
data.cancellation.fee |
number |
What cancelling now costs: a number of days’ worth of the total, set in the settings, never more than the total |
data.cancellation.refund |
number |
What would be refunded: paid minus the fee |
data.cancellation.reason |
string |
Why it cannot be cancelled online, or empty |
data.cancellation.recorded |
boolean |
true on a cancelled booking: fee and refund are then the ones it was cancelled on |
The plugixa_car_rental_portal_view filter can add to this answer. See Hooks.
Errors
| Status | Code | When |
|---|---|---|
404 |
plugixa_car_rental_link_invalid |
The link is malformed, does not match the booking, or the booking is in the trash. |
Plus the errors every endpoint can return.
Examples
curl -s -X POST "https://your-site.example/wp-json/plugixa-car-rental/v1/public/manage" \
-H "Content-Type: application/json" \
-d '{"link":"128-3e23e8160039594a33894f6564e1b1348bbd7a0088d42c4acb73eeaed59c009d"}'
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-car-rental/v1/public/manage');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode([
'link' => '128-3e23e8160039594a33894f6564e1b1348bbd7a0088d42c4acb73eeaed59c009d',
]),
]);
$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/manage', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
link: '128-3e23e8160039594a33894f6564e1b1348bbd7a0088d42c4acb73eeaed59c009d',
}),
});
const { data } = await response.json();
Quick Links
Share