Available exports in the Export Builder – Recharge

Sections

Addresses
Bundles
Charges
Credit - Adjustments
Customers
Discounts
Emails
Events
One-time
Orders
Payment Methods - All
Products
Plans
Subscriptions

This guide acts as a repository of available exports in the Export Builder. As new exports are added, they will be included in this list. The fields available for exports may vary depending on the Recharge platform your store is hosted on.

Addresses

In the merchant portal, click Tools & apps and select Exports from the dropdown.
Click Create Exports.
Under Select export type, click the dropdown and select Addresses - Similar By Creation Date.
Enter in a custom export name (optional) and your e-mail address.
Click Create export.

Addresses - Similar By Creation Date

This export contains a list of similar addresses.

Header	Definition
customer_id	A unique string of numbers that identifies a specific customer and is tied specifically to their email address. Even if a customer has multiple subscriptions listed under one email address, they will still only have one Customer ID.
customer_first_name	The customer’s first name listed on the subscription.
customer_last_name	The customer's last name listed on the subscription.
address_id	A unique string of numbers used to identify the customer’s subscription. This is also referred to as the Purchase ID. Individual products within a subscription will also be assigned a unique purchase_items_id.
address_created_at	The date the address was created on.
address_1	The customer’s street address. This address may be different than the billing address if the person receiving the subscription and the cardholder live at different addresses.
address_2	Any additional address information such as apartment number or specific mailbox. This field is not mandatory.
city	The city where the subscriber is located.
zip	The zip code where the subscriber is located.
state	The state where the subscriber is located.
country	The country where the subscriber is located.
subscription_count	The number of subscriptions associated with the address.
next_charge_date	The next change date of the subscription(s) associated with the address.
subscription_link	A link to the subscription order details.

Bundles

Bundles exports are available for merchants looking to migrate their bundles.

In the merchant portal, click Tools & apps and select Exports from the dropdown.
Click Create Exports.
Under Select export type, click the dropdown and select Bundles - Active.
Enter a custom export name (optional) and your e-mail address. You can also select a date range of up to 30 days.
Click Create export.

Bundles - Active

This export contains all bundle selections for active bundle subscriptions. Each unique product is listed on a separate row. If your bundle product has five unique items in it, that bundle has five rows listed in the export.

Bundles selection - Filtered by contents

Use the Add products to filter by option to search and select specific products to filter by.

Recharge returns all the bundle selections for that subscription. For example, if you access a list of customers subscribed to a shampoo product, and a customer is subscribed to both shampoo and conditioner, the report displays both shampoo and conditioner with the associated subscription.

The Bundles selection exports provide an in-depth look at specific products in customers' bundles.

Header	Definition
Bundle Selection ID	Unique numeric identifier for the bundle selection. This ID remains the same for each selection within a subscription.
Subscription ID	Unique numeric identifier for the subscription.
Selection Item Product ID	The Product ID of the bundle selection.
Selection Item Variant ID	The Variant ID of the bundle selection.
Selection SKU	The product SKU of the bundle selection.
Selection Quantity	The number of the selected product in the bundle.
Subscriber ID	The Recharge customer ID.
Subscriber Email	The customer's email.

Charges

In the merchant portal, click Tools & apps and select Exports from the dropdown.
Click Create Exports.
Under Select export type, click the dropdown and select any of the Charges exports, as outlined below.
Enter in a custom export name (optional) and your e-mail address. On some reports, you can choose to select a date range of up to 90 days.
Click Create export.

Note: The date range for Charges exports are set to a maximum of 90 days for future charges and one year for processed charges.

Charges - Error

This export contains all charges with errors, between the supplied start and end date. Note that addresses and customers are referenced only by their ids, so you may need the Customers and Addresses exports for additional data.

Charges - Processed

This export contains all processed charges between the supplied start and end date. Note that addresses and customers are referenced only by their ids, so you may need the Customers and Addresses exports for additional data

Charges - Queued

This export contains all queued charges between the supplied start and end date. Note that addresses and customers are referenced only by their ids, so you may need the Customers and Addresses exports for additional data.

Charges - Skipped

This export contains all skipped charges between the supplied start and end date. Note that addresses and customers are referenced only by their ids, so you may need the Customers and Addresses exports for additional data.

Charges - Pending

Addresses and customers are referenced only by their ids, so you may need the Customers and Addresses exports for additional data.

This export contains all of the pending charges between the supplied start and end date.

