| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | Internal ID of this entity. | |
| created | datetime | The time this entity was created. | |
| campaign_id | int | The ID of the campaign that owns this entity. | |
| value | str | The coupon code. | |
| 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, zero, or negative. | [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] |
| usage_counter | int | The number of times the coupon has been successfully redeemed. | |
| discount_counter | float | The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon. | [optional] |
| discount_remainder | float | The remaining discount this coupon can give. | [optional] |
| reservation_counter | float | The number of times this coupon has been reserved. | [optional] |
| attributes | object | Custom attributes associated with this coupon. | [optional] |
| referral_id | int | The integration ID of the referring customer (if any) for whom this coupon was created as an effect. | [optional] |
| recipient_integration_id | str | The Integration ID of the customer that is allowed to redeem this coupon. | [optional] |
| import_id | int | The ID of the Import which created this coupon. | [optional] |
| reservation | bool | Defines the type of reservation: - `true`: The reservation is a soft reservation. Any customer can use the coupon. This is done via the Create coupon reservation endpoint. - `false`: The reservation is a hard reservation. Only the associated customer (`recipientIntegrationId`) can use the coupon. This is done via the Campaign Manager when you create a coupon for a given `recipientIntegrationId`, the Create coupons endpoint or Create coupons for multiple recipients endpoint. | [optional] [default to True] |
| batch_id | str | The id of the batch the coupon belongs to. | [optional] |
| is_reservation_mandatory | bool | Whether the reservation effect actually created a new reservation. | [optional] [default to True] |