Skip to main content

Permanent links

The following information describes the structure of some of the most common links that users of the Cleverbridge platform integrate with their system.

note

The following links are permanent, which means that their validation is not restricted to a specific period. For more information on the new expiring link structure, see Expiring links. To switch over to the new expiring link structure, contact Client Experience.

Change subscription payment using a subscription ID (SCP)​

Use the following link to allow a customer to update, change, or manage their payment method preferences for a subscription.

Example
https://www.cleverbridge.com/<client_ID>/scp/S<subscription_ID>-<subscription_secret>

Change subscription payment using a purchase ID (CPP)​

Use the following link to allow a customer to update their payment profile for future billings.

Example
https://www.cleverbridge.com/<client_ID>/cpp/<purchase_ID>-<purchase_secret>

Deactivate a subscription item (CSI)​

Use the following link (available only for Subscription Management 1.0) to allow a customer to deactivate a subscription item.

Example
https://www.cleverbridge.com/<client_ID>/csi/S<subscription_ID>-<subscription_secret>-<subscription_item_running_number>

Activate a subscription item (ASI)​

Use the following link (available only for Subscription Management 1.0) to allow a customer to reinstate the subscription item so they can continue using the product. If you use this link, the subscription is switched to an auto-renewal billing cycle.

Example
https://www.cleverbridge.com/<client_ID>/asi/S<subscription_ID>-<subscription_secret>-<subscription_item_running_number>

Renew a subscription item (RSI)​

Use the following link (available only for Subscription Management 2.0) to allow a customer to renew the subscription item of a manual renewal subscription.

Example
https://www.cleverbridge.com/<client_ID>/rsi/S<subscription_ID>-<subscription_secret>-<subscription_item_running_number>

Update a subscription (USI)​

Use the following link to allow a customer to expand the subscription by using one of the available upgrade options.

Example
https://www.cleverbridge.com/<client_ID>/usi/S<subscription_ID>-<subscription_secret>-<subscription_item_running_number>?cart=s<product_selection_ID>:<product_ID>

Customer self-service​

Use the following link to allow a customer to manage their subscription, such as deactivating and reactivating recurring billing for specific subscription items (for Subscription Management 1.0) or switching their billing configuration from automatic to manual and vice versa (for Subscription Management 2.0), viewing their subscription plans and payment schedule, and changing their payment information.

Example
https://www.cleverbridge.com/<client_ID>/s/S<subscription_ID>-<subscription_secret>
note

Subscription-related URLs are identified and secured with a combination of the subscription ID and subscription secret. The subscription secret is not directly mapped out in the Cleverbridge JSON schema, but it can be found within the ChangePaymentSubscriptionUrl element:

"changePaymentSubscriptionUrl": "https://www.cleverbridge.com/123/scp/S14640654-wNmJmYBvjZZHAF3E",

Change payment information (CP)​

Use the following link to allow a customer to change their payment information for an unpaid purchase. The link allows a customer to retry their credit card in case it was declined or change the payment option.

Example
https://www.cleverbridge.com/<client_ID>/cp/<purchase_ID>-<purchase_secret>

Confirmation page​

Use the following link to allow a customer to see the details of their purchase after completing a transaction.

Example
https://www.cleverbridge.com/<client_ID>/p/<purchase_ID>-<purchase_secret>

PDF download (invoice)​

Use the following link to allow a customer to download the receipt related to their purchase.

Example
https://www.cleverbridge.com/<invoice>/<invoice_secret>/<invoice_number>.pdf

Submit payment (PayPal)​

Use the following link to allow a customer to finalize their purchase through PayPal, redirecting them instantly for a seamless transaction completion. This link is useful for customers expressing interest in paying via PayPal but haven't yet completed the purchase.

Example
https://www.cleverbridge.com/<client_ID>/Paypal/<purchase_ID>-<purchase_secret>

Update recurring billing (URB)​

Use the following link to allow a customer to update their recurring billing conditions.

Example
https://www.cleverbridge.com/<client_ID>/urb/<purchase_ID>-<purchase_secret>-<purchase_item_running_number>

Cancel recurring billing (CRB)​

Use the following link (available only for Subscription Management 2.0) to allow a customer to cancel their recurring billing. The customer needs to turn off the automatic extension using the toggle button.

Example
https://www.cleverbridge.com/<client_ID>/crb/<purchase_ID>-<purchase_secret>-<purchase_item_running_number>

If a subscription self-service is activated, any access through CRB, CSI, and RSI links gets automatically redirected to the self-service page. In such a case, within the link, the page identifier is changed to "s".

Change quote (CQ)​

Use the following link to allow a customer to view and download the details of their quote document.

Example
https://www.cleverbridge.com/<client_ID>/cq/<purchase_ID>-<purchase_secret>

Customer change payment (CCP)​

Use the following link to allow a customer to change the payment option.

Example
https://www.cleverbridge.com/<client_ID>/ccp/c<customer_ID>-<customer_secret>

New cart from purchase (LCP)​

Use the following link to allow a customer to request a quote for a purchase or to proceed directly to the express checkout.

Example
https://www.cleverbridge.com/<client_ID>/lcp/<purchase_ID>-<purchase_secret>-<purchase_item_running_number>?cart-<product_ID>

Within the LCP link, the purchase item running number is optional.

Redo the purchase (REDOP)​

Use the following link to allow a customer to redo the purchase by either requesting a quote or proceeding directly to payment.

Example
https://www.cleverbridge.com/<client_ID>/redop/<purchase_ID>-<purchase_secret>

Delivery confirmation (PD)​

Use the following link to allow a customer to view the confirmation of their purchase.

Example
https://www.cleverbridge.com/<client_ID>/pd/<purchase_ID>-<purchase_secret>

Did you find this doc useful?