onCouponValidationFailed

Purpose

Triggered when a coupon validation fails. Use this hook to play error sounds and show why the coupon couldn't be applied.

When It Triggers

  • Player enters an invalid coupon code

  • Coupon exists but validation fails (expired, usage limit, etc.)

Parameters

Parameter
Type
Description

data.shopId

string

Unique shop identifier

data.shopName

string

Display name of the shop

data.couponCode

string

The coupon code attempted

data.reason

string

Failure reason code

data.reasonMessage

string

Human-readable message

Reason Codes

Code
Description

not_found

Coupon doesn't exist

expired

Coupon has expired

not_started

Coupon hasn't started yet

max_uses_reached

Coupon max uses exceeded

personal_limit_reached

Customer has used too many times

min_purchase_not_met

Cart total below minimum

restricted

Customer doesn't meet restrictions

inactive

Coupon is disabled

Example

Last updated