Subscription Management Portal integrations

Subscription Management is integrated with other Cleverbridge tools and functionalities to ensure consistent user experience and seamless configuration flows.

Generating subscription management links

Customers can reach the Subscription Management Portal through the order and subscription email communication sent by Cleverbridge. It is also possible to integrate direct links to any of the subscription flows:

• Subscription Overview - use the following link to allow a customer to update, change, or manage their subscription
  https://www.cleverbridge.com/<client_ID>/s/S<subscription_ID>?s=<start_time>&e=<end_time>&c=<checksum>

• Renewal Funnel - use the following link to allow a customer to renew their subscription.
  https://www.cleverbridge.com/<client_ID>/?scope=subscription&target=manual-renewal&template=steps&sid=S<subscription_ID>&s=<start_time>&e=<end_time>&c=<checksum>

• Upgrade Funnel - use the following link to allow a customer to upgrade their subscription products (co-term).
  https://www.cleverbridge.com/<client_ID>/?scope=subscription&target=upgrade-subscription&template=steps&sid=S<subscription_ID>&s=<start_time>&e=<end_time>&c=<checksum>

For more information on how to generate the validity period and checksum of your link, see Expiring Links.

Adding URL parameters

In addition to the standard subscription flow links, you can further customize the customer experience by appending URL parameters to these links. These parameters allow you to control specific elements of the subscription management process, such as setting product quantities, preselecting items to add to a subscription, or bypassing certain steps in the funnel.

Mandatory URL Parameters

The following parameters are required for the subscription links to function correctly. They are typically included in the default subscription portal links.

Parameter	Description
scope	Points to the new subscription portal for an existing subscription.
sid	The subscription ID you’d like to access, starting with an S prefix.
target	Tells the system which specific subscription funnel to re-direct to. Allowed values: manual-renewal: Use this when you want a customer to renew their subscription (pay for the next unpaid subscription interval). upgrade-subscription: Use this when you want a customer to make an immediate product or quantity upgrade at a pro-rated price (for the current active subscription interval). self-service: Use this if you want a customer to manage their subscription, like updating payment details, contact information, or subscription status.
template	For each subscription funnel, we have different variations that are optimized for specific scenarios. The allowed values depend on the previous target value: For target=manual-renewal: steps: Allow the customer to choose from all available products and plans before renewing their subscription. one-click: Ask a customer to renew their subscription with the same products as before. For target=upgrade-subscription: steps: Allow the customer to choose from all available product and plan upgrades. quantity-increase: Use this if you want a customer to buy additional quantity. For target=self-service: tabs: Allow users to manage different aspects of their subscription, such as purchase status, payment details or contact data.

Optional URL parameters

These additional parameters can be added to further customize the subscription experience. They are not required for the basic subscription portal functionality but can be used to enhance the flow.

Parameter	Description
coupon	Add a coupon code to the upgrade or renewal offer. In case you would like to hide the coupon code from the user, please encrypt the link using our Session URL API. Can only be combined with target=manual-renewal or target=upgrade-subscription.
productsetup	In case you would like to offer different products to different customer segments, use this parameter to load a specific product configuration. This is currently in beta and not available in our Subscription Commerce Manager (SCM) yet. Please contact Client Experience if you would like to utilize this functionality.
quantity={number}	Sets the total quantity for all products in the subscription. Can be used in upgrade-subscription or manual-renewal links to preset the quantity value in case the user wishes to increase or decrease it. For the upgrade funnel, the value must be higher than the current subscription quantity. A pro-rated price for the additional quantity will be calculated automatically.
cart={productIds}	A comma-separated list of product IDs that should be added to the subscription. This parameter can be used in upgrade-subscription or manual-renewal links to preselect specific product tiers or recommendations that are visible on the page. If one of the product IDs includes an upgrade or downgrade of an existing product, the existing product will be automatically replaced by the new up- or downgrade.
instantReview=true	Can be used in upgrade-subscription or manual-renewal links to bypass the selection page and go directly to the final review step. This can be combined with previous parameters to preselect a specific upgrade or downgrade offer and ask the user to confirm.

Here’s the subsection to paste right after Optional URL parameters:

Use x-parameters (custom tracking)

Use x-* URL parameters to tag Subscription Management Portal traffic for analytics and downstream filtering. Append any key–value pairs that start with x- to the links above to identify the source, flow, campaign, or other segments of interest. These tags help you answer questions like “Of today’s purchases, how many came via the portal?”

You can append one or more x-parameters to any Subscription Management link. The parameters are ignored by the portal logic and can be used in your analytics and purchase filtering.

For more details, see Set up x-parameters.

Did you find this doc useful?