Skip to main content
Retrieve a paginated, newest-first feed of the customer’s loyalty activity: point earnings, redemptions, and cashback rows combined into a single list.

Usage

Parameters

number
default:"10"
Maximum number of rows to return.
number
default:"0"
Number of rows to skip, for pagination.

Response

boolean
Whether the request was successful.
number
The customer’s current balance, in the shop’s loyalty unit.
string | null
When the next tranche of points expires, or null.
boolean
Whether the shop runs cashback. When true, cashback rows may appear in the feed.
array
The activity rows.
object
{ hasMore, totalCount }. Use with offset to page through the feed.
object
Merchant-configured { greeting, description } copy for the activity block.
string
"points" or "store_credit". In store-credit mode points values are minor currency units. See Loyalty modes.
string
The shop’s ISO currency code.

Sample response