Chargebee is one of ChartMogul’s supported billing systems, allowing you to import customer, subscription, and transaction data to generate subscription analytics and cash flow metrics. Read our launch announcement.

Here's what we cover in this article:

• Overview
• Data Settings
• How this integration works
• Before you begin
• Connecting Chargebee to ChartMogul
• Manually re-syncing data
• Deleting Chargebee as a source

Overview

The following table provides details on key aspects of how ChartMogul integrates with Chargebee. 

Data Settings

The following table provides details on how ChartMogul’s data settings work with your billing system.

How this integration works

Integration versioning

On November 2, 2022 we released a new version of our Chargebee integration. To have it enabled in your account, contact support.

To check if you’re using the latest version, navigate to Data Platform > Sources and locate your Chargebee source. If the Chargebee logo includes a NEW label, you’re using the latest version. If the logo does not include a NEW label, you’re using the previous version, and some features may be unavailable.

There are also several additional details you should understand and consider when using Chargebee with ChartMogul.

Before you begin

• Review your data settings to ensure ChartMogul calculates metrics and analytics based on the needs of your business. Adjusting these settings after importing data will require you to manually re-sync data.
• Log in to the Chargebee account you’d like to connect to ChartMogul. If you have multiple Chargebee accounts, you’ll need to add each account as a separate source in ChartMogul.
• Locate your Chargebee subdomain. For example, if your Chargebee URL is mycompany.chargebee.com then your Chargebee subdomain is mycompany.
• Ensure Hide Zero Value Line Items is disabled in Chargebee. ChartMogul requires Chargebee to generate a $0 invoice to accurately report paid to free plan switches as contraction.

Connecting Chargebee to ChartMogul

Step 1 — Create a read-only API key

ChartMogul uses API keys to connect to Chargebee. For added security, we recommend creating a read-only API key in Chargebee to grant ChartMogul access to your Chargebee account. Learn more.

1. Log in to your Chargebee account, navigate to Settings > Configure Chargebee > API keys.
2. Click + Add API Key.
3. Select Read-Only Key.
4. Grant the key All permissions.
5. Name the key, e.g., ChartMogul Read-only.
6. Click Create Key.

Note your API Key. You'll need this in Step 2 when adding Chargebee as a source in ChartMogul.

Step 2 — Add Chargebee as a source

Next, add Chargebee as a source in ChartMogul:

1. Within ChartMogul, navigate to Data Platform > Sources.
2. Click Add a Source.
   
3. Select Chargebee.
   
4. Enter a unique name for your source in the Name field and click Next.
   
5. Paste your Chargebee subdomain (the mycompany part of mycompany.chargebee.com) into the Chargebee Subdomain field.
   
6. Paste the API key you created in Step 1 into the Chargebee API Key field.
7. Finally, click Import Data to connect Chargebee to ChartMogul and start importing your data.

The import can take some time, depending on the number of customers. After the import has concluded, ChartMogul will update automatically with any new activity from Chargebee.

ChartMogul automatically imports all data once you’ve successfully connected it to Chargebee. No further action is needed to import historical data.

Step 3 — Add a webhook in Chargebee to keep your data synced

Once you’ve imported data, ChartMogul generates a webhook that you’ll need to add to Chargebee to keep your data synced in real-time.

1. Copy your Webhooks URL.
   
2. Within Chargebee, navigate to Settings > Configure Chargebee > Webhooks.
3. Click + Add Webhook.
4. Name the webhook, e.g., ChartMogul Webhook.
5. Paste your webhook URL into the Webhook URL field.
6. Select Version 2 as the API Version.
7. Click Create.

After the webhook is added, changes in Chargebee are synced in real-time with ChartMogul.

Manually re-syncing data

If you alter one of the settings in your source or a data setting requiring a re-sync, you will need to re-import your data to make the behavior consistent historically and going forward.

Re-syncing your Chargebee source will not impact changes you’ve made in ChartMogul such as edited customer details, edited MRR, or merged customers.

If you’re using the latest version of our Chargebee integration, connected subscriptions will be preserved after a re-sync. If you’re using a previous version, re-syncing data will remove subscription connections.

Here’s how to manually re-sync data when needed:

1. Within ChartMogul, navigate to Data Platform > Sources.
2. Find your Chargebee source and click the Settings  icon.
3. Click Re-Sync Data.

ChartMogul will start re-importing your data and let you know where it’s at with a progress bar.

Deleting Chargebee as a source

Before deleting a source, please note the following:

• The Chargebee API does not support unsubscribing from webhooks. If you cancel ChartMogul, the ChartMogul webhook URL must be manually removed in Chargebee.
• All data from this source will be immediately and irrevocably removed from ChartMogul.
• All MRR adjustments and connected subscriptions will be lost.
• If this source contains a merged customer, the customer record and data from the non-deleted source will remain in ChartMogul.

To delete a Chargebee source, navigate to Data Platform > Sources. Find the source in the list and click the Settings  icon. From there, click Delete This Source.

Next Steps

• Learn more about segmentation.
• Customize your Dashboard.
• Download the ChartMogul mobile app.
• Get started with charts.