Coupon Document (Data API 16.8)

(supports custom properties)

Document representing a coupon.

Property Type Constraints Description
coupon_id String maxLength=256, minLength=1 The id of the coupon.
description String maxLength=4000, minLength=0 The description of the coupon.
enabled boolean   A flag indicating whether the coupon is enabled.
exported_code_count Integer   The number of coupon codes attached to the coupon that have been issued (request search only).
link String   A link to the coupon.
redemption_count Integer   The number of times the coupon has been redeemed (request search only).
redemption_limits RedemptionLimits   The redemption limit per coupon code.
single_code String maxLength=256, minLength=1 Single coupon code, only valid for Single Code type
system_codes_config CouponSystemCodeConfig   The configuration of system coupon codes, including pre-fix and number of codes
total_codes_count Integer   The total number of coupon codes associated with this coupon
type Enum {single_code, multiple_codes, system_codes}   The type of the coupon code.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. By continuing to use this site you are giving us your consent to do this.