Name | Type | Description | Notes |
---|---|---|---|
title | str | The display title for the Loyalty Program. | |
description | str | Description of our Loyalty Program. | [optional] |
subscribed_applications | list[int] | A list containing the IDs of all applications that are subscribed to this Loyalty Program. | [optional] |
default_validity | str | 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. | |
default_pending | str | 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. | |
allow_subledger | bool | Indicates if this program supports subledgers inside the program. | |
users_per_card_limit | 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. | |
name | str | The internal name for the Loyalty Program. This is an immutable value. | |
tiers | list[NewLoyaltyTier] | The tiers in this loyalty program. | [optional] |
timezone | str | A string containing an IANA timezone descriptor. | |
card_based | bool | Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based. | [default to False] |