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. | |
ApplicationId | int | The ID of the application that owns this entity. | |
AccountId | int | The ID of the account that owns this entity. | |
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] |
NumberOfCoupons | int | The number of new coupon codes to generate for the campaign. | |
CouponSettings | CodeGeneratorSettings | [optional] | |
Attributes | Object | Arbitrary properties associated with coupons. | |
BatchId | string | The batch ID coupons created by this job will bear. | |
Status | string | The current status of this request. Possible values: - `pending verification` - `pending` - `completed` - `failed` - `coupon pattern full` | |
CreatedAmount | int | The number of coupon codes that were already created for this request. | |
FailCount | int | The number of times this job failed. | |
Errors | List<string> | An array of individual problems encountered during the request. | |
CreatedBy | int | ID of the user who created this effect. | |
Communicated | bool | Whether or not the user that created this job was notified of its final state. | |
ChunkExecutionCount | int | The number of times an attempt to create a chunk of coupons was made during the processing of the job. | |
ChunkSize | int | The number of coupons that will be created in a single transactions. Coupons will be created in chunks until arriving at the requested amount. | [optional] |