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.


pointsobjectRead-only

Information about the account totals.


latestTransactionobjectRead-onlydeprecated - use loyaltyTransaction instead

Details of the account's latest transaction.


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.


tierobjectRead-only

Tier information.


contactobjectRead-only

Contact information.


pointsExpirationobjectRead-only

Points expiration information

Was this helpful?
Yes
No