Sign in
CouponCodes

Get coupon code usage statistics

Gets the usage statistics for a coupon code at a specific booking date. Returns null data if the coupon has no usage limits configured.

get/shop/coupon-codes/{code}/usage-stats

Query parameters

booking_datestring required

The booking date to calculate usage stats for (YYYY-MM-DD or ISO8601 datetime)

site_idstring required

Filter results by the site they belong to

offering_idstring

When provided, returns null data if the coupon does not apply to this offering

Response

Usage statistics retrieved successfully

Example response

{
  "data": {
    "max_uses": 4,
    "current_uses": 2,
    "remaining_uses": 2,
    "period": "P1W",
    "period_label": "weekly",
    "period_start": "2025-11-10",
    "period_end": "2025-11-16"
  }
}

Changes