Name | Type | Description | Notes |
---|---|---|---|
usageLimit | int | The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply. | |
discountLimit | float | The total discount value that the code can give. Typically used to represent a gift card value. | [optional] |
reservationLimit | int | The number of reservations that can be made with this coupon code. | [optional] |
startDate | \DateTime | Timestamp at which point the coupon becomes valid. | [optional] |
expiryDate | \DateTime | Expiration date of the coupon. Coupon never expires if this is omitted. | [optional] |
limits | \TalonOne\Client\Model\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 | int | 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 | 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 | bool | An indication of whether the code can be redeemed only if it has been reserved first. | [optional] [default to false] |
implicitlyReserved | bool | An indication of whether the coupon is implicitly reserved for all customers. | [optional] |