Contents
On this page

Create Membership - Plugixa Car Wash

POST /plugixa-carwash/v1/memberships

Create a membership.

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

Request

POST https://your-site.example/wp-json/plugixa-carwash/v1/memberships

Request body

Content type: application/json

Field Type Required Description
customer_id integer Yes An existing customer.
plan_id integer Yes An existing plan.
status string No active, past_due, cancelled or expired. Defaults to active.
current_period_start string No Y-m-d. Defaults to today.
current_period_end string No Y-m-d, not before the start. Defaults to one plan period after the start, less a day.
cancel_at_period_end boolean No Defaults to false.
provider string No manual or stripe. Defaults to manual.
provider_ref string No At most 190 characters. Defaults to empty.
provider_customer string No At most 190 characters. Defaults to empty.
notes string No At most 2000 characters. Defaults to empty.

This records a membership sold at the desk. It does not charge anyone: subscriptions paid by card are created by the Stripe checkout.

{
  "customer_id": 25,
  "plan_id": 2
}

Responses

201 Created. data is the new membership.

{
  "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
  }
}
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

Errors

Status Code When
422 plugixa_carwash_missing_customer_id customer_id is missing or empty.
422 plugixa_carwash_missing_plan_id plan_id is missing or empty.
422 plugixa_carwash_invalid_{field} A choice field has a value that is not one of its choices. The code names the field.
422 plugixa_carwash_invalid_customer customer_id is not an existing customer.
422 plugixa_carwash_invalid_plan plan_id is not an existing plan.
422 plugixa_carwash_invalid_period The period ends before it starts.

Plus the errors every endpoint can return.

Examples

curl -s -X POST "https://your-site.example/wp-json/plugixa-carwash/v1/memberships" \
  -u "admin:$WP_APP_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"customer_id":25,"plan_id":2}'

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-carwash/v1/memberships');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
    CURLOPT_HTTPHEADER     => [
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => json_encode([
        'customer_id' => 25,
        'plan_id'     => 2,
    ]),
]);
$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/memberships', {
  method: 'POST',
  headers: {
    'Authorization': `Basic ${auth}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ customer_id: 25, plan_id: 2 }),
});
const { data } = await response.json();

Quick Links

Share