SquareConnect.LoyaltyEvent

Note: This model is in beta.

Provides information about a loyalty event. For more information, see Loyalty events.

Properties

Name	Type	Description	Notes
id	String	The Square-assigned ID of the loyalty event.
type	String	The type of the loyalty event. See LoyaltyEventType for possible values
created_at	String	The timestamp when the event was created, in RFC 3339 format.
accumulate_points	LoyaltyEventAccumulatePoints	Provides metadata when the event `type` is `ACCUMULATE_POINTS`.	[optional]
create_reward	LoyaltyEventCreateReward	Provides metadata when the event `type` is `CREATE_REWARD`.	[optional]
redeem_reward	LoyaltyEventRedeemReward	Provides metadata when the event `type` is `REDEEM_REWARD`.	[optional]
delete_reward	LoyaltyEventDeleteReward	Provides metadata when the event `type` is `DELETE_REWARD`.	[optional]
adjust_points	LoyaltyEventAdjustPoints	Provides metadata when the event `type` is `ADJUST_POINTS`.	[optional]
loyalty_account_id	String	The ID of the `loyalty account` in which the event occurred.
location_id	String	The ID of the `location` where the event occurred.	[optional]
source	String	Defines whether the event was generated by the Square Point of Sale. See LoyaltyEventSource for possible values
expire_points	LoyaltyEventExpirePoints	Provides metadata when the event `type` is `EXPIRE_POINTS`.	[optional]
other_event	LoyaltyEventOther	Provides metadata when the event `type` is `OTHER`.	[optional]