The Role object contains information related to a role assigned to a registrant who registered through the Role Registration Flow.
Availability: The Role object is available in the Registration emails on Role Registration campaigns.
Attributes: The Role object has the following attributes:
-
Role.Name
-
Role.Cost
-
Role.Amount_Paid
-
Role.Discount_Amount
-
Role.Label
- Role.Api_Name
- Role.Form_Fields (array of Form Field object)
Roles
Returns an array of Role objects—all the roles the registrant applied in their registration. Use an array filter or iteration tag to display the desired information. One useful filter that can be used commonly is all_info, which displays names and field information for all the roles purchased/reserved in the relevant transaction:
Your roles:{{ Roles | all_info }}
Your roles:
Fundraiser
Goal Amount: $500
Attendee
T-shirt size: M, Age: Over 18
Role.Name
Returns the role name, for example "Fundraiser" or "Attendee". Role.Name is the same as Role.Label, just stripped of special characters (any character that is not English alpha-numerical). It is recommended to use Role.Label.
Role.Cost
Returns the cost of the role. Use a moneyfilter to return the value in a monetary format:
{{ Role.Cost | money }}
$25
Role.Amount_Paid
Returns the amount actually paid for the role. This can be different than role cost when a discount is applied. Use a moneyfilter to return the value in a monetary format:
{{ Role.Amount_Paid | money }}
$20
Role.Discount_Amount
Returns the discount amount applied to the role cost. Use a moneyfilter to return the value in a monetary format:
{{ Role.Discount_Amount | money }}
$5
Role.Label
Returns the role name, with special characters intact.
Role.Api_Name
Returns the role's API name. The API name is unique, so you can be sure there are no duplicates when using API name.
Role.Form_Fields
Returns an array of form field objects associated with the role.