Header	Definition
charge_id	A unique string of numbers given to each charge. The charge ID is used to reference a specific charge.
multiple_rows	This field indicates whether there are multiple products contained within the charge. Each product will be present within the export as a separate row, identified with the same Order ID. If this value is false, there is a single line item within the charge. If the value is true, multiple line item rows are available for this charge. The rows will share the same id as well as all fields except fields starting with line_item_. This is to provide line item level information for each charge.
address_id	A unique string of numbers used to identify the customer’s subscription. This is also referred to as the Purchase ID. Individual products within a subscription will also be assigned a unique purchase_items_id.
customer_id	A unique string of numbers that identifies a specific customer and is tied specifically to their email address. Even if a customer has multiple subscriptions listed under one email address, they will still only have one Customer ID.
external_order_id	A unique string of numbers that corresponds to the order created in your eCommerce platform for fulfillment. Generally, this information is only used by your eCommerce platform’s API to create the order.
processor_name	List the payment processor associated with the charge (e.g. Braintree) Charges that are associated with a Shopify Payment Gateway will have shopify_payments under the processor_name column regardless of what processor was used.
transaction_id	A unique string of numbers assigned by the payment gateway that is used to identify a transaction.
shipments_count	The number of shipments that were sent for that specific order.
type	The type of charge it is, such as recurring.
status	The status of the charge. Depending on which export you pull, the status will be different. For example, processed or queued.
pending_status_reason	The reason for the status.
scheduled_at	The date the charge is scheduled to process.
processed_at	The date the charge was processed.
subtotal_price	The price of the charge before taxes, shipping, or discounts.
total_taxes	Total combined tax amount on the charge.
total_shipping	The total cost for shipping on a specific charge.
total_discounts	The total discount amount.
total_price	The total price of the charge, including taxes, discounts and shipping.
total_refunds	The total refunds provided on the charge.
note_attributes	Extra information that is added to the order. Each array entry will contain “name” and “value” keys.
note	The note that is passed in the “note” field of orders when submitted to your eCommerce platform.
created_at	The date the charge was created.
updated_at	If a change is made to the charge, then this column will reflect the most recent change date.
discount_id	When a discount code is applied to a charge, a unique string of numbers is attributed to the code being used. The ID identifies a specific discount code used on a single charge.
discount_code	A specific string of text, numbers, or a combination of both, that customers can use to receive their subscription at a reduced cost.
shipping_lines	The original shipping rate that was paid when the customer checked out. If the shipping settings are configured to retain the original rate for shipping on each order, our system references this data when each charge is created to ensure the original shipping lines are displayed. However, we do not reference this data if the shipping rates are dynamically recalculated on each charge.
error	The error code listed on the charge in Recharge.
last_charge_attempt_date	The last time that we tried to process the unsuccessful charge.
error_type	The error type listed on the charge in Recharge.
number_times_tried	The total number of times we have attempted to process the charge.
retry_date	The date when the next attempt will be placed.
email	The email address associated with the subscription.
billing_first_name	The cardholder’s first name.
billing_last_name	The cardholder’s last name.
billing_company	The cardholder’s company name. This field is not mandatory.
billing_address1	The street address of the cardholder. This address can be different than the shipping address if the customer has purchased the product for someone else.
billing_address2	Any additional address information such as apartment number or specific mailbox. This field is not mandatory.
billing_city	The city the cardholder lives in.
billing_province	The cardholder’s state or province.
billing_zip	The cardholder’s zip or postal code.
billing_country	The country the cardholder lives in.
billing_phone	The cardholder’s phone number.
shipping_first_name	The first name of the person receiving the subscription product, aka the subscriber.
shipping_last_name	The subscriber’s last name.
shipping_address1	The subscriber’s street address. This address may be different than the billing address if the person receiving the subscription and the cardholder live at different addresses.
shipping_address2	Any additional address information such as apartment number or specific mailbox. This field is not mandatory.
shipping_company	The subscriber’s company.
shipping_city	The city where the subscriber is located.
shipping_province	The subscriber’s state or province.
shipping_zip	The subscriber’s zip or postal code.
shipping_country	The country where the subscriber is located.
shipping_phone	The phone number of the person receiving the subscription. This is helpful if there are any problems with shipping or delivery.
line_item_title	The title of the product within the charge.
line_item_variant_title	The variant title of the product within the charge.
line_item_quantity	The amount of the specific product within a charge.
line_item_external_product_id	The external product ID within the charge.
line_item_external_variant_id	The external variant ID within the charge.
line_item_properties	This column displays any line item properties associated with the product within the charge.
line_item_sku	The SKU of the product within the charge.
line_item_price	The price of the product within the charge.
line_item_purchase_item_type	The type of item within the charge.
line_item_subscription_id	The subscription ID within the charge.
store_currency	The store’s main currency
total_duties	Duties displayed in presentment currency.
store_total_duties	Total duties displayed in store currency.
store_subtotal_price	Subtotal is displayed in store currency.
store_total_taxes	Taxes are displayed in store currency.
store_total_discounts	Discounts displayed in store currency.
store_total_price	Price displayed in store currency.
store_line_item_price	Line items displayed in store currency.
store_total_shipping	Shipping displayed in store currency.
store_total_refunds	Refunds displayed in store currency.
currency_conversion_rate_presentment_to_store	Currency conversion rate from presentment currency to store currency.
currency_conversion_rate_presentment_to_usd	Currency conversion rate from presentment currency to USD.
usd_total_price	Total pricing converted into USD.
presentment_currency	The currency the customer checked out with.
merged_at	List of charges that have been merged and the associated customers.

