Tier Definitions

📘

Profile Tier information

A tier definition contains data unique to each individual tier. To review profile data in relation to the associated tiers, you can review Read Profile Tier

Tier definition properties

AttributeDescription
id
STRING
READ-ONLY
the ID of the tier
name
STRING
The name of the tier
handle
STRING
A unique handle for the tier
is_floor
BOOLEAN
Denotes whether this tier is the lowest tier the profile can achieve
value_min
INTEGER
The minimum amount of points needed to achieve this tier
value_maintain
INTEGER
The points needed to be achieved to maintain this tier by the next tier anniversary
is_assignable
BOOLEAN
Denotes whether this tier is assignable to the current member profile
internal_notes
STRING
Internal notes made against the tier
description
STRING
The basic description for the tier
short_description
STRING
A short description about the current tier
long_description
STRING
A long description for the tier in HTML markup.
terms_conditions
STRING
The terms and conditions for the tier
icon
STRING
URL
A URL for the desired icon for this tier
image_url
STRING
URL
A URL for the desired cover image for this tier
earn_instructions
STRING
instructions on earning this tier
tags
ARRAY
Tags associated with this tier
created_at
DATE-TIME
READ-ONLY
The date and time this tier was created
updated_at
DATE-TIME
READ-ONLY
The date and time this tier was last updated