Promocode Properties CTCT Wrapper Documented Class Library
The Promocode type exposes the following members.
Properties

  NameDescription
Public propertyCodeName
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
Public propertyCodeType
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
Public propertyDiscountAmount
Specifies a fixed discount amount, minimum of 0.01, is required when code_type = DISCOUNT, but not using discount_percent
Public propertyDiscountPercent
Specifies a discount percentage, from 1% - 100%, is required when code_type = DISCOUNT, but not using discount_amount
Public propertyDiscountScope
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
Public propertyDiscountType
Discount types
Public propertyFeeIds
Identifies the fees to which the promocode applies;
Public propertyId
Unique ID for the event promotional code
Public propertyIsPaused
When set to true, promocode cannot be redeemed; when false, promocode can be redeemed; default = false
Public propertyQuantityAvailable
Number of promocodes available for redemption; -1 = unlimited
Public propertyQuantityTotal
Total number of promocodes available for redemption; -1 = unlimited
Public propertyQuantityUsed
Number of promocodes that have been redeemed; starts at 0
Public propertyStatus
Status of the promocode
Back to Top
See Also