Credit - Adjustments

The Credits - Adjustments export provides an overview of all credit adjustments made to customers' credits. Use this export to track credit adjustments, manage customer balances, and ensure accounting accuracy and customer service operations.

This export contains an overview of all credit adjustments made.

Header	Definition
credit_adjustment_id	A unique string of numbers that identifies a specific credit adjustment.
customer_id	A unique string of numbers that identifies a specific customer and is tied specifically to their email address. Even if a customer has multiple subscriptions listed under one email address, they will still only have one Customer ID.
amount	The monetary value of the credit adjustment based on the adj_type.
currency_code	The currency in which the adjustment amount is denominated, such as USD, EUR, etc. This is the store's deafult currency.
ending_balance	The balance of the credit account after the specific adjustment was created.
adj_type	The type of credit adjustment being made. Possible values are 'credit' indicating an increase or 'debit' indicating a decrease in the credit.
note	An optional internal note for source, categorizing or recording the reason.
created_at	The date the credit adjustment was created.
reference_type	An indicator of the origin or nature of the credit adjustment, linking it to other records in the system, such as flow nodes, charges, etc.
reference_id	A unique string of numbers that identifies another record based on the reference_type.

Customers

In the merchant portal, click Tools & apps and select Exports from the dropdown.
Click Create Exports.
Under Select export type, click the dropdown and select any of the Customers exports, as outlined below.
Enter in a custom export name (optional) and your e-mail address. On some reports, you can choose to select a date range of up to 90 days.
Click Create export.

Customers - Active

This export contains all your active customers.

Header	Definition
customer_id	A unique string of numbers that identifies a specific customer and is tied specifically to their email address. Even if a customer has multiple subscriptions listed under one email address, they will still only have one Customer ID.
first_name	The customer’s first name listed on the subscription.
last_name	The customer’s last name.
email	The email address associated with the subscription.
external_customer_id	A unique string of numbers assigned by your platform to identify each customer.
hash	The unique customer portal URL for the customer
accepts_marketing	Indicates whether the customer accepts email marketing. A 1 present in the column indicates that the customer accepts marketing.
orders_count	The total number of orders that the customer has received for their subscription
number_active_subscriptions	This is the number of subscriptions that the customer is currently paying for.
number_subscriptions	This is the total number of subscriptions that have existed for this customer.
first_charge_processed_at	The date that first charge was processed for the specific customer.
card_error_in_dunning	Indicates if the customer is having issues with their payment processing successfully.
created_at	The date the customer account was first created.

Customers - Shipping Addresses

An address only references the Customer ID and not the full customer record. For the full customer record, reference the Customers export.

This export contains shipping addresses for all customers.

Header	Definition
address_id	A unique string of numbers used to identify the customer’s subscription. This is also referred to as the Purchase ID. Individual products within a subscription will also be assigned a unique purchase_items_id.
customer_id	A unique string of numbers that identifies a specific customer and is tied specifically to their email address. Even if a customer has multiple subscriptions listed under one email address, they will still only have one Customer ID.
discount_id	When a discount code is applied to a charge, a unique string of numbers is attributed to the code being used. The ID identifies a specific discount code used on a single charge.
shipping_first_name	The customer’s first name listed on the subscription.
shipping_last_name	The customer’s last name.
company	The customer’s company.
address_1	The customer’s street address. This address may be different than the billing address if the person receiving the subscription and the cardholder live at different addresses.
address_2	Any additional address information such as apartment number or specific mailbox. This field is not mandatory.
city	The city where the subscriber is located.
province	The customer's state or province.
zip	The customer’s zip or postal code.
country	The country where the subscriber is located.
phone	The phone number of the person receiving the subscription. This is helpful if there are any problems with shipping or delivery.
cart_note	The note that that will be passed to the “note” field of orders made within the address.
note_attributes	Extra information that is added to the order. Each array entry will contain “name” and “value” keys.
shipping_lines_override	If a manual shipping override is present, the Name, Code, and Price of the shipping rate will be listed here.
created_at	The date the customer account was first created.
shipping_manually_set	'1' indicates a shipping rate override is in effect
presentment_currency	Currency that the customer checked out with.
store_currency	The store’s main currency.
delivery_method	A JSON field that has the delivery method and the `external_location_id`. The location ID will only contain a value if the delivery method is local delivery or pickup.
is_gift	If the value is True, this means the customer is a gift recipient and the existing address is where they redeemed their gift.

Customers - Payment tokens

This export contains payment tokens for all customers.

