Skip to main content
To allow users to activate their subscriptions, the Merchant can set up redemption URLs in the Partner Ecosystem Management UI (Platform Settings > Activation). Merchants can choose whether to generate redemption codes for users or have Partner Ecosystem Management generate redemption codes. For a better user experience, it’s recommended that Merchants embed the redemption code in the redemption link so the user doesn’t have to manually enter it. Note: If the Merchant wants Partner Ecosystem Management to generate the redemption code and send the code along with the redemption URL, the Merchant needs to do the following: include “@xxx@” in the redemption URL when creating it. For example: https://www.example.com/@xxx@/activate. Ultimately, the user will receive the redemption link through the Reseller (Service Provider). There are two ways the Reseller can deliver the redemption URL to the user:
  1. Via email or SMS. When the user clicks on the link, it leads to the Merchant’s activation page (for example: **https://www.myapp.com/activate?redemption=<redemptionCode>**\).
  2. The link is embedded in the Activate button on the set-top box (STB). When the user clicks the launch button, it opens the Merchant’s app on the set-top box. For Android set-top boxes, this requires the Merchant to have an APK to support a native Android endpoint because the Android box doesn’t support opening a browser directly. For example, the link could look like this: myappvideo://?action=13&actionurl=http%3A%2F%2Fmyapp.id%3A%2Fh5%2FverificationCode%3D{{redemption-code}}.
After the user clicks the link (either through email/SMS or the launch button on the set-top box), the following will be processed:
  1. Capture the redemption code.
  2. If the user doesn’t already have an existing session open, the user is prompted to sign in or register.
  3. From the existing session or the user sign-in or registration, the Merchant receives the user identity.
  4. With the redemption code in step 1, search a matching redemption code from the new entries created through the steps in the Add Subscription Webhook > Internal Implementation and Response to Partner Ecosystem Management (New Subscription) section, and then link the new subscription (with the reference to partnerSubscriptionId) to the user identity just captured.
  5. Update the status of the user’s subscription to ACTIVATED (or equivalent). Note that there could be a delay between when the user purchases the Merchant’s subscription and when they choose to activate it. The start date of the subscription remains the same from the steps in the Add Subscription Webhook > Internal Implementation and Response to Partner Ecosystem Management (New Subscription) section.
  6. Call the PUT /partnerSubscription/{id} API to update the status to ACTIVE in MarketONE.
Parent topic:Design Guidelines for the Platform-Managed Flow