Promocode Members CTCT Wrapper Documented Class Library

The Promocode type exposes the following members.
Constructors

  NameDescription
Public methodPromocode
Constructor
Back to Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToJSON
Serialize an object to JSON.
(Inherited from Component.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Back to Top
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