Skip to main content
Connectors

Chargebee connector

Set up the Chargebee connector in Kaivo: authentication, configuration, the 27 BigQuery tables it syncs, and answers to common questions.

Written By Lauri Raivio

Last updated 16 days ago

Kaivo is a fully managed data platform that syncs your Chargebee data into a Google BigQuery warehouse and keeps it up to date automatically. There is no pipeline to build and no infrastructure to run, so you can spend your time analysing your payment and finance data instead of moving it.

What is the Chargebee connector

Sync your Chargebee subscriptions, invoices, and customers into BigQuery with Kaivo to track recurring revenue and churn alongside the rest of your business.

CategoryFinance & Payments
AuthenticationAPI key
SetupSelf-service

Getting started with the Chargebee connector

  1. Sign up for Kaivo and create a workspace.
  2. Connect your Chargebee account.
  3. Choose which tables to sync.
  4. Wait for the initial sync to finish.
  5. Query your data in BigQuery or your favourite AI or BI tool.

Authenticating Chargebee

Authenticate with your API Key.

FieldDescription
API Key

Your Chargebee API Key.

Configuring the Chargebee connector

When you set up the connector, you provide:

FieldDescription
Site

The site prefix for your Chargebee instance.

Start Date

Any data before this date will not be fetched.

Product Catalog

Your Chargebee Product Catalog version. Find this under the API Version section in your Chargebee API settings.

Tables and columns synced from Chargebee

