Program Object


A loyalty program allows sites to maintain customer reward accounts. Site owners can create a loyalty program to increase customer retention. Read more about the loyalty program in this overview.

Properties
namestringminLength 2maxLength 50

Program name.


pointDefinitionPointDefinition

Details about the program's collectible unit.


statusstringRead-only

Program status. Customers can only earn or redeem points while the program is ACTIVE.

Default: "DRAFT"


createdDatestringRead-onlyformat date-time

Date and time the program was created.


updatedDatestringRead-onlyformat date-time

Date and time the program was updated.


pointsExpirationPointsExpiration

Configuration for the points expiration feature.


premiumFeaturesPremiumFeaturesRead-only

Information about the available program premium features.

LoyaltyProgram
JSON
{ "loyaltyProgram": { "name": "Star Loyalty Program", "pointDefinition": { "customName": "Stars", "icon": { "id": "", "url": "shapes/58819f398c36404f8017aa8faa2240b4.svg", "height": 0, "width": 0 } }, "status": "ACTIVE", "pointsExpiration": { "status": "DISABLED", "monthsOfInactivity": 3, "expiringPointsPercentage": 100 }, "premiumFeatures": { "loyaltyProgram": true, "tiers": true, "pointsExpiration": true }, "createdDate": "2022-05-22T08:18:32.186Z", "updatedDate": "2022-06-07T08:40:47.426Z" } }
Did this help?