Recharge
Last updated
Last updated
Recharge Legacy: For stores that use the Recharge's checkout on the store's customer facing side.
Recharge Shopify Hosted: Recharge's newest integration with Shopify, for stores that use the Shopify's checkout on the customer facing side.
From your Shopify Admin, click on your Recharge app. From the left hand side navigation, click on Settings and then Store.
On the right hand side, you will see which Recharge platform you use.
Shopify Checkout Integration: Use MESA's Recharge Shopify Hosted integration
Recharge Checkout on Shopify: Use MESA's Recharge Legacy integration
Here is where you will find what specific Recharge action will trigger your MESA workflow.
Address Updated
Your workflow will trigger when you update an address in the Recharge app. It will also trigger whenever a subscription has been activated or cancelled.
Address Created
Your workflow will trigger when a customer goes through the checkout with a particular address for the first time.
Charge Created
Your workflow will trigger when your customers checkout successfully.
Charge Failed
Your workflow will trigger every time Recharge tries to process a charge and it fails due to various reasons (insufficient funds, invalid CC info, expired CC, etc.) in the Recharge app.
Charge Paid
Your workflow will trigger when a charge is successfully processed, both manually in the Recharge app and by an automatic recurring charge. This will not trigger on the checkout itself.
Charge Upcoming
Your workflow will trigger X days before the upcoming charge is scheduled. The default is 3 days but your store specific setting can be verified on the Settings > Notifications > Notification Settings page in the description of the Upcoming charge customer notification.
Charge Updated
Your workflow will trigger when you update the charge's next charge date field.
Charge Uncaptured
Your workflow will trigger when a charge is uncaptured.
Charge Refunded
Your workflow will trigger when a charge is refunded.
Charge Max Retries Reached
Your workflow will trigger after Recharge attempts to process a charge 8 times, and it failed every time due to various CC issues in the Recharge app.
Charge Deleted
Your workflow will trigger when a charge is removed.
Checkout Processed
Your workflow will trigger when a checkout is successfully processed.
Customer Created
Your workflow will trigger when a customer goes through the checkout with a particular email address for a first time.
Customer Deactivated
Your workflow will trigger when the last subscription a customer had expires, so the customer no longer has active subscriptions (which means there are no queued charges/orders for the customer).
Customer Updated
Your workflow will trigger when you update a customer in the Recharge app.
Customer Payment Method Updated
Your workflow will trigger only when you update the customer's payment token in the Recharge app.
Customer Deleted
Your workflow will trigger when the customer is removed.
Customer Activated
Your workflow will trigger when you activate a customer. Activating means that you have added a subscription to a customer who didn’t have an active subscription previously.
Onetime Product Updated
Your workflow will trigger when you update a Recharge one time product.
Onetime Product Deleted
Your workflow will trigger when you delete a Recharge one time product.
Onetime Product Created
Your workflow will trigger when you create a Recharge one time product.
Order Created
Your workflow will trigger when an order is created (when a charge is successfully processed). In case of prepaid orders, there will be multiple automations, one automation for every queued order created at once.
Order Processed
Your workflow will trigger when an order is processed (when an order goes from status queued to status success). This will not trigger on checkout.
Order Updated
Your workflow will trigger when an order is updated.
Order Success
Your workflow will trigger when an order is successful.
Order Payment Captured
Your workflow will trigger when an order's payment is captured.
Order Deleted
Your workflow will trigger when an order is deleted.
Order Cancelled
Your workflow will trigger when an order is cancelled.
Order Upcoming
Your workflow will trigger when an order is upcoming.
Subscription Created
Your workflow will trigger when you create a subscription in the Recharge app or when a customer goes through the checkout.
Subscription Cancelled
Your workflow will trigger when a customer cancels a subscription.
Subscription Activated
Your workflow will trigger when you activate a subscription in the Recharge app or a customer activates a subscription.
Subscription Updated
Your workflow will trigger when you update a subscription in the Recharge app. This will also trigger when you update the next charge date in the Customer Portal, or when you use MESA's Recharge Change Subscription's Next Charge Date action.
Subscription Unskipped
Your workflow will trigger when a subscription is unskipped.
Subscription Swapped
Your workflow will trigger when a subscription is swapped.
Subscription Skipped
Your workflow will trigger when a subscription is skipped.
Subscription Deleted
Your workflow will trigger when you delete a subscription in the Recharge app.
Additional details about the Recharge API can be viewed here.
When you're setting up your first workflow with Recharge Shopify Hosted, you'll need to create a credential through MESA's Recharge App. Click on Add Account to complete the process.
Once redirected, scroll until you see a blue Install button and click on it. Then, you are all set! 🎉
If you see a "Not Found" message after you are redirected, it means that Recharge is not installed on the Shopify store that you currently have MESA installed on.
If you want to update a Shopify customer after a Recharge trigger occurs, you will need to add a Recharge Shopify Hosted Retrieve Customer step before your Shopify Retrieve Customer step. You will not be able to update the Shopify customer without knowing the Customer ID from the Recharge Shopify Hosted Retrieve Customer step.
In the Recharge Retrieve Customer step, you will want to locate the variable that contains the Recharge Customer ID.
In the Shopify Retrieve Customer step, you will want to locate the variable that contains the Shopify Customer ID. In most cases, you will find the variable under External Customer ID > Ecommerce
If you want to add a onetime product (non-recurring products on a queued order) to a subscription order, you can utilize the Recharge Shopify Hosted Create Onetime Product action.
In the Step Configuration within the action in MESA, the following are required Keys:
Address ID: You will need to use MESA's Variables feature to locate the Address ID
Ecommerce: The variant id of the Shopify product. You can locate your product's variant id by following this document. To find the Shopify Variant ID on a product without variants, you can add /variants.json at the end of the product URL. Locate the numbers set to id.
Price: Price of the product
Next Charge Scheduled At: You will need to use MESA's Variables feature to locate the Next Charge Scheduled At
Quantity: Set to your preferred quantity number
MESA offers two custom Recharge Shopify Hosted actions. They are mainly used in workflow templates that require counting a certain number of Recharge orders before doing the next action.
For example, two great use cases are the following.
Reward customers by adding a free product to their order if they have met the criteria for number of Recharge orders within a subscription.
Reward customers by adding a free product to their order for the number of Recharge orders overall.
The Filter by Order count of Subscription action can be found in one of our pre-made templates titled Add a free product to a customer's first Recharge order.
Here are the steps included in this workflow.
The Filter by Order count of Subscription action checks that the order's count in the duration of the customer's subscription is equal to or is included in the number(s) that you set for.
You can see that the following fields are filled in for this custom action.
Order ID: The Order Created > External Order ID > Ecommerce variable is used. This is the same as the Shopify Order ID.
Number Of Orders: Set to 1.
You can adjust the number (i.e. 2, 3, ...) in the Number Of Orders field depending on when you would like to reward your customers by adding a free product to their order.
The Retrieve Order's Count of Subscription action creates a variable for the order's count in the duration of the customer's subscription that you're referencing.
For example, when implemented, you can use the variable provided by this step (Count) to populate the amount of orders already processed in a customer's subscription for reporting purposes.
This action requires you to add an Order ID variable to complete the step and you can choose to add a Filter referencing the variable that it produces, or simply use the variable elsewhere in your workflow.
The Orders Count step can be found in one of our pre-made templates called Add a free product to a customer's fifth Recharge subscription order.
Here are the steps included in this workflow.
The Orders Count action receives a total number of orders placed by a customer's email address.
You can see that the Email field is filled in with the Order Created > Customer > Email variable which is the customer's email address.
You will need to use a Filter step right after this custom action. The Orders Count action will provide a Orders Count > Count variable which is the number of total orders placed by a customer's email address. Using a Filter action, you will be able to compare the number of total orders to whatever number you desire.