Header	Definition
customer_id	A unique string of numbers that identifies a specific customer and is tied specifically to their email address. Even if a customer has multiple subscriptions listed under one email address, they will still only have one Customer ID.
first_name	The customer’s first name listed on the account.
last_name	The customer’s first name listed on the account.
email	The email address associated with the account.
external_customer_id	A unique string of numbers assigned by your platform to identify each customer.
hash	The unique customer portal URL for the customer
accepts_marketing	Indicates whether the customer accepts email marketing. A 1 present in the column indicates that the customer accepts marketing.
orders_count	The total number of orders that the customer has received for their subscription
number_active_subscriptions	This is the number of subscriptions that the customer is currently paying for.
number_subscriptions	This is the total number of subscriptions that have existed for this customer.
first_charge_processed_at	The date that first charge was processed for the specific customer.
card_error_in_dunning	Indicates if the customer is having issues with their payment processing successfully.
stripe_customer_token	The customer's Stripe payment token.
encrypted_customer_token	An ciphered representation of the customer token.
paypal_customer_token	The customer's PayPal payment token.
authorizedotnet_customer_token	The customer's Authorize.net payment token.
created_at	The date the customer account was first created.

Discounts

In the merchant portal, click Tools & apps and select Exports from the dropdown.
Click Create Exports.
Under Select export type, click the dropdown and select Discounts.
Enter in a custom export name (optional) and your e-mail address.
Click Create export.

This export contains all discounts and how many times they’ve been applied.

Header	Definition
discount_id	When a discount code is applied to a charge, a unique string of numbers is attributed to the code being used. The ID identifies a specific discount code used on a single charge.
code	The discount code created in the merchant portal.
discount_type	Indicates what type of discount the customer will be receiving, such as a fixed amount, percentage, or shipping discount.
value	The total amount/percentage that the customer saves by using the discount.
starts_at	The date that discount is able to be applied.
ends_at	The date that the discount is no longer able to be applied.
status	Indicates whether the discount is enabled or disabled.
times_used	The total times that the discount code has been used by all customers.
usage_limit	How many times in total that the discount code can be used by all customers.
applies_to_resource	Identifies whether a discount code is set for a specific product or collection.
applied_to_id	The product or collections id the discount can be applied to.
applies_to_product_type	Indicates if a discount is applied to all products, subscription products, or one-time products.
once_per_customer	Indicates if the discount applies once per customer.
duration	Indicates if the discount is a single-use code or if it can be applied multiple times.
duration_usage_limit	Indicates the number of times a discount code can be applied in total
prerequisite_subtotal_min	Indicates the minimum order amount required for a discount code to be applied.
first_time_customer_restriction	Indicates if the discount is only available to first-time customers.
created_at	The date the discount was created.
channel_settings_json	The channels the discount can be applied. If a channel is enabled, it will display as true.

Emails

Only one month of data is available for this export.

In the merchant portal, click Tools & apps and select Exports from the dropdown.
Click Create Exports.
Under Select export type, click the dropdown and select Emails.
Enter in a custom export name (optional), date range, and your e-mail address.
Click Create export.

This export contains all emails sent from the store that are enabled in your Notifications section.

Header	Definition
email_id	A unique string of numbers that identifies a notification ID associated with a specific customer or order email.
type	The category of notification. For example, charge confirmation or card decline.
from_email	The email of the sender.
from_name	The name of the sender.
to_email	The email of the receiver.
send_at	The date the email is scheduled to send.
sent_at	The date the email was sent.
purchase_id	The purchase ID.
bcc_emails	A list of emails that were BCCed.
cc_emails	A list of emails that were CCed.
created_at	The date the email was first created.

Events

The date range for the Events exports are set to a maximum of 90 days.

In the merchant portal, click Tools & apps and select Exports from the dropdown.
Click Create Exports.
Under Select export type, click the dropdown and select Events.
Enter in a custom export name (optional), date range, and your e-mail address.
Click Create export.

Customers are referenced only by their ids, you may need the Customers exports for additional data.

This export contains all events (actions performed on orders, addresses, etc.) between the supplied start and end date.

Header	Definition
event_id	A unique string of numbers associated with a specific event performed on a customer account.
customer_id	A unique string of numbers that identifies a specific customer and is tied specifically to their email address. Even if a customer has multiple subscriptions listed under one email address, they will still only have one Customer ID.
object_id	The specific identifier of the object or location. For example, if an event occurred on a charge, the charge ID is recorded.
object_class	The object, or location, of the recorded event. For example, checkout, address, or order.
verb	The action performed on the object or location. For example, if a charge does not process due to a card error, it will display failed.
source	Indicates the source of the action. For example, customer or store admin.
description	A description of the event or action that took place.
changes	If a change or action was made.
created_at	The date the event occurred.

One-time

Addresses and customers are referenced only by their Address and Customer IDs. You may need the Customers and Addresses exports for additional data.

In the merchant portal, click Tools & apps and select Exports from the dropdown.
Click Create Exports.
Under Select export type, click the dropdown and select Onetimes - All.
Enter in a custom export name (optional) and your e-mail address.
Click Create export.

This export contains all non-subscription products processed by Recharge.

