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.Form_Fields (array of Form Field object)
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:
Returns the role name, for example "Fundraiser" or "Attendee". Role.Name is the same as
Role.Label, just stripped of special characters (like spaces).
Returns the cost of the role. Use a money filter to return the value in a monetary format:
Returns the amount actually paid for the role. This can be different than role cost when a discount is applied. Use a money filter to return the value in a monetary format:
Returns the discount amount applied to the role cost. Use a money filter to return the value in a monetary format:
Returns the role name, with special characters intact.
Returns the role's API name. The API name is unique, so you can be sure there are no duplicates when using API name.
Returns an array of form field objects associated with the role.