Skip to Content

CouponResponse

Properties

NameTypeDescriptionNotes
idLongUnique identifier for the coupon[default to null]
codeStringUnique coupon code that users enter to redeem the discount[default to null]
colorStringHex color code for UI display purposes (e.g., “#FF5733”)[default to null]
descriptionStringOptional descriptive text explaining the coupon’s purpose or terms[optional] [default to null]
discountDoubleFixed discount amount in the specified currency[default to null]
min_order_amountDoubleMinimum order amount required to use this coupon[optional] [default to null]
max_coupon_amountDoubleMaximum discount amount that can be applied (caps percentage discounts)[optional] [default to null]
percentageBooleanWhether the discount is a percentage (true) or fixed amount (false)[default to null]
expires_onDateExpiration date and time for the coupon (UTC)[optional] [default to null]
timesIntegerMaximum number of times this coupon can be used across all users[optional] [default to null]
is_activeBooleanWhether this coupon is currently active[default to null]
for_deliveryBooleanWhether this coupon applies to delivery fees[default to null]
creator_idLongID of the admin user who created this coupon[optional] [default to null]
vendor_type_idLongOptional vendor type restriction - limits coupon to specific vendor categories[optional] [default to null]
usage_typeStringUsage restriction type (e.g., “once_per_user”, “unlimited”)[optional] [default to null]
created_atDateTimestamp when the coupon was created[default to null]
updated_atDateTimestamp when the coupon was last updated[default to null]
deleted_atDateTimestamp when the coupon was soft-deleted, if applicable[optional] [default to null]
formatted_expires_onStringFormatted expiration date for display[default to null]
productsListList of products the coupon applies to[default to null]
vendorsListList of vendors the coupon applies to[default to null]
expiredBooleanWhether the coupon has expired[default to null]
use_leftIntegerNumber of uses left for the coupon[optional] [default to null]
photoStringPhoto URL for the coupon[optional] [default to null]

[Back to Model list] [Back to API list] [Back to README]