Chargebee
Chargebee is the subscription billing and revenue management platform. It helps automate the lead-to-ledger workflow across your revenue stack.
Chargebee offers full API access for reading the most commonly used operations, data and metrics. They publish a documentation website for a more in-depth overview as well as a knowledge base for learning purposes.
Features
Feature name | Supported | |
---|---|---|
Column Hashing | True | Column level |
Blocking | True | Column level |
Incremental | True | Except for the usage table. |
Custom data | False | |
History | False | |
ReSync | True | Table level |
Templates | False |
Data Schema
Schema information
The general rule of thumb is that Weld follows the Chargebee API's best practices when defining the shape of incoming data and keeps the column names the same, whenever possible.
A note on Custom Fields
Chargebee allows its users to define custom fields for a select number of streams. While there are no constraints on field naming, we support the Chargebee default recommendation that all custom fields must have a cf_
prefix.
Due to API limitations, a scan for custom fields is performed based on the latest 50 rows of each supported stream. This means that if none of the latest 50 rows have data in a given custom field, it will remain invisible to us. All custom data is formatted and stored as a JSON string in the destination.
Updating data
The data is being fetched in an incremental manner, with the first sync running a FULL
import, starting from 01.01.1970
. The user is not able to defined a limited range for the first sync.
🔧 Setup Guide
Prerequisites
- An API key with the following scopes:
Read-Only Key
/All Data
- Chargebee Docs can help take you through the necessary steps to create a key.
- Find out what your Site Name is. It is usually used as the sub-domain in your Chargebee URL:
https://
mysite-test
.chargebee.com/
Step 1 - Begin Configuration
Pick Chargebee
from the list of connectors and give the connector a name.
Step 2 - Authorize
Enter your Site Name
and API Key
.
Step 3 - Finalize
Click Connect. When authorization is complete, you will be redirected back to the Weld connections overview. The configuration is complete.