Certain information in this article may be missing or out of date. We are in the process of updating the content.
Chargebee takes the pain out of subscription billing by integrating with leading payment gateways around the world to let you automate payment collection, invoicing, email notifications and customer management. The Chargebee/Grow integration allows you insights into your data that help you manage your business smoothly.
Connecting to Chargebee
Before you get started, collect your Chargebee site URL and API Key.
- Select the Data tab next to the Dashboard.
This takes you to the Data Overview page. - Click on the Connections button.
- Click on the blue Connect button at the end of the Your Top Data Sources options.
- Search and select Chargebee from the list of data connections.
- In the window that pops up, enter the subdomain for your Chargbee account and the API Key.
You can find your API key in Chargbee by following these steps- Navigate to Settings > API and Webhooks > API Keys.
- Click Add API Key button to create a new key.
- When you generate an API Key, you are able to set permissions for access with each API Key. You can read through the help documentation of Chargebee on the different levels of permission.
- Once you have entered this into Grow, click the blue Connect button.
Endpoints
Below is a list of the reports Chargebee offers, along with a short description of the information each one returns.
- Customers: A list of all customers and associated billing information.
- Invoices: Details of specific invoices, customer name, amounts, status, type, dates, etc.
- Orders: Details and status of various shipments and orders, etc. (Order management must be set up on account.)
- Subscriptions: Plan type, billing information, amount, customer information, monthly recurring revenue, etc.
- Transactions: List of transactions, by method, gateway, date, amount, referenced invoice, refunded status, etc.
-
Events: You can join this data with other existing tables such as Subscriptions and Customers, without the need for additional transformations.
The event types includes the following:
subscription_created, subscription_activated, subscription_changed, mrr_updated, subscription_cancellation_scheduled, subscription_cancelled, subscription_reactivated, subscription_reactivated_with_backdating, subscription_scheduled_cancellation_removed, subscription_changes_scheduled, subscription_deleted, subscription_paused, subscription_pause_scheduled, subscription_scheduled_pause_removed, etc.
FAQS + Tips and Tricks
Issues When Pulling Large Amounts of Data
You may encounter some issues when attempting to pull large amounts of data from Chargebee. If you encounter a time-out or some sort of error when trying to query large amounts of data (last 2 years, for example), a workaround is to break up your request into a few reports within the metric builder in order to allow the query to successfully execute. For example, Report1 can be the last 6 months, Report2 can be the prior 6 months, etc. You can then use the UNION ALL report to merge the data into a workable state. For more information, contact support@grow.com.
Differing Information in Tables
Chargebee API works different for each product version. Since accounts on Chargebee can have different product catalog versions (eg: 1.0, 2.0), you may find the information displayed for some of the tables being different depending on the version of each account. Additionally, some of the tables contain information for one product version but not for others.
List of differences:
- Product Catalog 1.0:
- Subscription Table:
- Subscriptions - Charged Event Based Addon
- Subscriptions - Addons
- Subscriptions - Event Based Addons
- Subscription Table:
- Product Catalog 2.0:
- Subscription Table:
- Subscriptions - Subscription Items
- Subscription Table:
Date Format for Chargebee Data in Grow Warehouse
Dates come in as standard date-time into the Grow warehouse. They no longer come in as UNIX for Chargebee data.
Data About Currencies Comes in as Cents
This means you may need to convert it into another format if you would like to view it in dollars. This is easy using the Calculated Columns transform.