Chargebee to S3

This page provides you with instructions on how to extract data from Chargebee and load it into Amazon S3. (If this manual process sounds onerous, 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 S3?

Amazon S3 (Simple Storage Service) provides cloud-based object storage through a web service interface. You can use S3 to store and retrieve any amount of data, at any time, from anywhere on the web. S3 objects, which may be structured in any way, are stored in resources called buckets.

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 Amazon S3

To upload files you must first create an S3 bucket. Once you have a bucket you can add an object to it. An object can be any kind of file: a text file, data file, photo, or anything else. You can optionally compress or encrypt the files before you load them.

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.

Other data warehouse options

S3 is great, but sometimes you want a more structured repository that can serve as a basis for BI reports and data analytics — in short, a data warehouse. Some folks choose to go with Amazon Redshift, Google BigQuery, PostgreSQL, Snowflake, Microsoft Azure SQL Data Warehouse, or Panoply, which are RDBMSes that use similar SQL syntax. If you're interested in seeing the relevant steps for loading data into one of these platforms, check out To Redshift, To BigQuery, To Postgres, To Snowflake, To Azure SQL Data Warehouse, and To Panoply.

Easier and faster alternatives

If all this sounds a bit overwhelming, don’t be alarmed. If you have all the skills necessary to go through this process, chances are building and maintaining a script like this isn’t a very high-leverage use of your time.

Thankfully, products like Stitch were built to move data from Chargebee to Amazon S3 automatically. With just a few clicks, Stitch starts extracting your Chargebee data via the API, structuring it in a way that is optimized for analysis, and inserting that data into your Amazon S3 data warehouse.