Help Center

Technical Documentation

Integrations

Recharge Extractor Documentation

Cobalt icon Recharge is one of the key subscription platforms available for eCommerce. The platform not only allows you to stay connected to your users, but also can help bolster your recurring revenue and reduce churn. Out of the box, you can allow your users to have better control over their deliveries, understand their reasons for churning and improve payment conversions with automatic retries and dunning.

KEY TOPICS

Click on the links below to take you to the section where you can learn more about this integration and where it is used and how it is created

Extraction Overview
ERD
Endpoints
Release Updates
Related Resources

EXTRACTION OVERVIEW

Daasity's Recharge extraction helps you understand your recharge data, pulling in key data points from charges, customers, orders, subscriptions and subscribers to help you take action on the best (and worst) performing areas.

Recharge version 2021-01 uses API keys to authenticate requests. Each request contains an API token in the following header:

X-Recharge-Access-Token:store_api_token

Where store_api_token is the merchant API key. All requests must be made over HTTPS.

Recharge has the following resources and accompanying endpoints available:

Resource	Endpoints
Addresses	GET /addresses GET /addresses/{id}
Charges	GET /charges GET /charges/{id}
Customers	GET /customers GET /customers/{id}
Orders	GET /orders GET /orders/{id}
Subscriptions	GET /subscriptions GET /subscriptions/{id}

This integration is available for:

Growth
Pro (V1 and V2)

ERD

Endpoints

Subscriptions

This table contains a complete list of subscriptions for each subscriber along with some data about the product that is being subscribed to. This comes from the Subscriptions resource, which has additional details available at

https://developer.rechargepayments.com/2021-01/subscriptions/subscriptions

We update data in the subscriptions table daily.

JSON Element	Database Column
ID	Recharge_Subscription_ID
Customer_ID	Recharge_Customer_ID
Next_Charge_Scheduled_At	Next_Charge_Scheduled_At
Cancelled_At	Cancelled_At
Product_Title	Product_Title
Variant_Title	Variant_Title
Price	Price
Quantity	Quantity
Status	Subscription_Status
Shopify_Product_ID	Shopify_Product_ID
Shopify_Variant_ID	Shopify_Variant_ID
SKU	SKU
Order_Interval_Unit	Order_Interval_Unit
Order_Interval_Frequency	Order_Interval_Frequency
Charge_Interval_Frequency	Charge_Interval_Frequency
Cancellation_Reason	Cancellation_Reason
Cancellation_Reason_Comments	Cancellation_Reason_Comments
Expire_After_Specific_Number_Of_Charges	Expire_After_Certain_Number_Of_Charges
Created_At	Created_At
Updated_At	Updated_At

Subscription_properties

This table contains some metadata on the Subscription itself. This also comes from the subscriptions resource.

JSON Element	Database Column
ID	Recharge_Subscription_ID
Name	Name
Value	Value

Customers

This table contains some information about the customers. Additional information for the Customer resource is available at

https://developer.rechargepayments.com/2021-01/customers

We refresh this data daily.

JSON Element	Database Column
ID	Recharge_Customer_ID
Hash	Hashed_Recharge_Customer_ID
Email	Email
External_Customer_ID:Shopify	Shopify_Customer_ID
Created_At	Created_At
Updated_At	Updated_At
First_Name	Billing_First_Name
Last_Name	Billing_Last_Name
Status	Status
Has_Valid_Payment_Method	Has_Valid_Payment_Method
Number_Subscriptions	Number_Subscriptions
Number_Active_Subscriptions	Number_Active_Subscriptions
First_Charge_Processed_At	First_Charge_Processed_At

Charges

This table contains some metadata on the charges for each subscription. More details on the Charges resources are available at

https://developer.rechargepayments.com/2021-01/charges.

This data is also refreshed daily.

JSON Element	Database Column
ID	Recharge_Charge_ID
Customer_ID	Recharge_Customer_ID
Shopify_Order_ID	Order_ID
Client_Details:Browser_IP	Browser_IP
Processed_At	Processed_At
Scheduled_At	Scheduled_At
Status	Status
Total_Discounts	Total_Discounts
Total_Line_Items_Price	Total_Line_Items_Price
Total_Price	Total_Price
Total_Refunds	Total_Refunds
Total_Tax	Total_Tax
Type	Type
Created_At	Created_At
Updated_At	Updated_At
Error	Error
Error_Type	Error_Type

Charge_line_items

This table contains some metadata on the charges, broken down by product. We get this information from the Charges resource, which includes information on the line items in each charge. This information also comes from the Charges resource and is refreshed daily.

JSON Element	Database Column
ID	Recharge_Charge_ID
Subscription_ID	Recharge_Subscription_ID
Shopify_Product_ID	Product_ID
Shopify_Variant_ID	Variant_ID
Price	Price
Quantity	Quantity

Charges_shipping_lines

This table contains some data on the shipping charges incurred. This data also comes from the Charges resource. Please note that only recharge_charge_ids that have associated shipping charges will be present in this table. This data is also refreshed daily.

JSON Element	Database Column
ID	Recharge_Charge_ID
Code	Code
Price	Price
Title	Title

Charge_discount_codes

This table contains some data on any discounts applied. This information comes from the Charges resource. Please note that only recharge_charge_ids that have had discounts applied will exist in this table. We also refresh this data daily.

JSON Element	Database Column
ID	Recharge_Charge_ID
Code	Code
Amount	Amount
Type	Type

Orders

This table is a mapping table between various entities, joining customer and order line (and ultimately charge data) together. It comes from the Orders resource. More information on that resource can be found at

https://developer.rechargepayments.com/2021-01/orders

We update this data daily.

JSON Element	Database Column
ID	Recharge_Order_ID
Charge:ID	Recharge_Charge_ID
Customer_ID	Recharge_Customer_ID
Shopify_Order_ID	Order_ID
Address_Is_Active	Address_Is_Active
Is_Prepaid	Is_Prepaid

Order_line_items

This table contains data down to the product level for each of the products that exist in the subscription. It also comes from the Orders resource.