Skip to content

Latest commit

 

History

History
24 lines (19 loc) · 2.48 KB

NewCoupons.md

File metadata and controls

24 lines (19 loc) · 2.48 KB

NewCoupons

Properties

Name Type Description Notes
usage_limit int The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.
discount_limit float The total discount value that the code can give. Typically used to represent a gift card value. [optional]
reservation_limit int The number of reservations that can be made with this coupon code. [optional]
start_date datetime Timestamp at which point the coupon becomes valid. [optional]
expiry_date datetime Expiration date of the coupon. Coupon never expires if this is omitted. [optional]
limits list[LimitConfig] Limits configuration for a coupon. These limits will override the limits set from the campaign. Note: Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured. [optional]
number_of_coupons int The number of new coupon codes to generate for the campaign. Must be at least 1.
unique_prefix str DEPRECATED To create more than 20,000 coupons in one request, use Create coupons asynchronously endpoint. [optional]
attributes object Arbitrary properties associated with this item. [optional]
recipient_integration_id str The integration ID for this coupon's beneficiary's profile. [optional]
valid_characters list[str] List of characters used to generate the random parts of a code. By default, the list of characters is equivalent to the `[A-Z, 0-9]` regular expression. [optional]
coupon_pattern str The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. [optional]
is_reservation_mandatory bool An indication of whether the code can be redeemed only if it has been reserved first. [optional] [default to False]
implicitly_reserved bool An indication of whether the coupon is implicitly reserved for all customers. [optional]

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