Contents
On this page

List Coupons - Plugixa Car Wash

GET /plugixa-carwash/v1/coupons

List coupons, one page at a time, with search, sorting and filters.

Needs the Coupons app on, and the plugixa_carwash_view capability.

Request

GET https://your-site.example/wp-json/plugixa-carwash/v1/coupons

Query parameters

Name Type Default Description
type__in string Comma-separated: percent, fixed.
status__in string Comma-separated: published, unpublished.

Plus the list parameters every paged list accepts. search matches the code and the description. orderby accepts id, code, value, used_count, ends_on, status, created_at. Each filter is a field name and a comparison joined by two underscores: see Filters.

Responses

200 OK. data is one page of coupons.

{
  "success": true,
  "data": [
    {
      "id": 9,
      "code": "SPRING10",
      "description": "Spring promotion",
      "type": "percent",
      "value": 10.0,
      "min_total": 0.0,
      "max_uses": 0,
      "used_count": "3",
      "starts_on": "2026-11-01",
      "ends_on": "2026-11-30",
      "package_ids": [],
      "status": "published",
      "created_by": 1,
      "modified_by": 1,
      "created_at": "2026-11-10 08:15:00",
      "modified_at": "2026-11-12 09:30:00",
      "deleted_at": null
    }
  ],
  "meta": {
    "total": 5,
    "pages": 1
  }
}
Field Type Meaning
data[].id integer The coupon’s id
data[].code string Upper case
data[].type string percent or fixed
data[].value number Percent, or an amount in the booking’s currency
data[].min_total number Smallest booking it applies to
data[].max_uses integer 0 means unlimited
data[].used_count string Bookings made with it so far. A number, sent as a string
data[].starts_on string|null First day it works, Y-m-d
data[].ends_on string|null Last day it works, Y-m-d
data[].package_ids array Packages it is limited to. Empty means every booking
data[].created_at string UTC datetime
data[].modified_at string UTC datetime of the last change. Send it back on an update to be warned about a conflicting edit
data[].deleted_at string|null null unless the record is in the trash
meta.total integer Coupons matching the search and filters, before paging
meta.pages integer Number of pages at this per_page

Errors

Status Code When
400 plugixa_carwash_unknown_filter A filter names a field this list cannot filter on.
400 plugixa_carwash_unknown_operator A comparison that does not work on that field.
400 plugixa_carwash_missing_value A filter that needs a value has none.
400 plugixa_carwash_invalid_date A date filter value is not a date.

Plus the errors every endpoint can return.

Examples

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

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

Quick Links

Share