Check a pass code
POST /v1/passes/check
Scope store:read. Tells you whether a code exists, and whether it would work on an item on a
day. Nothing is held.
| Field | Type | Required | Description |
|---|---|---|---|
code | string | yes | The pass code, any case |
experience_id or product_id | integer | no | The item to check against |
date | date Y-m-d | no | The visit day, in the shop's time zone. Defaults to today |
{
"data": {
"found": true,
"works": false,
"reason": "expired",
"message": "This pass is valid July 1st 2026 - August 31st 2026.",
"pass": { "id": 31, "code": "PASS-7QKM-B4RT", "visits_left": 9 }
}
}
works is null when no item was sent. The reason values:
| Reason | Meaning |
|---|---|
ok | It works |
not_found | No pass with that code in this shop |
inactive | Not paid for yet, or cancelled |
not_yet_valid, expired | The day is outside the pass dates |
not_covered | The pass does not cover this item, or the price is not per person |
no_visits_left | Every visit is used or held |
already_on_booking | This pass is already on the booking |