Vouchers

Look up voucher details by code

Public endpoint for resolving a voucher code into the runtime VoucherCodeLookup shape — its remaining balance, validity window, owning voucher type or external voucher, and the list of offerings the code may be redeemed against. Used by the customer- facing storefront to validate a code at checkout before the basket is committed.

Supports both Trybe-native VoucherCodes and integration-issued external vouchers (e.g. GiftPro) — see the payment_processor discriminator on the response.

get/shop/voucher-lookup/{voucherCode}

Response

The voucher details were successfully retrieved.

Example response

{
  "data": {
    "id": "65f0a1b2c3d4e5f6a7b8c9d2",
    "code": "SUMMER2026-X9K2",
    "payment_processor": "voucher",
    "processor_voucher_id": "gp_8421",
    "processor": "giftpro",
    "valid_from_date": "2026-01-01T00:00:00+00:00",
    "valid_to_date": "2027-01-01T00:00:00+00:00",
    "amount_type": "cash",
    "total": 5000,
    "balance": 2500,
    "currency": "gbp",
    "partially_redeemable": true,
    "uses_total": 7,
    "uses_remaining": 5,
    "voucher_name": "£50 Gift Voucher",
    "customer_id": "65f0a1b2c3d4e5f6a7b8c9d3",
    "fulfillment_status": "dispatched",
    "value": 5000,
    "valid_offerings": [
      {
        "offering_type": "appointment",
        "offering_id": "65f0a1b2c3d4e5f6a7b8c9d4",
        "offering_name": "60-minute Aromatherapy Massage",
        "display_name": "60-minute Aromatherapy Massage",
        "offering_config": {
          "duration": "P1Y"
        }
      }
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.