Creating Recharge Quick Action URLs manually

Recharge Quick Actions let you add subscription actions to your customer emails, such as skipping an order, reactivating a subscription, or adding a one-time product.

Recharge supports Quick Actions created with the Quick Actions URL Builder and used with Klaviyo.

This guide explains how Quick Actions URLs are structured, which variables each action requires, and what to consider when building URLs manually for testing or custom use.

Before you start

• Recharge supports Quick Actions when you create them with the Quick Actions URL Builder and use them with Klaviyo.
• Manually created Quick Actions URLs are not supported.
• If you use another email provider, you’ll need a custom middleware solution. This setup is not supported by Recharge.

Quick Actions URL structure

Each Quick Actions URL starts with your .myshopify.com domain followed by the Quick Actions path:

https://mystore.myshopify.com/tools/recurring/quick_actions/

The rest of the URL identifies the customer, the action to perform, and the subscription or product involved.

• Customer hash: Identifies the customer
• Action: Defines the Quick Action to perform
• Subscription ID: Identifies the subscription the action applies to

The following URL highlights an example of a Quick Action URL used to add a one-time product to a subscription:

https://mystore.myshopify.com/tools/recurring/quick_actions/5244250087ca77ba5cd96c57/process?action=add_onetime&subscription_id=111076384&shopify_variant_id=32475718385739

Action names and required variables

The variables required to perform an action may change depending on the action type. Refer to this chart to confirm which variables are needed for the action you wish to accomplish: 

Manually create a Quick Actions URL for Klaviyo

Recharge recommends using the Quick Actions URL Builder to generate URLs for your Klaviyo notifications. While you can manually create Quick Action URLs in Klaviyo, they are not supported by Recharge.

Step 1 - Create your Quick Actions URL

Construct your Quick Actions URL. Build your Quick Actions URL manually first to test it for accuracy.

Once you've confirmed the manual Quick Actions URL works as expected, replace the Quick Action variables with the correct Klaviyo variables.

For example, the manual Quick Actions URL to allow a customer to view their customer portal uses your store URL and one specific customer hash:

//.myshopify.com/tools/recurring/quick_actions/123456/process?action=view_portal_page&page=subscriptions

After testing the URL, replace static values such as the customer hash or subscription ID with the corresponding Klaviyo variables:

<a href="{{ organization.url }}tools/recurring/quick_actions/{{ person.recharge_customer
  }}/process?action=view_portal_page&page=subscriptions">View your subscription</a>

Tip: See Recharge Quick Actions for examples of each Quick Action URL, or our article on Recharge Quick Actions and Klaviyo use cases.

Campaigns

When creating campaigns, you typically must include {% for sub in person.rc_all_subscriptions %} {% if sub.status == 'CANCELLED' %} or {% for sub in person.rc_all_subscriptions %} {% if sub.status == 'ACTIVE' %} at the beginning of each Quick Actions URL to loop and find the subscriptions associated with this customer.

The status you use depends on the type of campaign you’re running. CANCELLED status would be if you’re targeting cancelled subscriptions, and ACTIVE subscriptions would be if you're targeting active subscriptions.

Typically, Quick Actions URLs for campaigns target all the customer's subscriptions. You can use HTML and IF statements to further customize who the campaign sends to when the customer has multiple subscriptions.

Subdomains and redirects

You must hardcode your URL in Klaviyo instead of using {{ organization.url }} if you are using a subdomain instead of a domain in your notifications or a redirected URL. Using the {{ organization.url }} variable with a subdomain or a redirect causes a 404 error even when everything is configured correctly. 

<a href=".shop.myshopify.com/tools/recurring/quick_actions/
{{ person.recharge_customer }}
/process?action=view_portal_page&page=subscriptions">
View your subscription
</a>

Step 2 - Add your Quick Actions URL to a Klaviyo Flow or Campaign

Add a Quick Action URL to a Klaviyo Flow

1. Create a Flow in Klaviyo.
2. Select Metric as your Trigger setup.
3. Use the appropriate Metric to trigger the notification. The metric must end in "on ReCharge" to work successfully.
4. Build your Flow. Use the Email action to create an email to send the Quick Actions URL created in Step 2. You can add the URL to the Source code in a Text Block. Alternatively, you may want to display the Quick Actions URL as a button or an image.

Add a Quick Action URL to a Klaviyo campaign

Follow Klaviyo’s instructions on sending out an email campaign. You may want to use Recharge custom properties in Klaviyo to create segments or lists for specific customers.

Required and optional variables

Recharge Quick Action URLs are unique to your customers based on their subscription data. These URLs are dynamic, automatically generated links. Variables let you create content that appears relevant to the reader.

You can add additional variables to display additional information when constructing your Klaviyo email. Note that different Metrics contain different variables.

For more information about variables in Klaviyo, visit Template Tags and Variable Syntax.

Subscription cancelled on ReCharge

Subscription started on ReCharge

Order Upcoming on Recharge

Campaigns

Quick Action URLs in campaigns typically must begin with {% for sub in person.rc_all_subscriptions %} {% if sub.status == 'CANCELLED' %} or {% for sub in person.rc_all_subscriptions %} {% if sub.status == 'ACTIVE' %} . This loops through and finds the specific customer subscriptions with the targeted status.

• {% for sub in person.rc_all_subscriptions %} {% if sub.status == 'ACTIVE' %} is used to target all customers who have an active subscription.
• {% for sub in person.rc_all_subscriptions %} {% if sub.status == 'CANCELLED' %} is used to target all customers who have ever cancelled a subscription.

Quick Action URLs do not apply to prepaid products. You can use the loop {% if sub.status == 'CANCELLED' and sub.is_prepaid == False % } or {% if sub.status == 'ACTIVE' and sub.is_prepaid == False %} to prevent customers with prepaid subscriptions from receiving your campaigns.