Track a payment link
Use URL parameters and UTM codes to track a payment link.
Modify your payment link with URL parameters and Urchin Tracking Module (UTM) codes to get insight into customer behaviours and your marketing strategy’s effectiveness. These tools help identify the source of your traffic and the marketing campaigns leading to the most conversions.
Track campaigns with UTM codes
Use UTM codes to track how customers find your site when they pay using your payment link. You can add the following UTM codes as parameters in the query string of your URL: utm_
, utm_
, utm_
, utm_
, and utm_
.
Parameter | Description |
---|---|
utm_ | Identifies where the traffic originated (for example, a website name, social media, or a search engine). |
utm_ | Identifies what content your customer chooses. Use this parameter to distinguish between links that point to the same payment page. |
utm_ | Identifies the marketing medium that accesses your payment link (for example, email, cost per click (cpc), or other methods). |
utm_ | Identifies specific search terms and keywords in your paid search ads. |
utm_ | Identifies your marketing campaigns using the payment link URL. |
To add UTM codes, specify redirect
as your confirmation behaviour. When customers complete a payment, your redirect URL contains the UTM code parameters specified in your payment link URL. Here’s what a payment link looks like with an appended UTM codes: https://buy.
Caution
Construct UTM codes using alphanumeric characters, dashes, or underscores, ensuring they don’t exceed a 150-character limit. Invalid values are discreetly discarded, guaranteeing your payment links performance remains unaffected.
Simplify reconciliation with a URL parameter
You can simplify reconciliation with the client_
URL parameter. Use URL parameters in the query string of your payment link URL. To configure URL parameters directly in the Dashboard Payment Links page:
- Click the payment link you want to modify.
- Click the down arrow of the Copy button and select URL parameters.
- In the window, use the drop-down menu to select Client reference ID.
- Enter a value that meets the requirements described in the following table to append the reference to your URL.
- Copy the amended URL for use in your integration.
Parameter | Description | Syntax |
---|---|---|
client_ | Use client_ to attach a unique string of your choice to the Checkout Session. This can be a customer ID or a cart ID (or similar), and you can use it to reconcile the Session with your internal systems. If you add this parameter to your payment link, it’s sent in the checkout.session.completed webhook after payment completion. | client_ can be composed of alphanumeric characters, dashes, or underscores, and be any value up to 200 characters. Invalid values are silently dropped, but your payment page continues to work as expected. |