LoyaltyProgram

Get Subscription Data

Get Information of balances, tiers, rewards and subscription members for a subscription

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

pidstringRequiredformat: "uuid"
Loyalty Program ID. A unique identifier for the loyalty program.

Query parameters

contactIdstringOptional
The contact ID to filter by.
paramsstringOptional
A list of filter parameters for querying the subscription info.
loyaltySubscriptionIdstringOptional
The loyalty subscription ID to filter by.

Response

Successfully retrieved subscription info.
balanceobject or null
Balance details for the subscription.
memberslist of objects or null
List of members associated with the subscription.
rewardlist of objects or null
List of rewards associated with the subscription.
tierlist of objects or null
List of tier assignments for the subscription.

Errors