Object Index
You are viewing an old version of the API
LoyaltyEvent
BETA
Object Index
Provides information about a loyalty event.
For more information, see Loyalty events.
Properties
| Name | Description |
|---|---|
id
Required
|
Read only The Square-assigned ID of the loyalty event. |
type
Required
|
Read only The type of the loyalty event. |
created_at
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 |
accumulate_points
|
Read only Provides metadata when the event |
create_reward
|
Read only Provides metadata when the event |
redeem_reward
|
Read only Provides metadata when the event |
delete_reward
|
Read only Provides metadata when the event |
adjust_points
|
Read only Provides metadata when the event |
loyalty_account_id
Required
|
Read only The ID of the loyalty account in which the event occurred. |
location_id
|
Read only The ID of the location where the event occurred. |
source
Required
|
Read only Defines whether the event was generated by the Square Point of Sale. |
expire_points
|
Read only Provides metadata when the event |
other_event
|
Read only Provides metadata when the event |