Set Up X-Parameters

X-parameters are components of URLs used to pass information through the checkout process, such as:

X-parameters are configured for attributes initiated outside the Cleverbridge platform. You can create x-parameters based on an information need that is not inherently included in the Cleverbridge platform, such as a user ID number or the name of a campaign. X-parameters must begin with x-.

How it Works

You can transmit x-parameters to the Cleverbridge platform by:

There is no limit to how many x-parameters that can be added to a transaction.

View X-Parameters

You can view x-parameters in two ways:

  • In a specific transaction in the Purchase viewer
  • In reports


You can use x-parameters in conjunction with notifications for automated transaction and license key generation. This functionality exports data related to the x-parameters to your back-end systems. To learn more about notifications, see Notifications ✱.

Pass X-Parameters in Order URLs

After defining x-parameters, you can add them to their corresponding orderClosed An agreement between a seller and a buyer to exchange goods and/or services for money. An order can: - contain multiple products and quantities; - have multiple financial transactions. A preorder authorization is considered an order. URLs and start tracking important customerClosed An individual or business purchasing your product or service by placing an order through Cleverbridge. The customer is the end user of this product, as they are not allowed to resell the purchased products or services. ​ A customer is unique per client. If a customer purchases products or services from two different clients, there are 2 separate records of said customer.​ data.

X-parameters must be appended to the Cleverbridge-hosted order URL in order to pass through the order process. As long as the parameter begins with x-, it will be saved in the order process. The number of x-parameters that can be passed is unlimited.


This is the format of an x-parameter in an order URL:


Parameter Description

Select a name for the additional parameter. All alphanumeric characters are allowed as well as hyphens. This value is case sensitive.


All additional parameters must begin with x-. The first x-parameter appended to the URL must be separated by a question mark (?), after which any additional x-parameters are separated by an ampersand (&).

<value> The actual value for the additional parameter you want to pass to the Cleverbridge system.



Creating order URLs is a manual process using the following conventions:

The following is an example of a configured order URL that includes an MVT:

Add X-Parameters to Existing Orders

If you would like x-parameters to be included in revenue reports, you can add them to a completed purchase.


If you use this method to add an x-parameter to a subscription-related order, the x-parameter won't be included in future billing events.

Add a Parameter

  1. In the main menu, select Transactions > Purchases. The Purchases search opens.
  2. Search for the order you would like to add the x-parameter to.
  3. To open the record, double-click it.
  4. In the Purchase Details section, click Add Parameter. The Add Parameter window displays.
  5. Enter the parameter name (key) and value, and click OK. The parameter is added to the order, and displays in the Parameters section.

Edit a Parameter

  1. In the Purchase Details section, in the Parameters section, right-click a parameter and select Open. The Edit Parameter window displays.
  2. Enter a new value.
  3. Click OK.

View X-Parameters in the Commerce Assistant

You can view x-parameters in multiple spots in the Commerce Assistant:

  • In the Purchase Viewer
  • In the Purchase Search
  • Within the reports


You can run simple reports using the Commerce Assistant; but for more advanced revenue tracking, Cleverbridge recommends using Business Intelligence.

Purchase Viewer

You can view x-parameters in the Parameters section of the Purchase Details section in the Purchase Viewer.

Purchase Search

You can view x-parameters in the Purchase Search by adding the Parameters column. For more information, see Search ✱ > Filter Search Results Using Grouping Filters .


You can view x-parameters in Commerce Assistant reports by navigating to Promotions and recommendations > Tracking > Revenue. You can select out of several types of reports.