Recharge

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

  • An active Recharge account from which data is to be ingested.

  • An API token is available to authenticate Hevo on your Recharge account.


Creating the API Token

You must create an API token to authenticate Hevo on your Recharge account. These API tokens do not expire and can be reused for all your Pipelines.

To create the API token:

  1. Log in to your Recharge account.

  2. In the left navigation pane, click Apps, and then click API Tokens.

    Recharge Nav bar

  3. In the API tokens page, click Create an API token.

    Create Token

  4. In the Create an API token page, do the following:

    Permissions

    1. Specify a Token nickname for the API token. For example, Recharge connector for Hevo.

    2. Under the Scope column, select the Read access scope corresponding to the following resource types:

      1. Accounts

      2. Async Batches

      3. Customers

      4. Discounts

      5. Orders

      6. Payment Methods

      7. Products

      8. Subscriptions

    3. Select the I have read and agree with Recharge’s API Terms of Service check box.

    4. Click Save.

You have successfully created your API token. Use this token for creating Hevo Pipelines.


Configuring Recharge as a Source

Perform the following steps to configure Recharge as the Source in your Pipeline:

  1. Click PIPELINES in the Asset Palette.

  2. Click + CREATE in the Pipelines List View.

  3. In the Select Source Type page, select Recharge.

  4. In the Configure your Recharge Source page, specify the following:

    Recharge Source Config

    • Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.

    • API Token: The API token that you created in your Recharge account.

  5. Click TEST & CONTINUE.

  6. Proceed to configuring the data ingestion and setting up the Destination.


Data Replication

Default Pipeline Frequency Minimum Pipeline Frequency Maximum Pipeline Frequency Custom Frequency Range (Hrs)
1 Hr 1 Hr 24 Hrs 1-24

Note: You must set the custom frequency in hours as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.

  • Historical Data: In the first run of the Pipeline, Hevo ingests all historical data for the Collections, Collections Products, Products, and Store objects and loads it to the Destination.

  • Incremental Data: Once the historical load is complete, all new and updated records for all objects except Collections, Collections Products, Products, and Store are synchronized with your Destination according to the ingestion frequency.


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 a maximum of 40 API calls per second per account to optimize performance.

  • Recharge supports the Eastern Time (ET), and not UTC, due to which Hevo displays the position of the incremental objects in ET.


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.
Collections 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.

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.


Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Sep-21-2022 1.98 New document.
Last updated on 21 Sep 2022

Tell us what went wrong