Contents
On this page
Create Membership Plan - Plugixa Car Wash
POST /plugixa-carwash/v1/membership-plans
Create a membership plan.
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/membership-plans
Request body
Content type: application/json
| Field | Type | Required | Description |
|---|---|---|---|
name |
string |
Yes | At most 190 characters. |
description |
string |
No | At most 2000 characters. Defaults to empty. |
price |
number |
Yes | 0 to 100000. |
currency |
string |
No | Three letters, upper-cased on create. Defaults to the site’s currency. |
period |
string |
No | month or year. Defaults to month. |
washes |
integer |
No | Per period, 0 to 1000. 0 is unlimited. Defaults to 0. |
package_ids |
array |
No | Package ids a membership wash covers. Empty covers every package. Defaults to []. |
addon_discount |
number |
No | Percent off extras, 0 to 100. Defaults to 0. |
color |
string |
No | A hex colour, or empty. Defaults to empty. |
sort_order |
integer |
No | -1000 to 1000. Defaults to 0. |
status |
string |
No | published or unpublished. Defaults to published. |
A member’s covered wash comes off the booking as a “Membership” discount line, with addon_discount off the extras.
{
"name": "Unlimited Monthly",
"price": 39,
"period": "month",
"washes": 0,
"package_ids": [
4
],
"addon_discount": 10
}
Responses
201 Created. data is the new membership plan.
{
"success": true,
"data": {
"id": 2,
"name": "Unlimited Monthly",
"description": "Wash as often as you like.",
"price": 39.0,
"currency": "USD",
"period": "month",
"washes": 0,
"package_ids": [
4
],
"addon_discount": 10.0,
"color": "#6366F1",
"sort_order": 0,
"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,
"members": 58
}
}
| Field | Type | Meaning |
|---|---|---|
data.id |
integer |
The plan’s id |
data.price |
number |
Charged every period |
data.currency |
string |
Three letters |
data.period |
string |
month or year |
data.washes |
integer |
Washes included per period. 0 means unlimited |
data.package_ids |
array |
Packages it covers. Empty means every package |
data.addon_discount |
number |
Percent off extras for members |
data.members |
integer |
Memberships on this plan that are active or past_due |
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_name |
name is missing or empty. |
422 |
plugixa_carwash_missing_price |
price is missing or empty. |
422 |
plugixa_carwash_too_long_{field} |
A text field is too long. The code names the field. |
422 |
plugixa_carwash_too_small_{field} / too_large_{field} |
A number is outside its range. The code names the field. |
422 |
plugixa_carwash_invalid_{field} |
A choice field has a value that is not one of its choices. The code names the field. |
Plus the errors every endpoint can return.
Examples
curl -s -X POST "https://your-site.example/wp-json/plugixa-carwash/v1/membership-plans" \
-u "admin:$WP_APP_PASSWORD" \
-H "Content-Type: application/json" \
-d '{"name":"Unlimited Monthly","price":39,"period":"month","washes":0,"package_ids":[4],"addon_discount":10}'
<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-carwash/v1/membership-plans');
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([
'name' => 'Unlimited Monthly',
'price' => 39,
'period' => 'month',
'washes' => 0,
'package_ids' => [4],
'addon_discount' => 10,
]),
]);
$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/membership-plans', {
method: 'POST',
headers: {
'Authorization': `Basic ${auth}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
name: 'Unlimited Monthly',
price: 39,
period: 'month',
washes: 0,
package_ids: [4],
addon_discount: 10,
}),
});
const { data } = await response.json();
Quick Links
Share