Chargebee (Edge)

Configure Chargebee as a Source in your Pipeline

Perform the following steps to configure your Chargebee Source:

1. Click Pipelines in the Navigation Bar.

2. Click + Create Pipeline in the Pipelines List View.

3. On the Select Source Type page, select Chargebee.

4. On the Select Destination Type page, select the type of Destination you want to use.

5. On the Select Pipeline Type page, click Edge, and then click Continue.

   

   This page appears only if the selected Destination type is supported in Edge. Otherwise, you can proceed to create an Edge Pipeline.

6. In the Configure Source screen, specify the following:

   

   • Source Name: A unique name for your Source, not exceeding 255 characters. For example, Chargebee Source.

   • In the Connect to your Chargebee account section, specify the following:

     • API Key: The API key that you created in Chargebee.

     • Sub Domain: The sub domain of your Chargebee site. For example, if your site URL is https://acme-test.chargebee.com, the sub domain is acme-test.

7. Click Test & Continue to test the connection to your Chargebee Source. Once the test is successful, you can proceed to set up your Destination.

---

Data Replication

Hevo replicates data for all the objects selected on the Configure Objects page during Pipeline creation. By default, all supported objects and their available fields are selected. However, you can modify this selection while creating or editing the Pipeline. To ingest a child object, you must also select its parent object. For example, to ingest the Invoice Line Item object, you must also select the Invoice object. The Data Model lists the child objects of each parent object.

The first run of the Pipeline ingests all the data of the selected objects. In the subsequent runs, as per the sync frequency, Hevo ingests data as follows:

Each time Hevo ingests a parent record, it also ingests the current data of the record’s child objects. In each run, Hevo also reads the records changed during the few minutes before the previous run, so that records changed while the previous run was in progress are not missed.

For a subscription, Hevo also saves each update as a new record in the Subscription History object and its child objects, so that you can see how the subscription changed over time. Hevo reads the entitlements of all the subscriptions, in the Subscription Entitlement object, only in the first run and when you resync the Subscription object.

Hevo loads the custom fields of the Coupon, Credit Note, Customer, Invoice, Item, Item Family, Item Price, Quote, Subscription, and Subscription History records as key-value pairs in the custom_fields column, in JSON format. For example, {“cf_region”:”EMEA”}.

You can resync all the objects except the child objects. Resyncing a parent object also resyncs its child objects.

Chargebee limits the number of API requests that each site can make in a minute: 150 for test sites, and 150, 1,000, or 3,500 for live sites on the Starter, Performance, and Enterprise plans, respectively. If Hevo exceeds this limit, it waits and retries the request. Read API Rate Limits.

Note: You can create a Pipeline with this Source only using the Merge load mode. The Append mode is not supported for this Source.

---

Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination. For a detailed view of the objects, fields, and relationships, click the ERD.

---

Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:

---