Recharge is a subscription and payments management platform that enables you to provide customizable subscription products to your customers. It provides you reports to analyze your business, customers, and sales. Recharge platform is built to give its customers the same experience across your store. It allows you to manage your orders, inventory, and payments securely and easily.
Recharge uses an API token to identify Hevo and authorize the request for accessing account data.
Prerequisites
Creating the API Token
You require an API token to authenticate Hevo on your Recharge account. The API token does not expire and can be reused for all your Pipelines.
To create the API token:
-
Log in to your Recharge account.
-
In the left navigation pane, click Apps, and then click API Tokens.
-
On the API tokens page, click Create an API token.
-
On the Create an API token page, do the following:
-
Specify a Token nickname for the API token. For example, Recharge connector for Hevo.
-
Under the Scope column, select the Read access scope corresponding to the following resource types:
-
Accounts
-
Async Batches
-
Customers
-
Discounts
-
Orders
-
Payments
-
Payment Methods
-
Products
-
Store Information
-
Subscriptions
-
Select the I have read and agree with Recharge’s API Terms of Service check box.
-
Click Save.
-
On the API tokens page, copy the API token and save it securely like any other password. Use this token while configuring your Hevo Pipeline.
Configuring Recharge as a Source
Perform the following steps to configure Recharge as the Source in your Pipeline:
-
Click PIPELINES in the Navigation Bar.
-
Click + CREATE PIPELINE in the Pipelines List View.
-
On the Select Source Type page, select Recharge.
-
On the Configure your Recharge Source page, specify the following:
-
Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.
-
API Token: The API token that you created in your Recharge account.
-
Click TEST & CONTINUE.
-
Proceed to configuring the data ingestion and setting up the Destination.
Data Replication
For Teams Created |
Default Ingestion Frequency |
Minimum Ingestion Frequency |
Maximum Ingestion Frequency |
Custom Frequency Range (in Hrs) |
Before Release 2.21 |
1 Hr |
1 Hr |
24 Hrs |
1-24 |
After Release 2.21 |
6 Hrs |
30 Mins |
24 Hrs |
1-24 |
Note: The custom frequency must be set in hours as an integer value. For example, 1, 2, or 3 but not 1.5 or 1.75.
-
Historical Data: In the first run of the Pipeline, Hevo ingests all the existing data for the selected objects from your Recharge account and loads it to the Destination.
-
Incremental Data: Once the historical load is complete, all new and updated records for all objects except Collections, Collection Products, Products, and Store are ingested as per the ingestion frequency.
Schema and Primary Keys
Hevo uses the following schema to upload the records in the Destination database:
Data Model
The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:
Object |
Mode |
Description |
Addresses |
Incremental |
Contains the details of the address of a user. Each Addresses object can contain multiple addresses for a customer. |
Charges |
Incremental |
Contains the details of the purchase transaction, such as the ID, amount, currency, billing, shipping address, and discounts. |
Collections |
Full Load |
Contains the list of products sorted according to your requirements. |
Collection Products |
Full Load |
Contains the details of the products listed in a collection. |
Customers |
Incremental |
Contains the details of the customers in your Recharge account. |
Discounts |
Incremental |
Contains the details of the discounts applied to products on specific orders. |
Onetimes |
Incremental |
Contains the details of the products that are available for one-time purchase, rather than a subscription. |
Orders |
Incremental |
Contains the details of all the orders, including the price and discounts applied. |
Plans |
Incremental |
Contains the details of the buying options, such as subscription, prepaid, and one-time purchase, available for a product. |
Products |
Full Load |
Contains the details of all the products available for purchase in your store. |
Store |
Full Load |
Contains the details of your store. |
Subscriptions |
Incremental |
Contains the details of any recurring billing that you set up for your customers. |
Read the detailed Hevo documentation for the following related topics:
Source Considerations
-
Pagination: Each API response for each Recharge object fetches one page with up to 250 records per page.
-
Rate Limit: Recharge imposes a limit of 40 API calls per second per account. If the limit is exceeded, Hevo defers the ingestion till the limits reset.
-
Recharge supports the Eastern Time (ET), and not UTC, due to which Hevo displays the position of the incremental objects in ET.
Limitations
-
Hevo currently does not support deletes. Therefore, any data deleted in the Source may continue to exist in the Destination.
-
Hevo does not provide you with the option to select the historical sync duration for loading historical data. All the historical data in your Recharge account is loaded.
-
Hevo does not load an Event into the Destination table if its size exceeds 128 MB, which may lead to discrepancies between your Source and Destination data. To avoid such a scenario, ensure that each row in your Source objects contains less than 100 MB of data.
Revision History
Refer to the following table for the list of key updates made to this page:
Date |
Release |
Description of Change |
Jan-07-2025 |
NA |
Updated the Limitations section to add information on Event size. |
Mar-05-2024 |
2.21 |
Updated the ingestion frequency table in the Data Replication section. |
Sep-21-2022 |
1.98 |
New document. |