Lists the loyalty promotions associated with a loyalty program. API Reference ->
Lists the loyalty promotions associated with a loyalty program. API Reference ->
Sign in to populate your access tokens from the developer dashboard
program
string
Required
A string that contains no characters. In an API request this value will appear as ''
. Can be used to remove a field's value.
cursor
string
A string that contains no characters. In an API request this value will appear as ''
. Can be used to remove a field's value.
limit
integer(32-bit)
status
string
The loyalty promotion is currently active. Buyers can earn points for purchases that meet the promotion conditions, such as the promotion's available_time
.
The loyalty promotion has ended because the specified end_date
was reached. ENDED
is a terminal status.
The loyalty promotion was canceled. CANCELED
is a terminal status.
The loyalty promotion is scheduled to start in the future. Square changes the promotion status to ACTIVE
when the start_date
is reached.
Response
// No response received yet.