Account Object


A loyalty account stores a customer's loyalty points balance. A site's customers can earn points to their account and redeem those points for rewards.

Properties
idstringRead-onlyformat GUID

Account ID.


contactIdstringRead-onlyformat GUID

Account owner's contact ID. See the Contacts API to learn more about a site's contacts.


memberIdstringRead-onlyformat GUID

Account owner's member ID. See the Members API to learn more about a site's members.


pointsPointsRead-only

Information about the account totals.


rewardAvailablebooleanRead-only

Whether the account has a reward available. true if the amount of points in points.balance are enough to redeem for a reward.


createdDatestringRead-onlyformat date-time

Date and time the account was created.


updatedDatestringRead-onlyformat date-time

Date and time the account was last updated.


lastActivityDatestringRead-onlyformat date-time

Account's last activity date and time.


revisionnumber

Revision number, which increments by 1 each time the loyalty account is updated.

To prevent conflicting changes, the current revision must be passed when updating the loyalty account.

Ignored when creating an account.


tierTierRead-only

Tier information.


contactContactRead-only

Contact information.


pointsExpirationPointsExpirationRead-only

Points expiration information

LoyaltyAccount
JSON
{ "account": { "id": "e6f39a5b-a6d0-4556-b889-0cf09d8a84f7", "contactId": "88615e02-3e8a-4297-8939-5d0a432b322a", "memberId": "a517751b-a1ca-4423-8d91-aaf8f5b34215", "points": { "balance": 15, "earned": 10, "redeemed": 0, "adjusted": 5 }, "rewardAvailable": true, "createdDate": "2021-12-06T14:33:19.114Z", "updatedDate": "2021-12-07T07:30:23.749Z", "revision": "4", "tier": { "id": "1415f107-640c-4e04-870f-149cdd562093", "updatedDate": "2021-12-07T07:30:23.749Z", "recalculationDate": null, "points": 15 }, "lastActivityDate": "2021-12-07T07:30:23.749Z", "contact": { "id": "7728152f-7deb-45f8-913f-7fdff4abbebe", "name": "Johna Linskey", "picture": null, "email": "johna.linskey@yopmail.com", "displayName": "Johna Linskey" }, "points_expiration": { "expiration_date": "2022-05-07T07:30:23.749Z", "expiring_points_amount": 5 } } }
Did this help?