Contents
On this page

List Memberships - Plugixa Car Wash

GET /plugixa-carwash/v1/memberships

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

Needs Plugixa Car Wash Pro with the Memberships app on, and the plugixa_carwash_view capability.

Note. search does not work on this list: memberships have no name column to search, so any search term answers an empty list. Filter by status or plan_id instead.

Request

GET https://your-site.example/wp-json/plugixa-carwash/v1/memberships?status__in=active,past_due&plan_id__in=2

Query parameters

Name Type Default Description
status__in string Comma-separated: active, past_due, cancelled, expired.
plan_id__in string Comma-separated plan ids.

Plus the list parameters every paged list accepts. orderby accepts id, status, current_period_end, 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 memberships.

{
  "success": true,
  "data": [
    {
      "id": 14,
      "customer_id": 25,
      "plan_id": 2,
      "status": "active",
      "current_period_start": "2026-11-01",
      "current_period_end": "2026-11-30",
      "cancel_at_period_end": false,
      "provider": "manual",
      "provider_ref": "",
      "provider_customer": "",
      "notes": "",
      "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,
      "customer_name": "Lucas Bernard",
      "customer_email": "lucas@example.com",
      "plan_name": "Unlimited Monthly",
      "plan_color": "#6366F1",
      "washes": 0,
      "used": 3
    }
  ],
  "meta": {
    "total": 58,
    "pages": 1
  }
}
Field Type Meaning
data[].id integer The membership’s id
data[].customer_id integer The customer
data[].plan_id integer The plan
data[].status string active, past_due (a Stripe renewal failed, still honoured while Stripe retries), cancelled or expired
data[].current_period_start string|null First day of the period, Y-m-d
data[].current_period_end string|null Last day of the period, Y-m-d
data[].cancel_at_period_end boolean Ends when the period does
data[].provider string manual (sold at the desk, renewed by staff) or stripe
data[].provider_ref string The Stripe subscription id, for stripe
data[].customer_name string The customer’s name
data[].plan_name string The plan’s name
data[].washes integer The plan’s washes per period, 0 unlimited
data[].used integer Washes taken in the current period
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 Memberships 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/memberships?status__in=active,past_due&plan_id__in=2" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$query = http_build_query([
    'status__in'  => 'active,past_due',
    'plan_id__in' => '2',
]);
$ch = curl_init('https://your-site.example/wp-json/plugixa-carwash/v1/memberships?' . $query);
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 query = new URLSearchParams({ status__in: 'active,past_due', plan_id__in: '2' });
const response = await fetch(`https://your-site.example/wp-json/plugixa-carwash/v1/memberships?${query}`, {
  headers: {
    'Authorization': `Basic ${auth}`,
  },
});
const { data, meta } = await response.json();

Quick Links

Share