Chargebee to Metabase

This page provides you with instructions on how to extract data from Chargebee and analyze it in Metabase. (If the mechanics of extracting data from Chargebee seem too complex or difficult to maintain, check out Stitch, which can do all the heavy lifting for you in just a few clicks.)

What is Chargebee?

Chargebee is a subscription and billing management platform that can handle all the aspects of the subscription lifecycle, including recurring billing, invoicing, and trial management. It can integrate with payment gateways to process recurring and one-off payments. Chargebee supports hosted pages, or you can integrate your existing workflow through the Chargebee API.

What is Metabase?

Metabase provides a visual query builder that lets users generate simple charts and dashboards, and supports SQL for gathering data for more complex business intelligence visualizations. It runs as a JAR file, and its developers make it available in a Docker container and on Heroku and AWS. Metabase is free of cost and open source, licensed under the AGPL.

Getting data out of Chargebee

Chargebee provides a RESTful API that lets developers retrieve data stored in the platform about customers, payment sources, transactions, and more. For example, to retrieve a credit card for a customer, you would call GET https://{site}.chargebee.com/api/v2/cards/{customer_id}.

Sample Chargebee data

Here's an example of the kind of response you might see with a query like the one above.

{"card": {
    "card_type": "american_express",
    "customer_id": "__test__5SK0bLNFRFuFMYTiE",
    "expiry_month": 12,
    "expiry_year": 2021,
    "funding_type": "not_known",
    "gateway": "chargebee",
    "gateway_account_id": "gw___test__KyVnTyRFuFKx13r",
    "iin": "378282",
    "last4": "0005",
    "masked_number": "***********0005",
    "object": "card",
    "payment_source_id": "pm___test__5SK0bLNFRFuFMZ8iH",
    "status": "valid"
}}

Preparing Chargebee data

If you don't already have a data structure in which to store the data you retrieve, you'll have to create a schema for your data tables. Then, for each value in the response, you'll need to identify a predefined datatype (INTEGER, DATETIME, etc.) and build a table that can receive them. Chargebee's documentation should tell you what fields are provided by each endpoint, along with their corresponding datatypes.

Complicating things is the fact that the records retrieved from the source may not always be "flat" – some of the objects may actually be lists. In these cases you'll likely have to create additional tables to capture the unpredictable cardinality in each record.

Loading data into Metabase

Metabase works with data in databases; you can't use it as a front end for a SaaS application without replicating the data to a data warehouse first. Out of the box Metabase supports 15 database sources, and you can download 10 additional third-party database drivers, or write your own. Once you specify the source, you must specify a host name and port, database name, and username and password to get access to the data.

Using data in Metabase

Metabase supports three kinds of queries: simple, custom, and SQL. Users create simple queries entirely through a visual drag-and-drop interface. Custom queries use a notebook-style editor that lets users select, filter, summarize, and otherwise customize the presentation of the data. The SQL editor lets users type or paste in SQL queries.

Keeping Chargebee data up to date

At this point you've coded up a script or written a program to get the data you want and successfully moved it into your data warehouse. But how will you load new or updated data? It's not a good idea to replicate all of your data each time you have updated records. That process would be painfully slow and resource-intensive.

The key is to build your script in such a way that it can identify incremental updates to your data. Thankfully, Chargebee's API results include fields like created_at that allow you to identify records that are new since your last update (or since the newest record you've copied). Once you've take new data into account, you can set your script up as a cron job or continuous loop to keep pulling down new data as it appears.

From Chargebee to your data warehouse: An easier solution

As mentioned earlier, the best practice for analyzing Chargebee data in Metabase is to store that data inside a data warehousing platform alongside data from your other databases and third-party sources. You can find instructions for doing these extractions for leading warehouses on our sister sites Chargebee to Redshift, Chargebee to BigQuery, Chargebee to Azure Synapse Analytics, Chargebee to PostgreSQL, Chargebee to Panoply, and Chargebee to Snowflake.

Easier yet, however, is using a solution that does all that work for you. Products like Stitch were built to move data automatically, making it easy to integrate Chargebee with Metabase. With just a few clicks, Stitch starts extracting your Chargebee data, structuring it in a way that's optimized for analysis, and inserting that data into a data warehouse that can be easily accessed and analyzed by Metabase.