List loyalty promotions

GET /v2/loyalty/programs/{program_id}/promotions

Lists the loyalty promotions associated with a loyalty program.

Open in API Reference

Access Tokens Sign in to populate your access tokens from the Developer Console Sign In

Parameters

program_id

The ID of the base loyalty program. To get the program ID, call RetrieveLoyaltyProgram using the main keyword.

string

status

The status to filter the results by. If a status is provided, only loyalty promotions with the specified status are returned. Otherwise, all loyalty promotions associated with the loyalty program are returned.

string

Select status

ACTIVE The loyalty promotion is currently active. Buyers can earn points for purchases that meet the promotion conditions, such as the promotion's available_time.
ENDED The loyalty promotion has ended because the specified end_date was reached. ENDED is a terminal status.
CANCELED The loyalty promotion was canceled. CANCELED is a terminal status.
SCHEDULED The loyalty promotion is scheduled to start in the future. Square changes the promotion status to ACTIVE when the start_date is reached.

cursor

The cursor returned in the paged response from the previous call to this endpoint. Provide this cursor to retrieve the next page of results for your original request. For more information, see Pagination.

string

limit

The maximum number of results to return in a single paged response. The minimum value is 1 and the maximum value is 30. The default value is 30. For more information, see Pagination.

integer

You are viewing an old version of the API

All Versions

Request

cURL

Ruby

Python

Java

PHP

Node.js

Response

// No response received yet.

Thanks for the feedback. For more help, check out our support resources.

Developer Support Developer Forums

There was an error submitting feedback. Try again later.

Developer Support Developer Forums