Contents
On this page

Get Gift Card - Plugixa Car Wash

GET /plugixa-carwash/v1/gift-cards/{id}

Read one gift card, with everything the list row has.

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

Request

GET https://your-site.example/wp-json/plugixa-carwash/v1/gift-cards/11

Path parameters

Name Type Description
id integer The gift card’s id

Responses

200 OK. data is the gift card.

{
  "success": true,
  "data": {
    "id": 11,
    "code": "K7PQ2DW3HN9C",
    "initial_value": 50.0,
    "balance": 35.5,
    "currency": "USD",
    "recipient_name": "Mia",
    "recipient_email": "mia@example.com",
    "purchaser_name": "Lucas",
    "message": "Happy birthday!",
    "expires_on": "2027-11-12",
    "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
  }
}
Field Type Meaning
data.id integer The gift card’s id
data.code string Upper-case letters and digits
data.initial_value number Its value when issued
data.balance number What is left on it
data.currency string It can only pay for bookings in this currency
data.expires_on string|null Last day it can be used, Y-m-d
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
404 plugixa_carwash_not_found No gift card 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-carwash/v1/gift-cards/11" \
  -u "admin:$WP_APP_PASSWORD"

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

Quick Links

Share