Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 2.41 KB

NewCoupons.md

File metadata and controls

25 lines (18 loc) · 2.41 KB

NewCoupons

Properties

Name Type Description Notes
usageLimit Integer The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.
discountLimit BigDecimal The total discount value that the code can give. Typically used to represent a gift card value. [optional]
reservationLimit Integer The number of reservations that can be made with this coupon code. [optional]
startDate OffsetDateTime Timestamp at which point the coupon becomes valid. [optional]
expiryDate OffsetDateTime 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]
numberOfCoupons Integer The number of new coupon codes to generate for the campaign. Must be at least 1.
uniquePrefix String 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]
recipientIntegrationId String The integration ID for this coupon's beneficiary's profile. [optional]
validCharacters List<String> 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]
couponPattern String The pattern used to generate coupon codes. The character `#` is a placeholder and is replaced by a random character from the `validCharacters` set. [optional]
isReservationMandatory Boolean An indication of whether the code can be redeemed only if it has been reserved first. [optional]
implicitlyReserved Boolean An indication of whether the coupon is implicitly reserved for all customers. [optional]