<- Object

Object

All versions ->

LoyaltyEvent

Provides information about a loyalty event.

Link to section

Properties

Link to section

id

string

Required

Read only The Square-assigned ID of the loyalty event.

Min Length
1
Link to section

type

string

Required

Read only The type of the loyalty event.

Link to section

created_at

string

Required

Read only The timestamp when the event was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Min Length
1
Link to section

accumulate_points

Read only Provides metadata when the event type is ACCUMULATE_POINTS.

Link to section

create_reward

Read only Provides metadata when the event type is CREATE_REWARD.

Link to section

redeem_reward

Read only Provides metadata when the event type is REDEEM_REWARD.

Link to section

delete_reward

Read only Provides metadata when the event type is DELETE_REWARD.

Link to section

adjust_points

Read only Provides metadata when the event type is ADJUST_POINTS.

Link to section

loyalty_account_id

string

Required

Min Length
1
Max Length
36
Link to section

location_id

string

Read only The ID of the location where the event occurred.

Link to section

source

string

Required

Read only Defines whether the event was generated by the Square Point of Sale.

Link to section

expire_points

Read only Provides metadata when the event type is EXPIRE_POINTS.

Link to section

other_event

Read only Provides metadata when the event type is OTHER.