Contents
On this page

Get Coupon - Plugixa Car Rental

GET /plugixa-car-rental/v1/coupons/{id}

Read one coupon.

Needs the Coupons app on. The user needs the plugixa_car_rental_view capability.

Request

GET https://your-site.example/wp-json/plugixa-car-rental/v1/coupons/7

Path parameters

Name Type Description
id integer The coupon’s id

Responses

200 OK. data is the coupon.

{
  "success": true,
  "data": {
    "id": 7,
    "code": "WINTER10",
    "code_key": "WINTER10",
    "description": "Winter campaign",
    "discount_type": "percent",
    "amount": 10.0,
    "min_days": 2,
    "valid_from": "2026-12-01",
    "valid_until": "2027-02-28",
    "usage_limit": 100,
    "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,
    "used": 14
  }
}
Field Type Meaning
data.id integer The coupon’s id
data.code string The code as you wrote it
data.discount_type string percent or fixed
data.amount number Percentage, or amount off in the site’s currency
data.used integer Confirmed bookings that used it. A cancelled booking gives its use back
data.usage_limit integer Most uses, 0 for no limit
data.status string published or unpublished. An unpublished code is refused
data.code_key string The code upper-cased: codes are matched without regard to case
data.min_days integer Shortest rental it applies to, in days
data.valid_from string|null First day it can be used, YYYY-MM-DD, or null
data.valid_until string|null Last day it can be used, or null
data.description string Your note
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
404 plugixa_car_rental_not_found No coupon with that id, or it is in the trash.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-car-rental/v1/coupons/7" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-car-rental/v1/coupons/7');
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 response = await fetch('https://your-site.example/wp-json/plugixa-car-rental/v1/coupons/7', {
  headers: {
    'Authorization': `Basic ${auth}`,
  },
});
const { data } = await response.json();

Quick Links

Share