Creating Direct Purchase Links (Buy Links)

What Is a Buy Link?

A buy link is a special URL you can share with patients β€” via email, SMS, or any marketing channel β€” that takes them directly to the checkout page for a specific product.

The patient does not need to browse the shop or add anything to their cart. When they click the link, everything is set up automatically, and they land on the checkout page ready to complete their purchase.

Buy links work for both new patients (who need to create an account) and existing patients (who already have an account).


Step 1 β€” Get the Product ID

Every product has a unique ID in the system. You will need this to build the link.

  • Obtain the Product ID from CRM.

  • The ID is a string of letters and numbers, for example:

    687fd9dc70c3834e0ae2987f


Step 2 β€” Build the Base Link

Take your portal's domain and add /buy/ followed by the Product ID.

Format:

https://your-portal-domain.com/buy/PRODUCT-ID-HERE

Example:

https://care.yourBrand.com/buy/687fd9dc70c3834e0ae2987f

That's the minimum required to create a working buy link. The patient clicks it, a checkout is created for that product, and they are taken straight to the payment page.


Step 3 β€” Add Options to the Link (Optional)

You can customize the patient experience by adding options to the end of the link. These are called query parametersΒ and are added after a ? symbol. If you include more than one, separate each with &.

Format with options:

https://your-portal-domain.com/buy/PRODUCT-ID?option1=value1&option2=value2

Available Options

coupon β€” Apply a Promo Code Automatically

Adds a coupon or promo code to the patient's checkout so the discount is already applied when they arrive. The patient does not need to type in a code themselves.

When to use

Promotional campaigns, targeted discounts, welcome offers

Format

?coupon=YOUR-CODE

Example:

https://portal.yourclinic.com/buy/687fc9dc70d3834e0ae2987f?coupon=WELCOME20

If the coupon code is expired or invalid, the checkout will still load β€” the patient will just see the regular price without any discount applied.


start β€” Choose the Sign-In vs. Sign-Up Screen

By default, patients who are not logged in will see a Sign Up screen when they reach checkout. If you are sending the link to an existing patient who already has an account, you can set this option to show the Log In screen instead.

When to use

Links sent to existing patients (re-engagement emails, refill reminders)

Format

?start=signin

Example:

https://portal.yourclinic.com/buy/687fc9dc70d3834e0ae2987f?start=signin

Omit this option for links going to new or prospective patients, so they see the Sign Up form first.


Prefilling Patient Information

When sending a buy link to a new patient, you can pre-populate fields on the sign-up form so they do not have to type their information in manually. This reduces friction and improves completion rates.

These parameters only apply to new patients on the Sign Up screen. They have no effect if the patient is already logged in or if ?start=signin is used.

Option

What it fills in

Format

email

Email address

?email=jane@example.com

firstName

First name

?firstName=Jane

lastName

Last name

?lastName=Smith

phone

Phone number

?phone=5551234567

dob

Date of birth

?dob=1990-05-20 (YYYY-MM-DD)

gender

Gender

?gender=female or ?gender=male

provinceCode

Province / State

?provinceCode=ON

Example β€” sending a pre-filled link to a new patient:

https://portal.yourclinic.com/buy/687fc9dc70d3834e0ae2987f?email=jane@example.com&firstName=Jane&lastName=Smith

You can include as many or as few of these fields as you have available. Any field you provide will be pre-filled; the patient can still edit it before submitting.


UTM Parameters β€” Tracking Campaign Performance

You can add UTM parameters to any buy link the same way you would for any marketing URL. These are passed through to the checkout page and are available in Google Tag Manager for attribution and reporting. They have no effect on the patient's checkout experience.

The app passes UTM parameters through to the checkout page but does not process them internally. Attribution, storage, and reporting of UTM data is handled by your Google Tag Manager (GTM)container configuration.

Parameter

Purpose

Example Value

utm_source

Where the traffic is coming from

email, sms, instagram

utm_medium

The marketing channel

newsletter, paid-social, referral

