v1

latestSwagger 2.02026-07-1351226.3 KB
v1

Retrieve a list of Subscriptions for the specified Shopper

get/v1/subscriptions

Query parameters

productGroupKeysstring[]

Only return Subscriptions with the specified product groups

includesstring[]

Optional details to be included in the response

offsetinteger

Number of Subscriptions to skip before starting to return paged results (must be a multiple of the limit)

limitinteger

Number of Subscriptions to retrieve in this page, starting after offset

sort'expiresAt' | '-expiresAt'

Property name that will be used to sort results. "-" indicates descending

Headers

X-App-Keystring required

A unique application key identifying the source of the request. This is required for request tracking

X-Shopper-Idstring

Shopper ID to return subscriptions for when not using JWT

X-Market-Idstring

The market that the response should be formatted for

Response

Request was successful

All 5 operations