Skip to main content

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.

FieldTypeRequiredDescription
codestringyesThe pass code, any case
experience_id or product_idintegernoThe item to check against
datedate Y-m-dnoThe 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:

ReasonMeaning
okIt works
not_foundNo pass with that code in this shop
inactiveNot paid for yet, or cancelled
not_yet_valid, expiredThe day is outside the pass dates
not_coveredThe pass does not cover this item, or the price is not per person
no_visits_leftEvery visit is used or held
already_on_bookingThis pass is already on the booking