Name | Type | Description | Notes |
---|---|---|---|
Id | int | Internal ID of this entity. | |
Created | DateTime | The time this entity was created. | |
CampaignId | int | The ID of the campaign that owns this entity. | |
Value | string | The coupon code. | |
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 | decimal | 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 | 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] |
UsageCounter | int | The number of times the coupon has been successfully redeemed. | |
DiscountCounter | decimal | The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. | [optional] |
DiscountRemainder | decimal | The remaining discount this coupon can give. | [optional] |
ReservationCounter | decimal | The number of times this coupon has been reserved. | [optional] |
Attributes | Object | Custom attributes associated with this coupon. | [optional] |
ReferralId | int | The integration ID of the referring customer (if any) for whom this coupon was created as an effect. | [optional] |
RecipientIntegrationId | string | The Integration ID of the customer that is allowed to redeem this coupon. | [optional] |
ImportId | int | The ID of the Import which created this coupon. | [optional] |
Reservation | bool | Defines the reservation type: - `true`: The coupon can be reserved for multiple customers. - `false`: The coupon can be reserved only for one customer. It is a personal code. | [optional] [default to true] |
BatchId | string | The id of the batch the coupon belongs to. | [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] |