Header	Definition
onetime_id	A unique string of numbers that is given to each product in a customer’s subscription.
customer_id	A unique string of numbers that identifies a specific customer and is tied specifically to their email address. Even if a customer has multiple subscriptions listed under one email address, they will still only have one Customer ID.
customer_email	The email address associated with the account.
address_id	A unique string of numbers used to identify the customer’s subscription. This is also referred to as the Purchase ID. Individual products within a subscription will also be assigned a unique purchase_items_id.
status	The type of product. For example, one-time.
product_title	The title of the subscription product.
variant_title	The title of the specific variant that the subscriber is subscribed to.
price	The price the customer paid for their subscription product when they checked out. The price paid at checkout might differ from the recurring price if a discount code was used, or if a free trial workflow is implemented.
quantity	The number of products ordered.
external_product_id	A unique string of numbers that is used to identify the product that is listed on the subscription.
external_variant_id	A unique string of numbers that is used to identify the specific variant on the subscription. Even if a product does not have any variants created in your eCommerce platform, it will still have one variant ID assigned. Recharge uses the variant ID to create each charge.
properties	Line item properties are custom forms on a product used to collect additional customization information.
created_at	The date the product was added.
deleted_at	This column displays the date and time in the event that a product is completely deleted from a customer’s account.
updated_at	If a change or action was made to the product, the change date will be reflected in this column.
presentment_currency	Currency that the customer checked out with.
store_currency	The store’s main currency.

Orders

In the merchant portal, click Tools & apps and select Exports from the dropdown.
Click Create Exports.
Under Select export type, click the dropdown and select any of the Orders exports, as outlined below.
Enter in a custom export name (optional) and your e-mail address. On some reports, you can choose to select a date range of up to 90 days.
Click Create export.

Note: The date range for Orders exports are set to a maximum of 90 days for future orders and one year for processed orders.

Orders - Cancelled

This export contains all cancelled orders between the supplied start and end date. Note that addresses and customers are referenced only by their Address and Customer IDs, so you may need the Customers and Addresses exports for additional data.

Orders - Errors

This export contains all orders with errors, between the supplied start and end date. Note that addresses and customers are referenced only by their Address and Customer IDs, so you may need the Customers and Addresses exports for additional data.

Orders - Prepaid Processed

This export contains all processed prepaid shipment orders between the supplied start and end date. Note that addresses and customers are referenced only by their Address and Customer IDs, so you may need the Customers and Addresses exports for additional data.

Orders - Prepaid Queued

This export contains all upcoming prepaid shipment orders between the supplied start and end date. Note that addresses and customers are referenced only by their Address and Customer IDs, so you may need the Customers and Addresses exports for additional data.

Orders - Processed

This export contains all processed orders between the supplied start and end date. Note that addresses and customers are referenced only by their Address and Customer IDs, so you may need the Customers and Addresses exports for additional data.

Orders - Pending

Addresses and customers are referenced only by their Address and Customer IDs, so you may need the Customers and Addresses exports for additional data.

This export contains all pending orders between the supplied start and end date.

