Docs

Log in to read the version of docs relevant to your site, or use the dropdown versions

Automatic Exports

Overview

Automatic Exports make it easy to transfer your data from Chargebee to cloud storage solutions like Google Cloud Storage (GCS) or Amazon Simple Storage Service (S3). This feature is ideal for scheduled transfers of Chargebee data to external systems, supporting downstream use cases such as financial reporting and data analytics

View the full list of tables and fields that are available for export here.

Prerequisites

The following Chargebee sites are eligible to use this feature:

  • Chargebee sites that are hosted in the US and EU data hosting centre. Note: To identify your US data hosting centre, check the site URL, it starts with https://app.chargebee.com/. For AU or EU data hosting centre the site URL contains au or eu - https://app.au.chargebee.com/ or https://app.eu.chargebee.com/ respectively.
  • Chargebee sites that are on product catalog 2.0.

When your site meets the prerequisites, the Automatic Exports option appears under Settings > Import & Export Data > Export Data.

Configuration

This feature sends files in the format of your choice to your cloud storage container(Google Cloud Storage (GCS) and Amazon Simple Storage Service (S3)), where they can be picked up and loaded into your data lake or warehouse. To configure Automatic Export:

  1. Follow the instructions for your respective cloud storage for setting up Automatic Export to Google Cloud or Amazon S3.
  2. Once the setting in the respective cloud storage is configured, follow the instructions to set up Automatic Export in Chargebee.

Export Status

Check the status of your data exports via Email Notification and Export Logs.

  • Email Notifications: You will receive an email once an export reaches a Completed state, either Success or Failure.
  • Export Logs: You can always view the detailed status of each export, including per-table success or failure, under the Export Logs tab of your connector.
    • Success: Exports for all selected datasets were completed successfully.
    • Failed: Exports for all selected datasets were unsuccessful. A reattempt will happen automatically at the mentioned date and time.
    • Partial Failure: If some datasets fail while others succeed, you'll see a Partial Failure status in the logs. A banner appears indicating we're investigating the issue, and a reattempt for failed datasets will happen automatically at the mentioned date and time.

Frequently Asked Questions

  1. **What is the Data Schema of the exported data? ** You can view the list of tables, fields, and the schema in the Data Catalog Explorer.

  2. Do I need to configure the connection for each site separately if I have multiple Chargebee sites? Yes, you will have to configure the connection for each site individually.

  3. How often can I export data using this feature? You can export data daily with full exports. Weekly and monthly options will be available in future releases.

  4. What is the cut-off time for data included in each day's export? Each day's export includes data up until 11:59 PM UTC of the previous day. Currently, this setting cannot be configured.

  5. What is the pricing for this feature? Currently, this feature is available at no cost for early adopters. In the future, an additional charge will be applied based on your Chargebee plan, data volume, and exports configuration. Existing users will receive sufficient notice and communication before any pricing changes take effect.

  6. How are new custom fields created in Chargebee handled in Automatic Exports? New custom fields in Chargebee are not automatically included in existing export configurations. To include a new custom field in future exports, manually select it in the Automatic Exports user interface. This step is necessary even if the custom field table is already part of your saved configuration.

  7. What happens if an existing custom field is archived in Chargebee? Archived custom fields remain part of the saved export configuration and are included in exports with their data retained. To exclude an archived field, deselect it manually in the Automatic Exports user interface. This action updates the schema version to reflect the change.

  8. What happens if an existing custom field is discarded or deleted from Chargebee? Discarded or deleted custom fields are automatically excluded from export files and do not appear in the Automatic Exports user interface. No manual action is required, as the system automatically manages the exclusion without updating the schema version.

Was this article helpful?