Kaivo syncs 27 tables from Chargebee into a dedicated dataset in your BigQuery warehouse. Click any table to see its columns and types.

ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
typeSTRINGType of addon.
descriptionSTRINGDescription of the addon.
accounting_category1STRINGFirst accounting category for the addon.
accounting_category2STRINGSecond accounting category for the addon.
accounting_category3STRINGThird accounting category for the addon.
accounting_category4STRINGFourth accounting category for the addon.
accounting_codeSTRINGAccounting code for the addon.
archived_atINT64Timestamp indicating when the addon was archived.
avalara_sale_typeSTRINGAvalara sale type for tax calculation.
avalara_service_typeINT64Avalara service type for tax calculation.
avalara_transaction_typeINT64Avalara transaction type for tax calculation.
channelSTRINGChannel for which the addon is applicable.
charge_typeSTRINGType of charge for the addon.
currency_codeSTRINGCurrency code for the addon pricing.
enabled_in_portalBOOLIndicator for whether the addon is enabled in the customer portal.
idSTRINGUnique identifier for the addon.
included_in_mrrBOOLIndicator for whether the addon is included in Monthly Recurring Revenue (MRR).
invoice_nameSTRINGName to be displayed on the invoice for the addon.
invoice_notesSTRINGAdditional notes to include on the invoice for the addon.
is_shippableBOOLIndicator for whether the addon is shippable.
nameSTRINGName of the addon.
objectSTRINGType of object, in this case, addon.
periodINT64Duration of the addon period.
period_unitSTRINGUnit of duration for the addon period.
... and 17 more columns

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • addon__custom_fields (5 columns)
  • addon__tiers (9 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
typeSTRINGType of the attached item.
billing_cyclesINT64Number of billing cycles associated with the attached item.
charge_on_eventSTRINGIndicates when the attached item should be charged.
charge_onceBOOLFlag to determine if the attached item should be charged only once.
created_atINT64Timestamp when the attached item was created.
idSTRINGUnique identifier for the attached item.
item_idSTRINGIdentifier of the item to which this attached item belongs.
objectSTRINGType of object representing the attached item.
parent_item_idSTRINGIdentifier of the parent item to which this attached item is attached.
quantityINT64Quantity of the attached item included in the parent item.
quantity_in_decimalSTRINGQuantity of the attached item in decimal format.
resource_versionINT64Version of the attached item resource for tracking changes.
statusSTRINGCurrent status of the attached item.
updated_atINT64Timestamp when the attached item was last updated.
_kaivo_extracted_atTIMESTAMPTimestamp that shows when the row was extracted. Auto-generated by Kaivo.

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • attached_item__custom_fields (5 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
typeSTRINGThe type or category of the comment (e.g., general, issue).
added_bySTRINGThe user who added the comment.
created_atINT64The timestamp indicating when the comment was created.
entity_idSTRINGThe unique identifier of the entity the comment is associated with.
entity_typeSTRINGThe type of entity (e.g., customer, invoice) that the comment is related to.
idSTRINGThe unique identifier of the comment.
notesSTRINGThe actual content of the comment or notes added.
objectSTRINGThe object to which the comment is attached.
_kaivo_extracted_atTIMESTAMPTimestamp that shows when the row was extracted. Auto-generated by Kaivo.

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • comment__custom_fields (5 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
customer_idSTRINGThe unique identifier of the customer associated with the contact.
emailSTRINGEmail address of the contact.
enabledBOOLIndicates whether the contact is currently enabled or disabled.
first_nameSTRINGFirst name of the contact.
idSTRINGUnique identifier of the contact.
labelSTRINGA label assigned to the contact for easy identification.
last_nameSTRINGLast name of the contact.
objectSTRINGType of object, in this case, it will be 'contact'.
phoneSTRINGPhone number of the contact.
send_account_emailBOOLIndicates whether account-related emails are enabled for the contact.
send_billing_emailBOOLIndicates whether billing-related emails are enabled for the contact.
_kaivo_extracted_atTIMESTAMPTimestamp that shows when the row was extracted. Auto-generated by Kaivo.

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • contact__custom_fields (5 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
apply_discount_onSTRINGDetermines where the discount is applied on (e.g. subtotal, total).
apply_onSTRINGSpecify on what type of items the coupon applies (e.g. subscription, addon).
archived_atINT64Timestamp when the coupon was archived.
created_atINT64Timestamp of the coupon creation.
currency_codeSTRINGThe currency code for the coupon (e.g. USD, EUR).
discount_amountINT64The fixed discount amount applied by the coupon.
discount_percentageFLOAT64Percentage discount applied by the coupon.
discount_quantityINT64Specifies the number of free units provided for the item price, without affecting the total quantity sold. This parameter is applicable only when the discount_type is set to offer_quantity.
discount_typeSTRINGType of discount (e.g. fixed, percentage).
duration_monthINT64Duration of the coupon in months.
duration_typeSTRINGType of duration (e.g. forever, one-time).
idSTRINGUnique identifier for the coupon.
invoice_nameSTRINGName displayed on invoices when the coupon is used.
invoice_notesSTRINGAdditional notes displayed on invoices when the coupon is used.
max_redemptionsINT64Maximum number of times the coupon can be redeemed.
nameSTRINGName of the coupon.
objectSTRINGType of object (usually 'coupon').
periodINT64Duration or frequency for which the coupon is valid.
period_unitSTRINGUnit of the period (e.g. days, weeks).
redemptionsINT64Number of times the coupon has been redeemed.
resource_versionINT64Version of the resource.
statusSTRINGCurrent status of the coupon (e.g. active, inactive).
updated_atINT64Timestamp when the coupon was last updated.
valid_tillINT64Date until which the coupon is valid for use.
... and 1 more columns

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • coupon__coupon_constraints (6 columns)
  • coupon__custom_fields (5 columns)
  • coupon__item_constraint_criteria (4 columns)
  • coupon__item_constraint_criteria__currencies (4 columns)
  • coupon__item_constraint_criteria__item_family_ids (4 columns)
  • coupon__item_constraint_criteria__item_price_periods (4 columns)
  • coupon__item_constraints (5 columns)
  • coupon__item_constraints__item_price_ids (4 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
typeSTRINGThe type of credit note.
amount_allocatedINT64The amount of credits allocated.
amount_availableINT64The amount of credits available.
amount_refundedINT64The amount of credits refunded.
base_currency_codeSTRINGThe base currency code for the credit note.
billing_address__citySTRINGThe city in the billing address
billing_address__companySTRINGThe company name in the billing address
billing_address__countrySTRINGThe country in the billing address
billing_address__emailSTRINGThe email address in the billing address
billing_address__first_nameSTRINGThe first name in the billing address
billing_address__last_nameSTRINGThe last name in the billing address
billing_address__line1STRINGThe first line of the address
billing_address__line2STRINGThe second line of the address
billing_address__line3STRINGThe third line of the address
billing_address__objectSTRINGThe object type
billing_address__phoneSTRINGThe phone number in the billing address
billing_address__stateSTRINGThe state in the billing address
billing_address__state_codeSTRINGThe state code in the billing address
billing_address__validation_statusSTRINGThe validation status of the address
billing_address__zipSTRINGThe zip code in the billing address
business_entity_idSTRINGThe ID of the business entity associated with the credit note.
channelSTRINGThe channel through which the credit note was created.
create_reason_codeSTRINGThe reason code for creating the credit note.
currency_codeSTRINGThe currency code for the credit note.
... and 43 more columns

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • credit_note__allocations (8 columns)
  • credit_note__custom_fields (5 columns)
  • credit_note__discounts (7 columns)
  • credit_note__line_item_discounts (7 columns)
  • credit_note__line_item_taxes (15 columns)
  • credit_note__line_item_tiers (12 columns)
  • credit_note__line_items (28 columns)
  • credit_note__linked_refunds (10 columns)
  • credit_note__linked_tax_withheld_refunds (8 columns)
  • credit_note__taxes (6 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
allow_direct_debitBOOLIndicates if direct debit is allowed for the customer.
auto_close_invoicesBOOLFlag to automatically close invoices for the customer.
auto_collectionSTRINGConfigures the automatic collection settings for the customer.
backup_payment_source_idSTRINGID of the backup payment source for the customer.
billing_address__citySTRINGCity in the billing address.
billing_address__companySTRINGCompany name in the billing address.
billing_address__countrySTRINGCountry in the billing address.
billing_address__emailSTRINGEmail address for billing communication.
billing_address__first_nameSTRINGFirst name in the billing address.
billing_address__last_nameSTRINGLast name in the billing address.
billing_address__line1STRINGAddress line 1 in the billing address.
billing_address__line2STRINGAddress line 2 in the billing address.
billing_address__line3STRINGAddress line 3 in the billing address.
billing_address__objectSTRINGObject type for billing address.
billing_address__phoneSTRINGPhone number for billing contact.
billing_address__stateSTRINGState in the billing address.
billing_address__state_codeSTRINGState code in the billing address.
billing_address__validation_statusSTRINGValidation status of the billing address.
billing_address__zipSTRINGZip code in the billing address.
billing_dateINT64Date for billing cycle.
billing_date_modeSTRINGMode for billing date calculation.
billing_day_of_weekSTRINGDay of the week for billing cycle.
billing_day_of_week_modeSTRINGMode for billing day of the week calculation.
billing_monthINT64Month for billing cycle.
... and 62 more columns

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • customer__balances (10 columns)
  • customer__contacts (13 columns)
  • customer__custom_fields (5 columns)
  • customer__exemption_details (3 columns)
  • customer__referral_urls (11 columns)
  • customer__tax_providers_fields (4 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
created_atINT64The timestamp when the differential price data was created.
currency_codeSTRINGThe currency code associated with the differential price data.
idSTRINGThe unique identifier for the differential price data.
item_price_idSTRINGThe identifier of the item price related to the differential price.
modified_atINT64The timestamp when the differential price data was last modified.
objectSTRINGThe object type which this data represents.
parent_item_idSTRINGThe ID of the parent item linked to this differential price data.
priceINT64The price value of the differential price.
price_in_decimalSTRINGThe price value in decimal format for precise calculations.
resource_versionINT64The version of the resource for tracking changes.
statusSTRINGThe status of the differential price data (e.g., active, inactive).
updated_atINT64The timestamp when the differential price data was last updated.
_kaivo_extracted_atTIMESTAMPTimestamp that shows when the row was extracted. Auto-generated by Kaivo.

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • differential_price__custom_fields (5 columns)
  • differential_price__parent_periods (4 columns)
  • differential_price__parent_periods__period (4 columns)
  • differential_price__tiers (6 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
api_versionSTRINGThe version of the Chargebee API being used to fetch the event data.
event_typeSTRINGThe type or category of the event.
idSTRINGUnique identifier for the event data record.
objectSTRINGThe object or entity that the event is triggered for.
occurred_atINT64The datetime when the event occurred.
sourceSTRINGThe source or origin of the event data.
userSTRINGInformation about the user or entity associated with the event.
webhook_statusSTRINGThe status of the webhook execution for the event.
_kaivo_extracted_atTIMESTAMPTimestamp that shows when the row was extracted. Auto-generated by Kaivo.

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • event__custom_fields (5 columns)
  • event__webhooks (5 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
auto_claimBOOLIndicates if the gift is set to be automatically claimed by the recipient.
claim_expiry_dateINT64The date when the gift claim expires.
gift_receiver__customer_idSTRINGThe ID of the customer who receives the gift.
gift_receiver__emailSTRINGEmail of the gift recipient.
gift_receiver__first_nameSTRINGFirst name of the gift recipient.
gift_receiver__last_nameSTRINGLast name of the gift recipient.
gift_receiver__objectSTRINGType of object representing the gift receiver.
gift_receiver__subscription_idSTRINGThe ID of the subscription associated with the gift receiver.
gifter__customer_idSTRINGThe ID of the customer who sent the gift.
gifter__invoice_idSTRINGThe ID of the invoice associated with the gift.
gifter__noteSTRINGAny note attached to the gift from the sender.
gifter__objectSTRINGType of object representing the gift sender.
gifter__signatureSTRINGSignature or identifier of the gift sender.
idSTRINGUnique ID of the gift.
no_expiryBOOLIndicates if the gift has no expiry.
objectSTRINGType of object representing the gift.
resource_versionINT64Version of the resource related to the gift.
scheduled_atINT64Timestamp indicating when the gift is scheduled.
statusSTRINGStatus of the gift.
updated_atINT64Timestamp of when the gift data was last updated.
_kaivo_extracted_atTIMESTAMPTimestamp that shows when the row was extracted. Auto-generated by Kaivo.

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • gift__custom_fields (5 columns)
  • gift__gift_timelines (6 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
typeSTRINGType of hosted page (e.g., checkout, subscription).
business_entity_idSTRINGThe ID of the business entity associated with the hosted page.
created_atINT64Timestamp indicating when the hosted page was created.
embedBOOLDetails about embedding the hosted page.
expires_atINT64Timestamp specifying the expiry date of the hosted page.
idSTRINGUnique identifier for the hosted page.
objectSTRINGIndicates the type of object, in this case, it would be 'hosted_page'.
pass_thru_contentSTRINGContent that is passed through to the hosted page.
resource_versionINT64Version of the hosted page resource.
stateSTRINGCurrent state of the hosted page (e.g., active, expired).
updated_atINT64Timestamp indicating the last update time of the hosted page.
urlSTRINGURL where the hosted page can be accessed.
_kaivo_extracted_atTIMESTAMPTimestamp that shows when the row was extracted. Auto-generated by Kaivo.

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • hosted_page__custom_fields (5 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
amount_adjustedINT64Total amount adjusted in the invoice
amount_dueINT64Amount due for payment
amount_paidINT64Amount already paid
amount_to_collectINT64Amount yet to be collected
base_currency_codeSTRINGCurrency code used as base for the invoice
billing_address__citySTRINGCity of the billing address
billing_address__companySTRINGCompany name in the billing address
billing_address__countrySTRINGCountry of the billing address
billing_address__emailSTRINGEmail address associated with the billing address
billing_address__first_nameSTRINGFirst name in the billing address
billing_address__last_nameSTRINGLast name in the billing address
billing_address__line1STRINGFirst line of the billing address
billing_address__line2STRINGSecond line of the billing address
billing_address__line3STRINGThird line of the billing address
billing_address__objectSTRINGType of object representing the billing address
billing_address__phoneSTRINGPhone number associated with the billing address
billing_address__stateSTRINGState of the billing address
billing_address__state_codeSTRINGState code of the billing address
billing_address__validation_statusSTRINGStatus of address validation
billing_address__zipSTRINGZIP code of the billing address
business_entity_idSTRINGID of the business entity
channelSTRINGChannel through which the invoice was generated
credits_appliedINT64Total credits applied to the invoice
currency_codeSTRINGCurrency code of the invoice
... and 64 more columns

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • invoice__adjustment_credit_notes (9 columns)
  • invoice__applied_credits (10 columns)
  • invoice__custom_fields (5 columns)
  • invoice__discounts (11 columns)
  • invoice__dunning_attempts (9 columns)
  • invoice__issued_credit_notes (9 columns)
  • invoice__line_item_discounts (9 columns)
  • invoice__line_item_taxes (18 columns)
  • invoice__line_item_tiers (13 columns)
  • invoice__line_items (27 columns)
  • invoice__linked_orders (11 columns)
  • invoice__linked_payments (9 columns)
  • invoice__linked_taxes_withheld (8 columns)
  • invoice__notes (6 columns)
  • invoice__taxes (6 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
typeSTRINGType of the item
descriptionSTRINGDescription of the item
archived_atINT64Date and time when the item was archived
channelSTRINGChannel the item belongs to
enabled_for_checkoutBOOLFlag indicating if the item is enabled for checkout
enabled_in_portalBOOLFlag indicating if the item is enabled in the portal
external_nameSTRINGName of the item in an external system
gift_claim_redirect_urlSTRINGURL to redirect for gift claim
idSTRINGUnique identifier for the item
included_in_mrrBOOLFlag indicating if the item is included in Monthly Recurring Revenue
is_giftableBOOLFlag indicating if the item is giftable
is_shippableBOOLFlag indicating if the item is shippable
item_applicabilitySTRINGApplicability of the item
item_family_idSTRINGID of the item's family
meteredBOOLFlag indicating if the item is metered
nameSTRINGName of the item
objectSTRINGType of object
redirect_urlSTRINGURL to redirect for the item
resource_versionINT64Version of the resource
statusSTRINGStatus of the item
unitSTRINGUnit associated with the item
updated_atINT64Date and time when the item was last updated
usage_calculationSTRINGCalculation method used for item usage
_kaivo_extracted_atTIMESTAMPTimestamp that shows when the row was extracted. Auto-generated by Kaivo.

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • item__applicable_items (4 columns)
  • item__custom_fields (5 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
descriptionSTRINGA brief description of the item family.
channelSTRINGThe channel associated with the item family.
idSTRINGThe unique identifier for the item family.
nameSTRINGThe name of the item family.
objectSTRINGThe type of object, in this case, 'item_family'.
resource_versionINT64The resource version of the item family data.
statusSTRINGThe status of the item family.
updated_atINT64The timestamp when the item family was last updated.
_kaivo_extracted_atTIMESTAMPTimestamp that shows when the row was extracted. Auto-generated by Kaivo.

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • item_family__custom_fields (5 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
descriptionSTRINGDescription of the item.
accounting_detail__accounting_category1STRINGThe first accounting category.
accounting_detail__accounting_category2STRINGThe second accounting category.
accounting_detail__accounting_category3STRINGThe third accounting category.
accounting_detail__accounting_category4STRINGThe fourth accounting category.
accounting_detail__accounting_codeSTRINGThe accounting code associated with the item.
accounting_detail__skuSTRINGStock Keeping Unit (SKU) code of the item.
archived_atINT64Date and time when the item was archived.
billing_cyclesINT64Number of billing cycles for the item.
channelSTRINGThe channel through which the item is sold.
created_atINT64Date and time when the item was created.
currency_codeSTRINGThe currency code used for pricing the item.
external_nameSTRINGExternal name of the item.
free_quantityINT64Free quantity allowed for the item.
free_quantity_in_decimalSTRINGFree quantity allowed represented in decimal format.
idSTRINGUnique identifier for the item.
invoice_notesSTRINGNotes to be included in the invoice for the item.
is_taxableBOOLFlag indicating whether the item is taxable.
item_family_idSTRINGIdentifier for the item family to which the item belongs.
item_idSTRINGUnique identifier for the item.
item_typeSTRINGType of the item (e.g., product, service).
nameSTRINGName of the item.
objectSTRINGObject type representing the item.
periodINT64Duration of the item's billing period.
... and 21 more columns

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • item_price__custom_fields (5 columns)
  • item_price__tiers (6 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
amount_adjustedINT64Adjusted amount for the order.
amount_paidINT64Amount paid for the order.
base_currency_codeSTRINGThe base currency code used for the order.
batch_idSTRINGUnique identifier for the batch the order belongs to.
billing_address__citySTRINGCity in the billing address.
billing_address__companySTRINGCompany name in the billing address.
billing_address__countrySTRINGCountry in the billing address.
billing_address__emailSTRINGEmail associated with the billing address.
billing_address__first_nameSTRINGFirst name in the billing address.
billing_address__last_nameSTRINGLast name in the billing address.
billing_address__line1STRINGFirst address line in the billing address.
billing_address__line2STRINGSecond address line in the billing address.
billing_address__line3STRINGThird address line in the billing address.
billing_address__objectSTRINGType of object representing the billing address.
billing_address__phoneSTRINGPhone number associated with the billing address.
billing_address__stateSTRINGState in the billing address.
billing_address__state_codeSTRINGState code of the billing address.
billing_address__validation_statusSTRINGValidation status of the billing address.
billing_address__zipSTRINGZip or postal code in the billing address.
business_entity_idSTRINGIdentifier for the business entity associated with the order.
cancellation_reasonSTRINGReason for order cancellation.
cancelled_atINT64Timestamp when the order was cancelled.
created_atINT64Timestamp when the order was created.
created_bySTRINGUser or system that created the order.
... and 59 more columns

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • order__custom_fields (5 columns)
  • order__line_item_discounts (9 columns)
  • order__line_item_taxes (15 columns)
  • order__linked_credit_notes (10 columns)
  • order__order_line_items (24 columns)
  • order__resent_orders (6 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
typeSTRINGType of payment source, e.g., card, bank_account
amazon_payment__agreement_idSTRINGUnique identifier for the Amazon payment agreement
amazon_payment__emailSTRINGEmail associated with the Amazon payment method
bank_account__account_holder_typeSTRINGType of account holder, e.g., individual or business
bank_account__account_typeSTRINGType of bank account, e.g., checking or savings
bank_account__bank_nameSTRINGName of the bank associated with the account
bank_account__echeck_typeSTRINGType of eCheck, if applicable
bank_account__emailSTRINGEmail associated with the bank account
bank_account__first_nameSTRINGFirst name of the account holder
bank_account__last4STRINGLast four digits of the bank account number
bank_account__last_nameSTRINGLast name of the account holder
bank_account__mandate_idSTRINGUnique identifier for the mandate related to the bank account
bank_account__name_on_accountSTRINGName on the bank account
business_entity_idSTRINGIdentifier for the business entity associated with the payment source
card__billing_addr1STRINGFirst line of the billing address
card__billing_addr2STRINGSecond line of the billing address
card__billing_citySTRINGCity of the billing address
card__billing_countrySTRINGCountry of the billing address
card__billing_stateSTRINGState of the billing address
card__billing_state_codeSTRINGState code of the billing address
card__billing_zipSTRINGZIP or postal code of the billing address
card__brandSTRINGBrand of the card, e.g., Visa, Mastercard
card__expiry_monthINT64Expiry month of the card
card__expiry_yearINT64Expiry year of the card
... and 27 more columns

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • payment_source__custom_fields (5 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
descriptionSTRINGDescription of the plan
accounting_category1STRINGThe first category for accounting purposes
accounting_category2STRINGThe second category for accounting purposes
accounting_category3STRINGThe third category for accounting purposes
accounting_category4STRINGThe fourth category for accounting purposes
accounting_codeSTRINGThe accounting code associated with the plan
addon_applicabilitySTRINGHow the add-ons are applicable to the plan
archived_atINT64Timestamp when the plan was archived
avalara_sale_typeSTRINGAvalara sale type for tax calculations
avalara_service_typeINT64Avalara service type for tax calculations
avalara_transaction_typeINT64Avalara transaction type for tax calculations
billing_cyclesINT64Number of billing cycles for the plan
channelSTRINGChannel associated with the plan
charge_modelSTRINGThe model used for charging
claim_urlSTRINGURL for claiming the plan
currency_codeSTRINGThe currency code used for pricing
enabled_in_hosted_pagesBOOLWhether the plan is enabled in hosted pages
enabled_in_portalBOOLWhether the plan is enabled in the portal
free_quantityINT64Free quantity included in the plan
free_quantity_in_decimalSTRINGDecimal free quantity included in the plan
giftableBOOLWhether the plan is giftable
idSTRINGThe ID of the plan
invoice_nameSTRINGName used in invoices
invoice_notesSTRINGNotes included in invoices
... and 26 more columns

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • plan__applicable_addons (4 columns)
  • plan__attached_addons (8 columns)
  • plan__custom_fields (5 columns)
  • plan__event_based_addons (8 columns)
  • plan__tiers (9 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
typeSTRINGThe category or classification of the promotional credit.
descriptionSTRINGAdditional information or notes about the promotional credit.
amountINT64The amount of promotional credit.
amount_in_decimalSTRINGThe decimal representation of the promotional credit amount.
closing_balanceINT64The closing balance after using promotional credit.
created_atINT64The timestamp when the promotional credit was created.
credit_typeSTRINGThe type of promotional credit.
currency_codeSTRINGThe currency code of the promotional credit.
customer_idSTRINGThe ID of the customer associated with the promotional credit.
done_bySTRINGThe user who initiated the use of promotional credit.
idSTRINGThe unique identifier of the promotional credit record.
objectSTRINGThe object type, usually 'credit'.
referenceSTRINGA reference related to the promotional credit.
_kaivo_extracted_atTIMESTAMPTimestamp that shows when the row was extracted. Auto-generated by Kaivo.

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • promotional_credit__custom_fields (5 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
versionINT64The version of the quote data.
amount_dueINT64The total amount that is due for payment in the quote.
amount_paidINT64The total amount that has been paid towards the quote.
billing_address__citySTRING
billing_address__companySTRING
billing_address__countrySTRING
billing_address__emailSTRING
billing_address__first_nameSTRING
billing_address__last_nameSTRING
billing_address__line1STRING
billing_address__line2STRING
billing_address__line3STRING
billing_address__objectSTRING
billing_address__phoneSTRING
billing_address__stateSTRING
billing_address__state_codeSTRING
billing_address__validation_statusSTRING
billing_address__zipSTRING
business_entity_idSTRINGThe ID of the business entity related to the quote.
charge_on_acceptanceINT64Whether the charge is applicable on acceptance of the quote.
contract_term_endINT64The end date of the contract terms for the quote.
contract_term_startINT64The start date of the contract terms for the quote.
contract_term_termination_feeINT64The fee applicable for terminating the contract terms.
credits_appliedINT64The credits applied to the quote amount.
... and 37 more columns

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • quote__custom_fields (5 columns)
  • quote__discounts (11 columns)
  • quote__line_item_discounts (8 columns)
  • quote__line_item_taxes (15 columns)
  • quote__line_item_tiers (12 columns)
  • quote__line_items (28 columns)
  • quote__notes (4 columns)
  • quote__taxes (6 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
versionINT64The version of the quote line group.
amount_dueINT64The total amount that is due for payment.
amount_paidINT64The total amount that has been paid.
billing_cycle_numberINT64The number indicating the current billing cycle.
charge_eventSTRINGDetails about the charge event associated with the quote line group.
credits_appliedINT64The amount of credits applied to the quote line group.
idSTRINGUnique identifier for the quote line group.
objectSTRINGType of object representing the quote line group.
quote_idSTRINGUnique identifier for the quote associated with the line group.
sub_totalINT64The subtotal amount of the quote line group.
totalINT64The total amount for the quote line group after all calculations.
_kaivo_extracted_atTIMESTAMPTimestamp that shows when the row was extracted. Auto-generated by Kaivo.

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • quote_line_group__custom_fields (5 columns)
  • quote_line_group__discounts (11 columns)
  • quote_line_group__line_item_discounts (8 columns)
  • quote_line_group__line_item_taxes (15 columns)
  • quote_line_group__line_items (28 columns)
  • quote_line_group__taxes (6 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
entity_idSTRINGID of the entity being migrated at the current site.
entity_id_at_other_siteSTRINGID of the entity at the other site where migration occurred.
entity_typeSTRINGType of entity being migrated (e.g., customer, subscription).
migrated_atINT64Timestamp indicating when the migration took place.
objectSTRINGType of object being migrated (e.g., user, data).
other_site_nameSTRINGName of the site from which the entity was migrated.
statusSTRINGCurrent status of the site migration process.
_kaivo_extracted_atTIMESTAMPTimestamp that shows when the row was extracted. Auto-generated by Kaivo.

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • site_migration_detail__custom_fields (5 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
activated_atINT64The date and time when the subscription was activated.
affiliate_tokenSTRINGThe affiliate token associated with the subscription.
auto_close_invoicesBOOLDefines if the invoices are automatically closed or not.
auto_collectionSTRINGIndicates if auto-collection is enabled for the subscription.
base_currency_codeSTRINGThe base currency code used for the subscription.
billing_periodINT64The billing period duration for the subscription.
billing_period_unitSTRINGThe unit of the billing period.
business_entity_idSTRINGThe ID of the business entity to which the subscription belongs.
cancel_reasonSTRINGThe reason for the cancellation of the subscription.
cancel_reason_codeSTRINGThe code associated with the cancellation reason.
cancel_schedule_created_atINT64The date and time when the cancellation schedule was created.
cancelled_atINT64The date and time when the subscription was cancelled.
channelSTRINGThe channel through which the subscription was acquired.
contract_term__action_at_term_endSTRINGThe action to be taken at the end of the contract term.
contract_term__billing_cycleINT64The billing cycle duration of the contract.
contract_term__cancellation_cutoff_periodINT64The period within which cancellation is allowed before the next term.
contract_term__contract_endINT64The end date of the contract.
contract_term__contract_startINT64The start date of the contract.
contract_term__created_atINT64The timestamp when the contract term was created.
contract_term__idSTRINGThe unique identifier of the contract term.
contract_term__remaining_billing_cyclesINT64The remaining billing cycles for the contract term.
contract_term__statusSTRINGThe status of the contract term.
contract_term__subscription_idSTRINGThe identifier of the subscription associated with the contract term.
contract_term__total_contract_valueINT64The total value of the contract.
... and 78 more columns

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • subscription__addons (12 columns)
  • subscription__charged_event_based_addons (5 columns)
  • subscription__charged_items (6 columns)
  • subscription__coupons (9 columns)
  • subscription__custom_fields (5 columns)
  • subscription__discounts (20 columns)
  • subscription__event_based_addons (10 columns)
  • subscription__item_tiers (11 columns)
  • subscription__subscription_items (20 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
activated_atINT64The date and time when the subscription was activated.
affiliate_tokenSTRINGThe affiliate token associated with the subscription.
auto_close_invoicesBOOLDefines if the invoices are automatically closed or not.
auto_collectionSTRINGIndicates if auto-collection is enabled for the subscription.
base_currency_codeSTRINGThe base currency code used for the subscription.
billing_periodINT64The billing period duration for the subscription.
billing_period_unitSTRINGThe unit of the billing period.
business_entity_idSTRINGThe ID of the business entity to which the subscription belongs.
cancel_reasonSTRINGThe reason for the cancellation of the subscription.
cancel_reason_codeSTRINGThe code associated with the cancellation reason.
cancel_schedule_created_atINT64The date and time when the cancellation schedule was created.
cancelled_atINT64The date and time when the subscription was cancelled.
channelSTRINGThe channel through which the subscription was acquired.
contract_term__action_at_term_endSTRINGThe action to be taken at the end of the contract term.
contract_term__billing_cycleINT64The billing cycle duration of the contract.
contract_term__cancellation_cutoff_periodINT64The period within which cancellation is allowed before the next term.
contract_term__contract_endINT64The end date of the contract.
contract_term__contract_startINT64The start date of the contract.
contract_term__created_atINT64The timestamp when the contract term was created.
contract_term__idSTRINGThe unique identifier of the contract term.
contract_term__remaining_billing_cyclesINT64The remaining billing cycles for the contract term.
contract_term__statusSTRINGThe status of the contract term.
contract_term__subscription_idSTRINGThe identifier of the subscription associated with the contract term.
contract_term__total_contract_valueINT64The total value of the contract.
... and 78 more columns

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • subscription_with_scheduled_changes__addons (12 columns)
  • subscription_with_scheduled_changes__charged_event_based_addons (5 columns)
  • subscription_with_scheduled_changes__charged_items (6 columns)
  • subscription_with_scheduled_changes__coupons (9 columns)
  • subscription_with_scheduled_changes__custom_fields (5 columns)
  • subscription_with_scheduled_changes__discounts (20 columns)
  • subscription_with_scheduled_changes__event_based_addons (10 columns)
  • subscription_with_scheduled_changes__item_tiers (11 columns)
  • subscription_with_scheduled_changes__subscription_items (20 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
typeSTRINGType of the transaction.
amountINT64The total amount of the transaction.
amount_capturableINT64The remaining amount that can be captured in the transaction.
amount_unusedINT64The amount in the transaction that remains unused.
authorization_reasonSTRINGReason for authorization of the transaction.
base_currency_codeSTRINGThe base currency code of the transaction.
business_entity_idSTRINGThe ID of the business entity related to the transaction.
cn_create_reason_codeSTRINGReason code for creating a credit note.
cn_dateINT64Date of the credit note.
cn_reference_invoice_idSTRINGID of the invoice referenced in the credit note.
cn_statusSTRINGStatus of the credit note.
cn_totalINT64Total amount of the credit note.
currency_codeSTRINGThe currency code of the transaction.
customer_idSTRINGThe ID of the customer associated with the transaction.
dateINT64Date of the transaction.
deletedBOOLFlag indicating if the transaction is deleted.
error_codeSTRINGError code associated with the transaction.
error_detailSTRINGDetailed error information related to the transaction.
error_textSTRINGError message text of the transaction.
exchange_rateFLOAT64Exchange rate used in the transaction.
fraud_flagSTRINGFlag indicating if the transaction is flagged for fraud.
fraud_reasonSTRINGReason for flagging the transaction as fraud.
gatewaySTRINGThe payment gateway used in the transaction.
gateway_account_idSTRINGID of the gateway account used in the transaction.
... and 27 more columns

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • transaction__custom_fields (5 columns)
  • transaction__linked_credit_notes (7 columns)
  • transaction__linked_invoices (9 columns)
  • transaction__linked_payments (5 columns)
  • transaction__linked_refunds (5 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
descriptionSTRINGDescription of the unbilled charge
amountINT64Total amount of the unbilled charge
amount_in_decimalSTRINGTotal amount in decimal format of the unbilled charge
currency_codeSTRINGCurrency code of the amount
customer_idSTRINGID of the customer associated with the unbilled charge
date_fromINT64Start date of the charge period
date_toINT64End date of the charge period
deletedBOOLFlag to indicate if the charge has been deleted
discount_amountINT64Amount of any discounts applied to the charge
entity_idSTRINGID of the entity related to the charge
entity_typeSTRINGType of entity related to the charge
idSTRINGUnique ID of the unbilled charge
is_advance_chargeBOOLFlag to indicate if the charge is an advance charge
is_voidedBOOLFlag to indicate if the charge has been voided
objectSTRINGType of object representing the unbilled charge
pricing_modelSTRINGPricing model used for the charge
quantityINT64Quantity of units for the charge
quantity_in_decimalSTRINGQuantity of units in decimal format for the charge
subscription_idSTRINGID of the subscription associated with the charge
tiers__ending_unitINT64Ending unit for the tier pricing
tiers__ending_unit_in_decimalSTRINGEnding unit in decimal format for the tier pricing
tiers__quantity_usedINT64Quantity of units used in the tier
tiers__quantity_used_in_decimalSTRINGQuantity of units used in decimal format in the tier
tiers__starting_unitINT64Starting unit for the tier pricing
... and 8 more columns

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • unbilled_charge__custom_fields (5 columns)
ColumnTypeDescription
_kaivo_idSTRINGPrimary key that uniquely identifies the row. Auto-generated by Kaivo.
account_numberSTRINGThe virtual bank account number associated with the customer
bank_nameSTRINGThe name of the bank of the virtual bank account
created_atINT64The date and time when the virtual bank account was created
customer_idSTRINGThe unique identifier of the customer associated with the virtual bank account
deletedBOOLFlag indicating if the virtual bank account has been deleted
emailSTRINGThe email address associated with the customer's virtual bank account
gatewaySTRINGThe payment gateway used for processing transactions with this virtual bank account
idSTRINGThe unique identifier of the virtual bank account
reference_idSTRINGA reference identifier linked to the virtual bank account
resource_versionINT64The version of the virtual bank account resource
routing_numberSTRINGThe routing number associated with the virtual bank account
schemeSTRINGThe scheme or type of the virtual bank account
swift_codeSTRINGThe SWIFT code associated with the virtual bank account
updated_atINT64The date and time when the virtual bank account was last updated
_kaivo_extracted_atTIMESTAMPTimestamp that shows when the row was extracted. Auto-generated by Kaivo.

Nested subtables

Repeating fields are split into their own tables, listed here with their column counts.

  • virtual_bank_account__custom_fields (5 columns)

How the Chargebee sync works

After the first load, Kaivo keeps your BigQuery warehouse up to date for you. Where Chargebee supports it, each sync pulls only new and changed records so it stays fast; otherwise it refreshes the whole table. Every record keeps its original ID, so you won't get duplicate rows.

Frequently asked questions

How long does the initial sync take for Chargebee?

It depends on how much history is in your Chargebee account. Most initial syncs finish within minutes, while large accounts can take a few hours. After that, syncs only fetch new and changed records, so they're much faster.

Can I sync only some tables or columns?

Yes. You pick which tables to sync when you set up the connection and can change the selection later. Tables you don't select are never copied to your warehouse.

What happens when Chargebee's schema changes?

New fields are never added automatically. You choose which fields to sync, so data you haven't selected (sensitive personal data, for example) never lands in your warehouse. When a new field appears, it becomes available for you to add. What happens to removed or renamed fields depends on a table's sync mode: full-refresh tables always match what's currently in Chargebee, so dropped fields disappear, while incremental tables keep their existing columns and history, so an old field stays and newly added fields fill in over time.

How do I handle GDPR or data deletion requests?

Your data lives in your own Kaivo-managed BigQuery warehouse, so the most direct option is to delete or anonymise specific records right in BigQuery. If you delete data in Chargebee instead, full-refresh tables drop it on the next sync, while incremental tables keep it, so you would remove the row in BigQuery or ask us to run a full refresh. To remove everything, delete the Chargebee connector in Kaivo and all of its synced data is deleted with it.

Common use cases for Chargebee data

MRR and churn

Combine subscriptions, invoices, and plans to track recurring revenue, upgrades, and churn over time.

Customer value

Analyse customers with their invoices and credit_notes to measure lifetime value and refunds.

Plan performance

Use plan and item_price to see which plans and add-ons drive the most revenue.

Coupon impact

Report on coupon usage to measure how discounts affect revenue.

Use Chargebee data in your AI and BI tools

Once Chargebee data lands in your Kaivo-managed BigQuery warehouse, you can explore it with AI tools or any BI tool that connects to BigQuery. Here's how the most common destinations work with Chargebee data.

Claude

Use Kaivo's MCP server to give Claude secure, workspace-scoped access to your data. Setup guide →

Power BI

Microsoft's BI tool with a native BigQuery connector. Supports direct query and scheduled refresh. Setup guide →

Data Studio

Free Google BI tool with native BigQuery support. One-click connection to your Kaivo warehouse; great for SMB teams on Google Workspace. Setup guide →

Tableau

The premium analytics standard, with native BigQuery integration. Setup guide →

Google Sheets

Use Connected Sheets to query BigQuery directly from a spreadsheet, with no SQL. Setup guide →

Excel

Connect via Power Query's BigQuery connector. Setup guide →

Metabase

Open-source BI tool with strong BigQuery support. Setup guide →

See our pricing page for Chargebee connector pricing and plan details.

Was this helpful?

Still need help? Share an idea