Headers

• Account-ID string(uuid) Required

  Account ID - Can be found on the Dashboard under Settings → API Tokens

Path parameters

• redeemable string(uuid) Required

Responses

• 200 application/json

  Redeemable topped up

  Hide response attribute Show response attribute object

  • data object

    A redeemable item that can be redeemed by a customer. Represents either a monetary value (gift card) or a standard item (experience, product, service).

    Hide data attributes Show data attributes object

    • id string(uuid)

      Unique identifier for the redeemable. Internal use only - not displayed to customers. Use this ID for API operations like redemption, cancellation, top-up, or validity updates.

    • type string

      Type of redeemable:

      • monetary: Gift card or voucher with a monetary value that can be redeemed for any amount up to its balance
      • standard: Single-use voucher for a specific experience, product, or service

      Values are monetary or standard.

    • status string

      Current redemption status:

      • issued: Active and eligible to be redeemed
      • not_yet_valid: Created but not yet within the valid_from/valid_to date range
      • redeemed: Fully redeemed (standard type) or has zero balance remaining (monetary type)
      • expired: Past the valid_to date and can no longer be redeemed
      • cancelled: Manually cancelled and cannot be redeemed

      Values are issued, not_yet_valid, redeemed, expired, or cancelled.

    • valid_from string(date) | null

      First date this redeemable can be used (inclusive). Null means valid immediately.

    • valid_to string(date) | null

      Last date this redeemable can be used (inclusive). Null means no expiration date.

    • valid_days array[string] | null

      Specific days of the week when this redeemable can be used. Null or empty array means valid all days.

      Values are monday, tuesday, wednesday, thursday, friday, saturday, or sunday.

    • currency_code string

      ISO 4217 currency code in lowercase. Applies to monetary_value for monetary type redeemables.

    • monetary_value integer | null

      For monetary type: Remaining balance in cents (smallest currency unit). Can be partially redeemed. For standard type: Always null.

    • name string

      Display name of the redeemable item, typically the product name. For variant products, combines product name and variant name (e.g., "Spa Day - Deluxe Package"). Displayed to: Customers on redemption screens, voucher details, and in terminal/POS during redemption.

    • custom_fields object

      Additional custom data for the redeemable, such as product-specific attributes or redemption instructions. Structure varies by product configuration.

      Additional properties are allowed.

    • tags object

      Key-value pairs for categorizing and filtering redeemables. Inherited from the parent product and order.

      Hide tags attribute Show tags attribute object

      • * string Additional properties
    • created_at string(date-time)

      Timestamp when the redeemable was created

    • updated_at string(date-time)

      Timestamp when the redeemable was last modified (e.g., redeemed, topped up, validity updated)

    • is_live boolean

      Indicates if this is a live (production) redeemable (true) or a test redeemable (false)

    • invalid_reason string | null

      Human-readable explanation of why this redeemable cannot currently be redeemed (e.g., "Expired on 2024-12-31", "Not valid on weekends"). Null if redeemable is valid.

    • redeem_locations array[object]

      List of redeem locations where this redeemable can be redeemed.

      Redeem location information needed for API operations

      Hide redeem_locations attributes Show redeem_locations attributes object

      • id string(uuid)

        Location UUID used in Redeem-Location-ID header

      • name string

        Location display name

      • is_active boolean

        Whether the location is currently active

• 403

  Cannot top up non-monetary, expired, or cancelled redeemables

• 404

  Redeemable not found

• 422

  Invalid value