Skip to content

Latest commit

 

History

History
21 lines (14 loc) · 1.65 KB

UpdateCoupon.md

File metadata and controls

21 lines (14 loc) · 1.65 KB

UpdateCoupon

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. [optional]
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]
recipientIntegrationId String The integration ID for this coupon's beneficiary's profile. [optional]
attributes Object Arbitrary properties associated with this item. [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]