Header	Definition
order_id	A unique string of numbers given to each order. The order ID is used to reference a specific order.
charge_id	A unique string of numbers given to each charge. The charge ID is used to reference a specific charge.
multiple_rows	If this value is false, there is a single line item within the charge. If the value is true, multiple line item rows are available for this charge. The rows will share the same id as well as all fields except fields staring with line_item_. This is to provide line item level information for each charge.
address_id	A unique string of numbers used to identify the customer’s subscription. This is also referred to as the Purchase ID. Individual products within a subscription will also be assigned a unique purchase_items_id.
customer_id	A unique string of numbers that identifies a specific customer and is tied specifically to their email address. Even if a customer has multiple subscriptions listed under one email address, they will still only have one Customer ID.
external_order_id	A unique string of numbers that corresponds to the order created in your eCommerce platform for fulfillment. Generally, this information is only used by your eCommerce platform’s API to create the order.
external_order_number	The corresponding order created in your eCommerce platform once the order in Recharge was processed.
is_prepaid	If the product is a prepaid product (ships more frequently than it is charged), the column will indicate a 1.
type	The source of the order submitted. For example, checkout or recurring.
status	Lists the status of the order.
scheduled_at	Indicates the date the order is scheduled to be submitted to your eCommerce platform.
processed_at	Indicates the date the order was submitted to your eCommerce platform.
cancelled_at	The date the order was canceled.
cancel_reason	The reason the order was canceled.
subtotal_price	The price of the order, before taxes, shipping, or discounts.
total_taxes	Total combined tax amount on the order.
total_discounts	The total discount amount attached to the order.
total_price	The total price, including taxes, shipping, or discounts.
note_attributes	Extra information that is added to the order. Each array entry must contain a dictionary with “name” and “value” keys.
note	The note that that is passed to the “note” field of orders made within the address.
created_at	The date the order was created.
updated_at	If a change was made to the subscription or order, it will be reflected in this column.
discount_code	A specific string of text, numbers, or a combination of both, that customers can use to receive their subscription at a reduced cost.
shipping_lines	The original shipping rate that was paid when the customer checked out. If the shipping settings are configured to retain the original rate for shipping on each order, our system references this data when each charge is created to ensure the original shipping lines are displayed. However, we do not reference this data if the shipping rates are dynamically recalculated on each charge.
error	If an order has an error, the error reason will be listed here.
email	The email address associated with the subscription.
billing_first_name	The cardholder’s first name.
billing_last_name	The cardholder’s last name.
billing_company	The cardholder’s company name. This field is not mandatory.
billing_address1	The street address of the cardholder. This address can be different than the shipping address if the customer has purchased the product for someone else.
billing_address2	Any additional address information such as apartment number or specific mailbox. This field is not mandatory.
billing_city	The city the cardholder lives in.
billing_province	The cardholder’s state or province.
billing_zip	The cardholder’s zip or postal code.
billing_country	The country the cardholder lives in.
billing_phone	The cardholder’s phone number.
shipping_first_name	The first name of the person receiving the subscription product.
shipping_last_name	The subscriber’s last name.
shipping_address1	The subscriber’s street address. This address may be different than the billing address if the person receiving the subscription and the cardholder live at different addresses.
shipping_address2	Any additional address information such as apartment number or specific mailbox. This field is not mandatory.
shipping_company	The subscriber’s company.
shipping_city	The city where the subscriber is located.
shipping_province	The subscriber’s state or province.
shipping_zip	The subscriber’s zip or postal code.
shipping_country	The country where the subscriber is located.
shipping_phone	The phone number of the person receiving the subscription. This is helpful if there are any problems with shipping or delivery.
line_item_title	The title of the individual product within the order.
line_item_variant_title	The variant title of the individual variant product within the order.
line_item_quantity	The amount of the individual product within the order.
line_item_external_product_id	The eCommerce platform product ID for the individual product within the order.
line_item_external_variant_id	The eCommerce platform variant ID for the individual product within the order.
line_item_properties	This column displays any line item properties associated with the individual product within the order.
line_item_sku	The individual product SKU within the order.
line_item_price	The individual product price within the order.
line_item_purchase_item_type	The type of item within the charge.
line_item_subscription_id	The subscription ID within the charge.
store_currency	The store’s main currency
total_duties	Duties displayed in presentment currency.
store_total_duties	Total duties displayed in store currency.
store_subtotal_price	Subtotal is displayed in store currency.
store_total_taxes	Taxes are displayed in store currency.
store_total_discounts	Discounts displayed in store currency.
store_total_price	Price displayed in store currency.
store_line_item_price	Line items displayed in store currency.
store_total_shipping	Shipping displayed in store currency.
store_total_refunds	Refunds displayed in store currency.
currency_conversion_rate_presentment_to_store	Currency conversion rate from presentment currency to store currency.
currency_conversion_rate_presentment_to_usd	Currency conversion rate from presentment currency to USD.
usd_total_price	Total pricing converted into USD.
presentment_currency	The currency the customer checked out with.

Payment Methods - All

In the merchant portal, click Tools & apps and select Exports from the dropdown.
Click Create Exports.
Under Select export type, click the dropdown and select Payment Methods -- All.
Enter in a custom export name (optional).
Click Create export.

This export contains all payment methods for your store.

Header	Definition
payment_method_id	A unique identifier assigned to the cardholder's payment method that is used to reference the payment method in Recharge's database.
customer_id	A unique string of numbers that identifies a specific customer and is tied specifically to their email address. Even if a customer has multiple subscriptions listed under one email address, they will still only have one Customer ID.
processor_name	The name of the payment processor or gateway handling the transaction.
processor_payment_method_token	A unique string of characters the payment processor generates which represents the cardholder's payment method.
processor_customer_token	A unique identifier generated by the payment processor that represents a specific customer.
status	The status of the payment method, such as ACTIVE or INACTIVE.
status_reason	Additional information that provides context for the current status of a payment method.
payment_type	Indicates the payment method the cardholder used.
default	Indicates if the payment method used is the default payment method on file for the customer.
payment_details	Detailed information about the payment method, including the card type, the last four digits of the credit card used, and the expiry date.
billing_first_name	The cardholder’s first name.
billing_last_name	The cardholder’s last name.
billing_address_1	The customer’s street address. This address may differ from the billing address if the person receiving the subscription and the cardholder live at different addresses.
billing_address_2	Any additional address information such as apartment number or specific mailbox. This field is not mandatory.
billing_company	The cardholder’s company name. This field is not mandatory.
billing_phone	The cardholder’s phone number.
billing_province	The cardholder’s state or province.
billing_city	The city the cardholder lives in.
billing_postal_code	The cardholder’s zip or postal code.
billing_country_code	A two-letter code indicating the cardholder's country.
created_at	The date and time a customer's payment method was created.
updated_at	The date and time a customer's payment method was updated.
deleted_at	The date and time if a payment method is deleted from a customer’s account.

Note: The Payment Methods - All export references customers only by their IDs. You may need to refer to the Customer Export for additional data.

Products

Note: Product Exports are available to merchants not using Product Subscription Plans. See Plans for Product Subscription Plan exports.

