Chargebee is a subscription billing and revenue management platform that helps businesses automate recurring billing, manage subscriptions, handle invoicing, and optimize revenue operations across multiple payment gateways and regions.

Configuring Chargebee as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Chargebee option from the list of connectors. Click Next and you’ll be prompted to add your access.

1. Add account access

You’ll need to provide your Chargebee API credentials. The following configurations are available:

API Key: Your Chargebee API key. You can generate one from Settings > Configure Chargebee > API Keys in your Chargebee dashboard.
Site Name: Your Chargebee site name, which is the subdomain of your Chargebee URL. For example, if your Chargebee URL is acme.chargebee.com, the site name is acme.
Start Date: (Optional) The earliest date from which records will be synced.

Once you’re done, click Next.

2. Select streams

Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.

Tip: The stream can be found more easily by typing its name.

Select the streams and click Next.

3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.

Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
- Incremental: every time the extraction happens, we’ll get only the new data, which is good if you want to keep every record ever fetched.
- Full table: every time the extraction happens, we’ll get the current state of the data, which is good if you don’t want to have deleted data in your catalog.

Once you are done configuring, click Next.

4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:

Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.

Once you are ready, click Next to finalize the setup.

5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.

For you to be able to see it on your Catalog, you need at least one successful source run.

Streams and Fields

Below you’ll find all available data streams from Chargebee and their corresponding fields:

Customers

Field	Type
id	string
first_name	string
last_name	string
email	string
phone	string
company	string
auto_collection	string
net_term_days	integer
allow_direct_debit	boolean
created_at	integer
updated_at	integer
taxability	string
locale	string
pii_cleared	string
channel	string
resource_version	integer
deleted	boolean
registered_for_gst	boolean
customer_type	string
business_customer_without_vat_number	boolean
primary_payment_source_id	string
backup_payment_source_id	string
promotional_credits	integer
unbilled_charges	integer
refundable_credits	integer
excess_payments	integer
preferred_currency_code	string
mrr	integer
cf_custom_fields	string

Subscriptions

Field	Type
id	string
customer_id	string
plan_id	string
plan_quantity	integer
plan_unit_price	integer
plan_amount	integer
billing_period	integer
billing_period_unit	string
plan_free_quantity	integer
status	string
trial_start	integer
trial_end	integer
current_term_start	integer
current_term_end	integer
next_billing_at	integer
created_at	integer
updated_at	integer
started_at	integer
activated_at	integer
cancelled_at	integer
cancel_reason	string
channel	string
resource_version	integer
deleted	boolean
currency_code	string
mrr	integer
exchange_rate	number
base_currency_code	string
has_scheduled_changes	boolean
has_scheduled_advance_invoices	boolean
due_invoices_count	integer
start_date	integer
auto_collection	string
remaining_billing_cycles	integer

Orders

Field	Type
id	string
document_number	string
invoice_id	string
subscription_id	string
customer_id	string
status	string
cancellation_reason	string
payment_status	string
order_type	string
price_type	string
order_date	integer
shipping_date	integer
created_at	integer
updated_at	integer
shipped_at	integer
delivered_at	integer
cancelled_at	integer
total	integer
sub_total	integer
tax	integer
discount	integer
amount_paid	integer
amount_adjusted	integer
refundable_credits_issued	integer
tracking_id	string
tracking_url	string
batch_id	string
resource_version	integer
deleted	boolean
currency_code	string

Transactions

Field	Type
id	string
customer_id	string
subscription_id	string
gateway_account_id	string
payment_source_id	string
payment_method	string
gateway	string
type	string
date	integer
settled_at	integer
exchange_rate	number
currency_code	string
amount	integer
amount_unused	integer
base_currency_code	string
id_at_gateway	string
status	string
error_code	string
error_text	string
fraud_flag	string
reference_number	string
resource_version	integer
updated_at	integer
created_at	integer
deleted	boolean

Documentation

Get started

Using Nekt

Workspace

Resources

Chargebee as a data source

Configuring Chargebee as a Source

1. Add account access

2. Select streams

3. Configure data streams

4. Configure data source

5. Check your new source

Streams and Fields

Documentation

Get started

Using Nekt

Workspace

Resources

Documentation Index

​Configuring Chargebee as a Source

​1. Add account access

​2. Select streams

​3. Configure data streams

​4. Configure data source

​5. Check your new source

​Streams and Fields

Configuring Chargebee as a Source

1. Add account access

2. Select streams

3. Configure data streams

4. Configure data source

5. Check your new source

Streams and Fields