utm_campaign

The specific campaign name

summer-launch, refill-q3

utm_content

The specific creative or link variant

button-top, link-footer

utm_term

Keyword or segment (optional)

weight-loss

Example β€” email campaign link:

https://portal.yourclinic.com/buy/687fc9dc70d3834e0ae2987f?utm_source=email&utm_medium=newsletter&utm_campaign=summer-launch

Example β€” SMS campaign with a promo code:

https://portal.yourclinic.com/buy/687fc9dc70d3834e0ae2987f?coupon=SMS20&utm_source=sms&utm_medium=text&utm_campaign=refill-q3

Other Parameters β€” Capture via GTM

The buy link will pass through any query parameter you add to the URL, even if it is not listed in this document. The app does not block or strip unrecognised parameters.

If you need to track additional custom data (e.g. a referral ID, internal campaign code, or A/B test variant) and it is not a supported option above, add it to the link and configure a GTM variable to read it from the URL. This keeps the link flexible without requiring any changes to the portal.

Example:

https://portal.yourclinic.com/buy/687fc9dc70d3834e0ae2987f?referral_id=abc123&variant=b

Coordinate with your GTM administrator to set up the corresponding variable and trigger in your GTM container.


Combining Options

You can combine any of the options above in a single link. Separate each with &.

Returning patient with a discount:

https://portal.yourclinic.com/buy/687fc9dc70d3834e0ae2987f?coupon=REFILL10&start=signin

New patient with a welcome offer and pre-filled email:

https://portal.yourclinic.com/buy/687fc9dc70d3834e0ae2987f?coupon=WELCOME20&email=jane@example.com&firstName=Jane

Email campaign targeting new patients β€” full example:

https://portal.yourclinic.com/buy/687fc9dc70d3834e0ae2987f?coupon=WELCOME20&email=jane@example.com&firstName=Jane&utm_source=email&utm_medium=newsletter&utm_campaign=new-patient-july

What the Patient Experiences

  1. Patient clicks the buy link.

  2. A brief loading screen appears while the checkout is being prepared ("building your treatment package").

  3. The patient lands on the checkout page showing the product and pricing.

    • If they are not logged in, they see a Sign Up or Log In form (depending on the start option).

    • If they are already logged in, they go straight to the payment form.

  4. The patient completes payment and is taken to their Treatments dashboard to view their order.


What Happens If Something Goes Wrong

Situation

What the Patient Sees

The Product ID in the link is incorrect or the product no longer exists

An error page with the message "Product Not Found" and links to the Shop and Treatments pages

A technical error occurs while setting up the checkout

An error page with the message "Adding Product Failed" and links to the Shop and Treatments pages

The patient already has an active subscription for that product

An error page explaining that a subscription is already active

If patients report issues with a buy link, verify that the Product ID is correct and that the product is still active in the system.


Quick Reference

Goal

Link Format

Basic buy link

https://domain.com/buy/PRODUCT-ID

Pre-apply a promo code

https://domain.com/buy/PRODUCT-ID?coupon=CODE

Send to existing patient (login screen)

https://domain.com/buy/PRODUCT-ID?start=signin

Existing patient + promo code

https://domain.com/buy/PRODUCT-ID?coupon=CODE&start=signin

Pre-fill new patient's email

https://domain.com/buy/PRODUCT-ID?email=jane@example.com

Pre-fill multiple patient fields

https://domain.com/buy/PRODUCT-ID?email=jane@example.com&firstName=Jane&lastName=Smith

Track a campaign with UTM params

https://domain.com/buy/PRODUCT-ID?utm_source=email&utm_medium=newsletter&utm_campaign=NAME

Full-featured new patient campaign link

https://domain.com/buy/PRODUCT-ID?coupon=CODE&email=jane@example.com&firstName=Jane&utm_source=email
&utm_medium=newsletter&utm_campaign=NAME

Custom tracking (captured via GTM)

https://domain.com/buy/PRODUCT-ID?your_custom_param=value