In the merchant portal, click Tools & apps and select Exports from the dropdown.
Click Create Exports.
Under Select export type, click the dropdown and select Products.
Enter in a custom export name (optional) and your e-mail address.
Click Create export.

This export contains all products created in Recharge.

Header	Definition
recharge_product_id	Unique numeric identifier of the product in Recharge.
external_product_id	A unique string of numbers that is used to identify the product that is listed on the subscription, from your eCommerce platform.
title	The title of the subscription product.
handle	The handle in the product URL.
products_are_subscription_only	Indicates whether a product is available only on subscription. If it is only available as a subscription, a 1 will be indicated in this column. If it is available as subscription and one-time, a 0 will be indicated in this column.
discount_amount	The discount percentage amount on the subscription. For example, if you offer 10% off for signing up for a subscription, 10 would be indicated in this column.
expire_after_specific_number_of_charges	The number of charges before the subscription expires.
charge_interval_frequency	The numerical value of how often the product is charged, depending on what is configured in the ruleset. For example, if a product was configured to charge every three months, the charge_interval_frequency value would be 3.
order_interval_frequency	The numerical value of how often the product is shipped, depending on what is configured in the ruleset. For example, if a product was configured to ship every month, the value here would be 1.
order_interval_unit	The period of time in which the product is shipped as configured in the ruleset. For example, if a product was configured to ship every month, the value would be "month."
cutoff_day_of_month	The specific day of the month that the customer needs to order the product by, as configured in the ruleset.
cutoff_day_of_week	The specific day of the week that customer needs to order the product by, as configured in the ruleset.
modifiable_properties	List of modifiable line item properties on the product as set by the store.
order_day_of_month	The specific day of the month that the product is submitted to your eCommerce platform on a recurring basis.
order_day_of_week	The specific day of the week that the product is submitted to your eCommerce platform on a recurring basis.
order_interval_frequency_options	List of order interval frequency options that customers can choose from. For example, order_interval_unit=month and order_interval_frequency_option for 3 would be an order every 3 months
created_at	The date the product was added to the ruleset.
updated_at	Indicates the most recent update date to the product in the ruleset.

Plans

Note: Plans Exports are available to merchants using Product Subscription Plans.

In the merchant portal, click Tools & apps and select Exports from the dropdown.
Click Create Exports.
Under Select export type, click the dropdown and select Plans.
Enter in a custom export name (optional) and your e-mail address.
Click Create export.

This export contains all information about your Plans created in Recharge.

Header	Definition
id	Unique numeric identifier of the plan in Recharge.
external_product_id	A unique string of numbers used to identify the product that is listed on the subscription, from your eCommerce platform.
sort_order	Indicates the order the plan is listed when listed with related plans.
type	The type of plan, either subscription, prepaid, or one-time.
title	The title of the plan.
interval_unit	The period of time in which the product is shipped as configured in the ruleset. For example, if a product was configured to ship every month, the value would be "month."
order_interval_frequency	The numerical value of how often the product is shipped, depending on what is configured in the ruleset. For example, if a product was configured to ship every month, the value here would be 1.
charge_interval_frequency	The numerical value of how often the product is charged, depending on what is configured in the ruleset. For example, if a product was configured to charge every three months, the charge_interval_frequency value would be 3.
channel_settings	The supported channels where the plan is available.
discount_amount	The discount percentage amount on the subscription. For example, if you offer 10% off for signing up for a subscription, 10 would be indicated in this column.
cutoff_day_of_month	The specific day of the month that the customer needs to order the product by, as configured in the ruleset.
cutoff_day_of_week	The specific day of the week that customer needs to order the product by, as configured in the ruleset.
expire_after_specific_number_of_charges	The number of charges before the subscription expires.
order_day_of_week	The specific day of the week that the plan is submitted to your eCommerce platform on a recurring basis.
order_day_of_month	The specific day of the month that the plan is submitted to your eCommerce platform on a recurring basis.
external_plan_group_id	The unique selling plan group id that appears in external platforms.
external_plan_id	The unique selling plan id that appears in external platforms.
external_plan_name	The name of the plan as it appears in external platforms.
apply_cutoff_date_to_checkout	This column is for future UI additions and can be left blank.
recurring_discount_type	Indicates what type of discount the customer will be receiving, such as a fixed amount, percentage, or shipping discount.
recurring_discount_amount	The discount percentage amount on the subscription. For example, if you offer 10% off for signing up for a subscription, 10 would be indicated in this column.
recurring_discount_after_cycle	This column is for future UI additions and can be left blank.
has_variant_restrictions	Indicates if the plan applies to specific variants of the product.
external_variant_ids	A list of variant ids for the product as they appear in external platforms.
created_at	The plan creation date.
updated_at	The most recent date the plan was updated at.

Subscriptions

In the merchant portal, click Tools & apps and select Exports from the dropdown.
Click Create Exports.
Under Select export type, click the dropdown and select any of the Subscriptions exports, as outlined below.
Enter in a custom export name (optional) and your e-mail address. On some reports, you can choose to select a date range of up to 90 days.
Click Create export.

