This integration is powered by Singer's Chargebee tap. For support, visit the GitHub repo or join the Singer Slack.
Chargebee integration summary
Stitch’s Chargebee integration replicates data using the Chargebee v2 API . Refer to the Schema section for a list of objects available for replication.
This integration supports Chargebee sites that use version 1.0 or version 2.0 of Chargebee’s Product Catalog. The Product Catalog version your site uses determines which tables and fields you can select for replication, however. Refer to the Table and field availability and Chargebee product catalogs section for more info.
Chargebee feature snapshot
A high-level look at Stitch's Chargebee (v1) integration, including release status, useful links, and the features supported in Stitch.
| STITCH | |||
| Release status |
Released on May 21, 2019 |
Supported by | |
| Stitch plan |
Standard |
API availability |
Available |
| Singer GitHub repository | |||
| REPLICATION SETTINGS | |||
| Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
| Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
| DATA SELECTION | |||
| Table selection |
Supported |
Column selection |
Supported |
| Select all |
Supported |
||
| TRANSPARENCY | |||
| Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting Chargebee
Step 1: Generate an API Key
First, you’ll generate a Chargebee API Key for Stitch. This will allow Stitch to read data from your Chargebee account using the Chargebee API.
- Sign into your Chargebee account.
- In the left sidenav, click Settings > Configure Chargebee.
- Click the API keys and webhooks button.
- On the API Keys page, click the + Add API Key button. The Create an API Key modal will display.
- Select Read-Only Key as the API key type.
- Select All to define the API key’s access. This will grant read-only access to your Chargebee site.
- In the Name the API key field, enter
Stitch. - Click Create Key.
Chargebee will create the API key and redirect you back to the API Keys page:
Copy the API key somwhere handy - you’ll need it to complete the setup in Stitch.
Step 2: Add Chargebee as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Chargebee icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Chargebee” would create a schema called
stitch_chargebeein the destination. Note: Schema names cannot be changed after you save the integration. - In the API Key field, paste the API key you generated in Step 1.
- In the Site field, enter the name of your Chargebee site. This can be found in the URL of your Chargebee site. For example: If the URL was
https://stitch.chargebee.com, onlystitchwould be entered into this field.
Step 3: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Chargebee integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond Chargebee’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 4: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Chargebee integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For Chargebee integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up Chargebee, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Chargebee replication
Table and field availability and Chargebee product catalogs
The availability of some tables and fields is dependent on the Chargebee Product Catalog version your Chargebee site uses. Refer to Chargebee’s documentation for more info, including how to identify which Product Catalog version your site is using.
The following table contains a list of the tables included in this version of Stitch’s Chargebee integration and the Product Catalog version required to replicate the table.
Additionally, some fields are also subject to Product Catalog version requirements. These fields are noted in the attribute documentation for individual tables.
Note: If your site is using a Product Catalog version that a table or field doesn’t support, the table/field won’t display in the Tables to Replicate tab in Stitch. For example: If the site is using v2.0 of the Product Catalog, tables/fields that require v1.0 won’t display in Stitch.
| Table name | Required Product Catalog version |
| addons | v1.0 only |
| coupons | Any |
| credit_notes | Any |
| customers | Any |
| events | Any |
| gifts | Any |
| invoices | Any |
| items | v2.0 only |
| item_families | v2.0 only |
| item_prices | v2.0 only |
| orders | Any |
| payment_sources | Any |
| plans | v1.0 only |
| promotional_credits | Any |
| subscriptions | Any |
| transactions | Any |
| virtual_bank_accounts | Any |
Chargebee table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the Chargebee integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.
addons
| Replication Method : |
Key-based Incremental |
Replication Key  :
|
updated_at |
Primary Key  :
|
id |
API endpoint : |
The addons table contains info about the addons in your Chargebee account. Addons are additional charges applied to subscriptions apart from base charges.
Note: This table is available for Chargebee sites using v1.0 of Chargebee’s Product Catalog. Refer to the Table and field availability and Chargebee Product Catalogs section for more info.
|
id
The addon ID. Reference:
|
|||
|
updated_at
The time the addon was last updated. Note: This attribute will be present only if the resource has been updated after 2016-09-28. |
|||
|
accounting_code
The accounting code used by the addon. |
|||
|
accouting_category1
The name of the category of your product in Xero. If you’ve integrated with QuickBooks, this will be the |
|||
|
accouting_category2
The name of the category of your product in Xero. |
|||
|
archived_at
The time at which the plan was moved to archived status. |
|||
|
avalara_sale_type
Applicable only if you use Chargebee’s AvaTax for Communications integration. The type of sale carried out. Possible values are:
|
|||
|
avalara_service_type
Applicable only if you use Chargebee’s AvaTax for Communications integration. The type of service for the product to be taxed. |
|||
|
avalara_transaction_type
Applicable only if you use Chargebee’s AvaTax for Communications integration. The type of product to be taxed. |
|||
|
charge_type
The type of charge. Possible values are:
|
|||
|
currency_code
The currency code (ISO 4217 format) of the addon. |
|||
|
custom_fields
|
|||
|
description
Description about the addon to show in the hosted pages and customer portal. |
|||
|
enabled_in_portal
Indicates if the addon is available to customers to add in the ‘Change Subscription’ option in the customer portal. |
|||
|
invoice_name
The display name used in invoices. |
|||
|
invoice_notes
The invoice notes for the addon. |
|||
|
is_shippable
Indicates whether the addon can be added to orders. |
|||
|
meta_data
Additional info about the addon. |
|||
|
name
The display name used in web interface for identifying the addon. |
|||
|
object
|
|||
|
period
Applicable only for |
|||
|
period_unit
Applicable only for
|
|||
|
price
The addon price. Addon price is calculated based on the addon type and charge type. |
|||
|
price_in_decimal
|
|||
|
pricing_model
Indicates how the charges for the addon are calculated. Possible values are:
|
|||
|
resource_version
The version number of the addon. Each update of the addon results in an incremental change of this value. Note: This attribute will be present only if the resource has been updated after 2016-09-28. |
|||
|
shipping_frequency_period
Defines the shipping frequency in conjunction with |
|||
|
shipping_frequency_period_unit
Defines the shipping frequency in conjunction with
|
|||
|
sku
The field is used as Product name/code in your third party accounting application. Chargebee will use it as an alternate name in your accounting application |
|||
|
status
The status of the addon. Possible values are:
|
|||
|
tax_code
The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee’s AvaTax for Sales integration. |
|||
|
tax_profile_id
The tax profile of the addon. |
|||
|
taxable
Indicates whether the addon is taxable or not. |
|||
|
tiers
Applicable only if the addon uses tiered, volume, or stairstep pricing. The list of tiers for the addon.
|
|||
|
type
|
|||
|
unit
Applicable only for quantity type addons. This specifies the type of quantity. For example: If the addon price is |
coupons
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updated_at |
|
Primary Key :
|
id |
API endpoint : |
The coupons table contains info about the coupons in your Chargebee account.
Note: This table is available for sites using any Chargebee Product Catalog version. Refer to the Table and field availability and Chargebee Product Catalogs section for more info.
|
id
The coupon ID. Reference:
|
||||
|
updated_at
The time the coupon was last updated. |
||||
|
addon_constraint
This attribute will be present only if your Chargebee site uses v1.0 of Chargebee’s Product Catalog. Refer to the Table and field availability and Chargebee Product Catalogs section for more info. The addons the coupon can be applied to. Possible values are:
|
||||
|
addon_ids
This attribute will be present only if your Chargebee site uses v1.0 of Chargebee’s Product Catalog. Refer to the Table and field availability and Chargebee Product Catalogs section for more info. A list of IDs of addons associated with the coupon. |
||||
|
apply_discount_on
|
||||
|
apply_on
The invoice items for which this coupon needs to be applied. Possible values are:
|
||||
|
archived_at
The time when the coupon was archived. |
||||
|
created_at
The time when the coupon was created. |
||||
|
currency_code
The currency code (ISO 4217 format) of the coupon. Applicable for |
||||
|
discount_amount
When |
||||
|
discount_percentage
When |
||||
|
discount_type
The type of discount. Possible values are:
|
||||
|
duration_month
When |
||||
|
duration_type
The duration the coupon is applicable. Possible values are:
|
||||
|
invoice_name
The name of the invoice associated with the coupon. |
||||
|
invoice_notes
Invoice notes for the coupon. |
||||
|
item_constraint_criteria
This attribute will be present only if your Chargebee site uses v2.0 of Chargebee’s Product Catalog. Refer to the Table and field availability and Chargebee Product Catalogs section for more info.
|
||||
|
item_constraints
This attribute will be present only if your Chargebee site uses v2.0 of Chargebee’s Product Catalog. Refer to the Table and field availability and Chargebee Product Catalogs section for more info.
|
||||
|
max_redemptions
The maximum number of times the coupon can be redeemed. |
||||
|
meta_data
Additional info about the coupon. |
||||
|
name
The display name used in web interface for identifying the coupon. |
||||
|
object
|
||||
|
plan_constraint
This attribute will be present only if your Chargebee site uses v1.0 of Chargebee’s Product Catalog. Refer to the Table and field availability and Chargebee Product Catalogs section for more info. The plans the coupon can be applied to. Possible values are:
|
||||
|
plan_ids
This attribute will be present only if your Chargebee site uses v1.0 of Chargebee’s Product Catalog. Refer to the Table and field availability and Chargebee Product Catalogs section for more info. A list of IDs of plans associated with the coupon.
|
||||
|
redemptions
The number of times the coupon has been redeemed. |
||||
|
resource_version
The version number of the coupon. Each update of the coupon results in an incremental change of this value. Note: This attribute will be present only if the coupon has been updated after 2016-09-28. |
||||
|
status
The status of the coupon. Possible values are:
|
credit_notes
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updated_at |
|
Primary Key :
|
id |
API endpoint : |
The credit_notes table contains info about the credit notes in your Chargebee account. A credit note is a document that specifies the money owed by a business to a customer.
Note: This table is available for sites using any Chargebee Product Catalog version. Refer to the Table and field availability and Chargebee Product Catalogs section for more info.
|
id
The credit note ID. Reference:
|
|||||||||||||||||
|
updated_at
The time the credit note was last updated. |
|||||||||||||||||
|
allocations
Details about invoice allocations made from the credit note.
|
|||||||||||||||||
|
amount_allocated
The amount allocated to invoices. |
|||||||||||||||||
|
amount_available
The yet to be used credits of this credit note. |
|||||||||||||||||
|
amount_refunded
The refunds issued from this credit note. |
|||||||||||||||||
|
currency_code
The currency code (ISO 4217 format) for the credit note. |
|||||||||||||||||
|
customer_id
The ID of the customer associated with the credit note. Reference:
|
|||||||||||||||||
|
date
The date the credit note was issued. |
|||||||||||||||||
|
deleted
Indicates whether the credit note was deleted or not. |
|||||||||||||||||
|
discounts
Details about the discounts applied to the credit note.
|
|||||||||||||||||
|
line_item_discounts
The list of discount(s) applied for each line item of the invoice. |
|||||||||||||||||
|
line_item_taxes
The list of taxes applied on line items.
|
|||||||||||||||||
|
line_item_tiers
The list of tiers applicable for the line item.
|
|||||||||||||||||
|
line_items
The line items in the credit note.
|
|||||||||||||||||
|
linked_refunds
Details about refunds issued from the credit note.
|
|||||||||||||||||
|
price_type
The price type of the credit note. Possible values are:
|
|||||||||||||||||
|
reason_code
The reason for issuing the credit note. Possible values include:
|
|||||||||||||||||
|
reference_invoice_id
The ID of the invoice against which the credit note is issued. Reference:
|
|||||||||||||||||
|
refunded_at
The time when the credit note was fully used. |
|||||||||||||||||
|
resource_version
The version number of the credit note. Each update of the credit note results in an incremental change of this value. Note: This attribute will be present only if the credit note has been updated after 2016-09-28. |
|||||||||||||||||
|
round_off_amount
The credit note rounded-off amount, in cents. |
|||||||||||||||||
|
status
The status of the credit note. Possible values include:
|
|||||||||||||||||
|
sub_total
The credit note subtotal, in cents. |
|||||||||||||||||
|
subscription_id
The ID of the subscription associated with the credit note. Reference:
|
|||||||||||||||||
|
taxes
The tax lines of the credit note.
|
|||||||||||||||||
|
total
The total credit amount in cents. |
|||||||||||||||||
|
type
The credit note type. Possible values are:
|
|||||||||||||||||
|
vat_number
The VAT number of the customer for whom the credit note is raised. |
|||||||||||||||||
|
voided_at
The time when the credit note was voided. |
customers
| Replication Method : |
Key-based Incremental |
Replication Key :
|
updated_at |
|
Primary Key :
|
id |
API endpoint : |
The customers table contains info about the customers in your Chargebee account.
Note: This table is available for sites using any Chargebee Product Catalog version. Refer to the Table and field availability and Chargebee Product Catalogs section for more info.
|
id
The customer ID. Reference:
|
||||||||||||||
|
updated_at
The time the customer was last updated. |
||||||||||||||
|
allow_direct_debit
Indicates whether the customer can pay via direct debit or not. |
||||||||||||||
|
auto_collection
Indicates whether payments need to be automatically collected for the customer. Possible values are:
|
||||||||||||||
|
backup_payment_source_id
|
||||||||||||||
|
balances
The list of balances for the customer.
|
||||||||||||||
|
billing_address
The billing address for the customer.
|
||||||||||||||
|
billing_date
Applicable when calendar billing (with customer specific billing date support) is enabled. When set, renewals of all the monthly and yearly subscriptions of this customer will be aligned to this date. |
||||||||||||||
|
billing_date_mode
Indicates whether this customer’s Possible values are:
|
||||||||||||||
|
billing_day_of_week
Applicable when calendar billing (with customer specific billing date support) is enabled. When set, renewals of all the weekly subscriptions of this customer will be aligned to this week day. Possible values are:
|
||||||||||||||
|
billing_day_of_week_mode
Indicates whether this customer’s Possible values are:
|
||||||||||||||
|
card_status
|
||||||||||||||
|
cf_company_id
|
||||||||||||||
|
company
The name of the company associated with the customer. |
||||||||||||||
|
consolidated_invoicing
Applicable when consolidated invoicing is enabled. Indicates whether invoice consolidation should happen during subscription renewals. Needs to be set only if this value is different from the defaults configured. |
||||||||||||||
|
contacts
A list of contacts associated with the customer.
|
||||||||||||||
|
created_at
The time the customer was created. |
||||||||||||||
|
created_from_ip
The IP address of the customer. |
||||||||||||||
|
custom_fields
|
||||||||||||||
|
customer_type
Applicable if you use Chargebee’s AvaTax for Sales integration.. The type of the customer. Possible values are:
|
||||||||||||||
|
deleted
Indicates whether the customer has been deleted or not. |
||||||||||||||
|
email
The customer’s email address. |
||||||||||||||
|
entity_code
Applicable if you use Chargebee’s AvaTax for Sales integration.. The exemption category of the customer, for USA and Canada. |
||||||||||||||
|
excess_payments
The total unused payments associated with the customer. |
||||||||||||||
|
exemption_details
Applicable if you use Chargebee’s AvaTax for Sales integration.. Exemption information for the customer. |
||||||||||||||
|
exempt_number
Applicable if you use Chargebee’s AvaTax for Sales integration.. Indicates if sales should be exempted for the customer. |
||||||||||||||
|
first_name
The first name of the customer. |
||||||||||||||
|
fraud_flag
Indicates if the customer has been identified as fraudulent. Possible values are:
|
||||||||||||||
|
invoice_notes
Invoice notes associated with the customer. |
||||||||||||||
|
is_location_valid
Indicates if the customer’s location is valid, based on their IP address and the card issuing country. Applicable only for EU, New Zealand, and Australia. |
||||||||||||||
|
last_name
The last name of the customer. |
||||||||||||||
|
locale
Determines which region-specific language Chargebee uses to communicate with the customer. |
||||||||||||||
|
meta_data
Additional info about the customer. |
||||||||||||||
|
net_term_days
The number of days within which the customer has to make payment for invoices. |
||||||||||||||
|
object
|
||||||||||||||
|
payment_method
The primary payment source for the customer.
|
||||||||||||||
|
phone
The customer’s phone number. |
||||||||||||||
|
pii_cleared
Indicates whether the customer’s personal info has been cleared. Possible values are:
|
||||||||||||||
|
preferred_currency_code
Applicable if the Chargebee Multicurrency feature is enabled. The currency code of the customer’s preferred currency (ISO 4217 format). |
||||||||||||||
|
primary_payment_source_id
The ID of the primary payment source for the customer. Reference: |
||||||||||||||
|
promotional_credits
The promotional credits balance of the customer. |
||||||||||||||
|
referral_urls
A list of referral URLs for the customer.
|
||||||||||||||
|
refundable_credits
The refundable credits balance of the customer. |
||||||||||||||
|
registered_for_gst
Indicates if the customer is registered under GST. Available for Australia only. |
||||||||||||||
|
relationship
|
||||||||||||||
|
resource_version
The version number of the customer. Each update of the customer results in an incremental change of this value. Note: This attribute will be present only if the customer has been updated after 2016-09-28. |
||||||||||||||
|
taxability
Indicates if the customer is liable for tax. Possible values are:
|
||||||||||||||
|
unbilled_charges
The total unbilled charges for the customer. |
||||||||||||||
|
vat_number
The VAT number for the customer. |
||||||||||||||
|
vat_number_status
Applicable only if EU and Australian taxes are configured and the VAT number validation is enabled. Possible values are:
|
events
| Replication Method : |
Key-based Incremental |
Replication Key :
|
occurred_at |
|
Primary Key :
|
id |
API endpoint : |
The events table contains info about the events that have occurred on your Chargebee site. Event records contain data about affected resources and additional details, such as when the change occurred. This can be used to create a log of events for a record and analyze how it has changed over time.
Note: This table is available for sites using any Chargebee Product Catalog version. Refer to the Table and field availability and Chargebee Product Catalogs section for more info.
|
id
The event ID. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
occurred_at
The time the event occurred. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
api_version
The Chargebee API version used for rendering the event content. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
content
The data associated with the event.
|