Added
Mystery reward API endpoint now available
December 10th, 2025
New mystery reward storefront API endpoints are now available to fetch, claim, and track mystery rewards for subscriptions in any locale.
What's New?
We’ve introduced three new mystery reward endpoints that let you power reward experiences directly in your headless subscriber portal:
- Mystery reward endpoint: Fetches mystery reward details for a given subscription ID in a specific locale. Use this to show eligible mystery rewards, messaging, and visuals on the customer portal.
- Claim mystery reward: Allows you to claim a mystery reward on a subscription by passing the
rewardId(mystery reward ID).rewardIdcan be fetched in Mystery reward endpoint.
Claim mystery reward endpoint is typically triggered when the subscriber clicks to redeem their mystery reward. - Add viewed logs for mystery reward: Logs when a mystery reward is viewed for a subscription. These view events can later be used to analyze impressions and conversion rates.
**Please note: **This endpoint should only be triggered if a customer views the mystery reward but doesn't claim the reward.
These endpoints return the following fields:
- configTexts: Customer-facing texts used to render the mystery reward experience.
- mysteryRewardType: The type of reward, e.g., gift or discount.
- subscriptionOrderNumber: The relevant order number on the subscription associated with the reward.
- source: The feature source triggering the reward, such as flows or streaks.
- rewardId: The unique ID of the mystery reward, used to claim the reward via the claim endpoint.
