The Promocode type exposes the following members.
Back to Top
Back to Top
Back to Top
Constructors
| Name | Description | |
|---|---|---|
| Promocode |
Constructor
|
Methods
| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) | |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
| ToJSON |
Serialize an object to JSON.
(Inherited from Component.) | |
| ToString | Returns a String that represents the current Object. (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
| CodeName |
Name of the promotional code visible to registrants, between 4 - 12 characters, cannot contain spaces or special character (_ is OK); each code_name must be unique
| |
| CodeType |
Type of promocode:
ACCESS - applies to a specific fee with has_restricted_access = true, fee_list must include only a single fee_id. See Event Fees
DISCOUNT - when set to DISCOUNT, you must specify either a discount_percent or a discount_amount
| |
| DiscountAmount |
Specifies a fixed discount amount, minimum of 0.01, is required when code_type = DISCOUNT, but not using discount_percent
| |
| DiscountPercent |
Specifies a discount percentage, from 1% - 100%, is required when code_type = DISCOUNT, but not using discount_amount
| |
| DiscountScope |
Required when code_type = DISCOUNT;
FEE_LIST - discount is applied only to those fees listed in the fee_ids array ORDER_TOTAL - discount is applied to the order total
| |
| DiscountType |
Discount types
| |
| FeeIds |
Identifies the fees to which the promocode applies;
| |
| Id |
Unique ID for the event promotional code
| |
| IsPaused |
When set to true, promocode cannot be redeemed; when false, promocode can be redeemed; default = false
| |
| QuantityAvailable |
Number of promocodes available for redemption; -1 = unlimited
| |
| QuantityTotal |
Total number of promocodes available for redemption; -1 = unlimited
| |
| QuantityUsed |
Number of promocodes that have been redeemed; starts at 0
| |
| Status |
Status of the promocode
|
See Also