Subscriptions - Active

This export contains all active subscriptions. Note that addresses and customers are referenced only by their ids, so you may need the Customers and Addresses exports for additional data.

Subscriptions - All

This export contains all subscriptions regardless of status. Note that addresses and customers are referenced only by their ids, so you may need the Customers and Addresses exports for additional data

Subscriptions - Cancelled

This export contains all cancelled subscriptions. Note that addresses and customers are referenced only by their ids, so you may need the Customers and Addresses exports for additional data

Subscriptions - Expired

This export contains all expired subscriptions. Note that addresses and customers are referenced only by their ids, so you may need the Customers and Addresses exports for additional data.

Subscriptions - All - by creation date

Addresses and customers are referenced only by their ids. You may need the Customers and Addresses exports for additional data.

This export contains all subscriptions regardless of their status, and organizes them by creation date.

Header	Definition
subscription_id	Unique numeric identifier for the subscription.
customer_id	A unique string of numbers that identifies a specific customer and is tied specifically to their email address. Even if a customer has multiple subscriptions listed under one email address, they will still only have one Customer ID.
customer_email	The email address associated with the subscription.
address_id	A unique string of numbers used to identify the customer’s subscription. This is also referred to as the Purchase ID. Individual products within a subscription will also be assigned a unique purchase_items_id.
status	The status of the subscription, such as ACTIVE or INACTIVE.
product_title	The title of the subscription product.
variant_title	The title of the specific variant that the subscriber is subscribed to.
recurring_price	The recurring cost for the subscription product.
price	The price the customer paid for their subscription product when they checked out. The price paid at checkout might differ from the recurring price if a discount code was used, or if a free trial workflow is implemented.
quantity	This is the number of products ordered.
external_product_id	A unique string of numbers that is used to identify the product that is listed on the subscription.
external_variant_id	A unique string of numbers that is used to identify the specific variant on the subscription. Even if a product does not have any variants created in your eCommerce platform, it still will have one variant ID assigned. Recharge uses the variant ID to create each charge.
sku	Populated if `sku_override`is set. This is not the product SKU of the subscription product.
sku_override	If a SKU override is in place, this column will show the actual SKU that was used to create the charge. Retrieved from `general_arttributes[sku_override]`
expire_after_specific_number_of_charges	If the product is in a ruleset that is configured to expire after a certain amount of charges, this column will show how many charges are left until the subscription is automatically cancelled.
order_interval_frequency	The numerical value of how often the product is shipped. For example, if a product was configured to ship every month, the value would be "1."
charge_interval_frequency	The numerical value of how often the product is charged, depending on what is configured in the ruleset. For example, if a product was configured to charge every month, the value would be "1."
order_interval_unit	The period of time in which the product is shipped as. For example, if a product was configured to ship every month, the value would be "month."
charge_day_of_month	The specific day of the month that the customer is charged for their subscription on a recurring basis.
charge_day_of_week	The specific day of the week that the customer is charged for their subscription on a recurring basis.
properties	This column displays any line item properties that were sent through with the order. Line item properties are custom forms on a product used to collect additional customization information.
cancelled_at	The date the customer canceled their subscription.
cancellation_reason	The reason the product has been canceled from the customer's subscription. This can be selected by the store owner, customer, or automatically by Recharge (e.g. max retries reached).
cancellation_reason_comments	Submitted comments as to why the product was canceled.
created_at	The date the subscription was added to the account.
deleted_at	This column displays the date and time in the event that a product is completely deleted from a customer’s account.
updated_at	If a change is made to a subscription, the most recent update date will be indicated in this column.
presentment_currency	Currency that the customer checked out with.
store_currency	The store’s main currency.

Was this article helpful?

2 out of 2 found this helpful

New in-app support experience

How can we help?

Addresses

Addresses - Similar By Creation Date

Header

Definition

Bundles

Bundles - Active

Bundles selection - Filtered by contents

Header

Definition

Charges

Charges - Error

Charges - Processed

Charges - Queued

Charges - Skipped

Charges - Pending

Header

Definition

Credit - Adjustments

Header

Definition

Customers

Customers - Active

Header

Definition

Customers - Shipping Addresses

Header

Definition

Customers - Payment tokens

Header

Definition

Discounts

Header

Definition

Emails

Header

Definition

Events

Header

Definition

One-time

Header

Definition

Orders

Orders - Cancelled

Orders - Errors

Orders - Prepaid Processed

Orders - Prepaid Queued

Orders - Processed

Orders - Pending

Header

Definition

Payment Methods - All

Header

Definition

Products

Header

Definition

Plans

Header

Definition

Subscriptions

Subscriptions - Active

Subscriptions - All

Subscriptions - Cancelled

Subscriptions - Expired

Subscriptions - All - by creation date

Header

Definition

Related articles

PLATFORM

PARTNERS

RESOURCES

COMPANY