Skip to content

Latest commit

 

History

History
26 lines (23 loc) · 2.95 KB

Coupon.md

File metadata and controls

26 lines (23 loc) · 2.95 KB

TalonOne.Model.Coupon

Properties

Name Type Description Notes
Id int Unique ID for this entity.
Created DateTime The exact moment 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 a coupon code can be redeemed. This can be set to 0 for no limit, but any campaign usage limits will still apply.
DiscountLimit decimal The amount of discounts that can be given with this coupon code. [optional]
StartDate DateTime Timestamp at which point the coupon becomes valid. [optional]
ExpiryDate DateTime Expiry 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]
UsageCounter int The number of times this coupon has been successfully used.
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]
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 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]
BatchId string The id of the batch the coupon belongs to. [optional]

[Back to Model list] [Back to API list] [Back to README]