| id |
int |
The ID of loyalty program. Internal ID of this entity. |
|
| created |
\DateTime |
The time this entity was created. |
|
| title |
string |
The display title for the Loyalty Program. |
|
| description |
string |
Description of our Loyalty Program. |
|
| subscribedApplications |
int[] |
A list containing the IDs of all applications that are subscribed to this Loyalty Program. |
|
| defaultValidity |
string |
The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. |
|
| defaultPending |
string |
The default duration of the pending time after which points should be valid. Can be 'immediate' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. |
|
| allowSubledger |
bool |
Indicates if this program supports subledgers inside the program. |
|
| usersPerCardLimit |
int |
The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. |
[optional] |
| sandbox |
bool |
Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. |
|
| tiersExpireIn |
string |
The amount of time until the expiration of every tier, starting from the date when the customer joined the considered tier for the first time. The time format is an integer followed by one letter indicating the time unit. Examples: `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. |
[optional] |
| tiersDowngradePolicy |
string |
Customers's tier downgrade policy. - `one_down`: Once the tier expires and if the user doesn't have enough points to stay in the tier, the user is downgraded one tier down. - `balance_based`: Once the tier expires, the user's tier is evaluated based on the amount of active points the user has at this instant. |
[optional] |
| accountID |
int |
The ID of the Talon.One account that owns this program. |
|
| name |
string |
The internal name for the Loyalty Program. This is an immutable value. |
|
| tiers |
\TalonOne\Client\Model\LoyaltyTier[] |
The tiers in this loyalty program. |
[optional] |
| timezone |
string |
A string containing an IANA timezone descriptor. |
|
| cardBased |
bool |
Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based. |
[default to false] |
| canUpdateTiers |
bool |
`True` if the tier definitions can be updated. |
[optional] [default to false] |
| canUpgradeToAdvancedTiers |
bool |
`True` if the program can be upgraded to use the `tiersExpireIn` and `tiersDowngradePolicy` properties. |
[optional] [default to false] |