Skip to content
Book a demoStart free
Connectors

Chargebee connector

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

Chargebee connector pricing, tier and credits on kaivo.io

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.

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

Section titled “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.

Authenticate with your API Key.

Field Description
API Key
Your Chargebee API Key.

|

When you set up the connector, you provide:

Field Description
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.

|

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

addon (42 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
type STRING Type of addon.
description STRING Description of the addon.
accounting_category1 STRING First accounting category for the addon.
accounting_category2 STRING Second accounting category for the addon.
accounting_category3 STRING Third accounting category for the addon.
accounting_category4 STRING Fourth accounting category for the addon.
accounting_code STRING Accounting code for the addon.
archived_at INT64 Timestamp indicating when the addon was archived.
avalara_sale_type STRING Avalara sale type for tax calculation.
avalara_service_type INT64 Avalara service type for tax calculation.
avalara_transaction_type INT64 Avalara transaction type for tax calculation.
channel STRING Channel for which the addon is applicable.
charge_type STRING Type of charge for the addon.
currency_code STRING Currency code for the addon pricing.
enabled_in_portal BOOL Indicator for whether the addon is enabled in the customer portal.
id STRING Unique identifier for the addon.
included_in_mrr BOOL Indicator for whether the addon is included in Monthly Recurring Revenue (MRR).
invoice_name STRING Name to be displayed on the invoice for the addon.
invoice_notes STRING Additional notes to include on the invoice for the addon.
is_shippable BOOL Indicator for whether the addon is shippable.
name STRING Name of the addon.
object STRING Type of object, in this case, addon.
period INT64 Duration of the addon period.
period_unit STRING Unit of duration for the addon period.
… and 17 more columns

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

  • addon__custom_fields (5 columns)
  • addon__tiers (9 columns)
attached_item (16 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
type STRING Type of the attached item.
billing_cycles INT64 Number of billing cycles associated with the attached item.
charge_on_event STRING Indicates when the attached item should be charged.
charge_once BOOL Flag to determine if the attached item should be charged only once.
created_at INT64 Timestamp when the attached item was created.
id STRING Unique identifier for the attached item.
item_id STRING Identifier of the item to which this attached item belongs.
object STRING Type of object representing the attached item.
parent_item_id STRING Identifier of the parent item to which this attached item is attached.
quantity INT64 Quantity of the attached item included in the parent item.
quantity_in_decimal STRING Quantity of the attached item in decimal format.
resource_version INT64 Version of the attached item resource for tracking changes.
status STRING Current status of the attached item.
updated_at INT64 Timestamp when the attached item was last updated.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

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

  • attached_item__custom_fields (5 columns)
comment (10 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
type STRING The type or category of the comment (e.g., general, issue).
added_by STRING The user who added the comment.
created_at INT64 The timestamp indicating when the comment was created.
entity_id STRING The unique identifier of the entity the comment is associated with.
entity_type STRING The type of entity (e.g., customer, invoice) that the comment is related to.
id STRING The unique identifier of the comment.
notes STRING The actual content of the comment or notes added.
object STRING The object to which the comment is attached.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

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

  • comment__custom_fields (5 columns)
contact (13 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
customer_id STRING The unique identifier of the customer associated with the contact.
email STRING Email address of the contact.
enabled BOOL Indicates whether the contact is currently enabled or disabled.
first_name STRING First name of the contact.
id STRING Unique identifier of the contact.
label STRING A label assigned to the contact for easy identification.
last_name STRING Last name of the contact.
object STRING Type of object, in this case, it will be ‘contact’.
phone STRING Phone number of the contact.
send_account_email BOOL Indicates whether account-related emails are enabled for the contact.
send_billing_email BOOL Indicates whether billing-related emails are enabled for the contact.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

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

  • contact__custom_fields (5 columns)
coupon (26 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
apply_discount_on STRING Determines where the discount is applied on (e.g. subtotal, total).
apply_on STRING Specify on what type of items the coupon applies (e.g. subscription, addon).
archived_at INT64 Timestamp when the coupon was archived.
created_at INT64 Timestamp of the coupon creation.
currency_code STRING The currency code for the coupon (e.g. USD, EUR).
discount_amount INT64 The fixed discount amount applied by the coupon.
discount_percentage FLOAT64 Percentage discount applied by the coupon.
discount_quantity INT64 Specifies 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_type STRING Type of discount (e.g. fixed, percentage).
duration_month INT64 Duration of the coupon in months.
duration_type STRING Type of duration (e.g. forever, one-time).
id STRING Unique identifier for the coupon.
invoice_name STRING Name displayed on invoices when the coupon is used.
invoice_notes STRING Additional notes displayed on invoices when the coupon is used.
max_redemptions INT64 Maximum number of times the coupon can be redeemed.
name STRING Name of the coupon.
object STRING Type of object (usually ‘coupon’).
period INT64 Duration or frequency for which the coupon is valid.
period_unit STRING Unit of the period (e.g. days, weeks).
redemptions INT64 Number of times the coupon has been redeemed.
resource_version INT64 Version of the resource.
status STRING Current status of the coupon (e.g. active, inactive).
updated_at INT64 Timestamp when the coupon was last updated.
valid_till INT64 Date until which the coupon is valid for use.
… and 1 more columns

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)
credit_note (68 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
type STRING The type of credit note.
amount_allocated INT64 The amount of credits allocated.
amount_available INT64 The amount of credits available.
amount_refunded INT64 The amount of credits refunded.
base_currency_code STRING The base currency code for the credit note.
billing_address__city STRING The city in the billing address
billing_address__company STRING The company name in the billing address
billing_address__country STRING The country in the billing address
billing_address__email STRING The email address in the billing address
billing_address__first_name STRING The first name in the billing address
billing_address__last_name STRING The last name in the billing address
billing_address__line1 STRING The first line of the address
billing_address__line2 STRING The second line of the address
billing_address__line3 STRING The third line of the address
billing_address__object STRING The object type
billing_address__phone STRING The phone number in the billing address
billing_address__state STRING The state in the billing address
billing_address__state_code STRING The state code in the billing address
billing_address__validation_status STRING The validation status of the address
billing_address__zip STRING The zip code in the billing address
business_entity_id STRING The ID of the business entity associated with the credit note.
channel STRING The channel through which the credit note was created.
create_reason_code STRING The reason code for creating the credit note.
currency_code STRING The currency code for the credit note.
… and 43 more columns

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)
customer (87 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
allow_direct_debit BOOL Indicates if direct debit is allowed for the customer.
auto_close_invoices BOOL Flag to automatically close invoices for the customer.
auto_collection STRING Configures the automatic collection settings for the customer.
backup_payment_source_id STRING ID of the backup payment source for the customer.
billing_address__city STRING City in the billing address.
billing_address__company STRING Company name in the billing address.
billing_address__country STRING Country in the billing address.
billing_address__email STRING Email address for billing communication.
billing_address__first_name STRING First name in the billing address.
billing_address__last_name STRING Last name in the billing address.
billing_address__line1 STRING Address line 1 in the billing address.
billing_address__line2 STRING Address line 2 in the billing address.
billing_address__line3 STRING Address line 3 in the billing address.
billing_address__object STRING Object type for billing address.
billing_address__phone STRING Phone number for billing contact.
billing_address__state STRING State in the billing address.
billing_address__state_code STRING State code in the billing address.
billing_address__validation_status STRING Validation status of the billing address.
billing_address__zip STRING Zip code in the billing address.
billing_date INT64 Date for billing cycle.
billing_date_mode STRING Mode for billing date calculation.
billing_day_of_week STRING Day of the week for billing cycle.
billing_day_of_week_mode STRING Mode for billing day of the week calculation.
billing_month INT64 Month for billing cycle.
… and 62 more columns

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)
differential_price (14 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
created_at INT64 The timestamp when the differential price data was created.
currency_code STRING The currency code associated with the differential price data.
id STRING The unique identifier for the differential price data.
item_price_id STRING The identifier of the item price related to the differential price.
modified_at INT64 The timestamp when the differential price data was last modified.
object STRING The object type which this data represents.
parent_item_id STRING The ID of the parent item linked to this differential price data.
price INT64 The price value of the differential price.
price_in_decimal STRING The price value in decimal format for precise calculations.
resource_version INT64 The version of the resource for tracking changes.
status STRING The status of the differential price data (e.g., active, inactive).
updated_at INT64 The timestamp when the differential price data was last updated.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

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)
event (10 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
api_version STRING The version of the Chargebee API being used to fetch the event data.
event_type STRING The type or category of the event.
id STRING Unique identifier for the event data record.
object STRING The object or entity that the event is triggered for.
occurred_at INT64 The datetime when the event occurred.
source STRING The source or origin of the event data.
user STRING Information about the user or entity associated with the event.
webhook_status STRING The status of the webhook execution for the event.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

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

  • event__custom_fields (5 columns)
  • event__webhooks (5 columns)
gift (22 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
auto_claim BOOL Indicates if the gift is set to be automatically claimed by the recipient.
claim_expiry_date INT64 The date when the gift claim expires.
gift_receiver__customer_id STRING The ID of the customer who receives the gift.
gift_receiver__email STRING Email of the gift recipient.
gift_receiver__first_name STRING First name of the gift recipient.
gift_receiver__last_name STRING Last name of the gift recipient.
gift_receiver__object STRING Type of object representing the gift receiver.
gift_receiver__subscription_id STRING The ID of the subscription associated with the gift receiver.
gifter__customer_id STRING The ID of the customer who sent the gift.
gifter__invoice_id STRING The ID of the invoice associated with the gift.
gifter__note STRING Any note attached to the gift from the sender.
gifter__object STRING Type of object representing the gift sender.
gifter__signature STRING Signature or identifier of the gift sender.
id STRING Unique ID of the gift.
no_expiry BOOL Indicates if the gift has no expiry.
object STRING Type of object representing the gift.
resource_version INT64 Version of the resource related to the gift.
scheduled_at INT64 Timestamp indicating when the gift is scheduled.
status STRING Status of the gift.
updated_at INT64 Timestamp of when the gift data was last updated.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

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

  • gift__custom_fields (5 columns)
  • gift__gift_timelines (6 columns)
hosted_page (14 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
type STRING Type of hosted page (e.g., checkout, subscription).
business_entity_id STRING The ID of the business entity associated with the hosted page.
created_at INT64 Timestamp indicating when the hosted page was created.
embed BOOL Details about embedding the hosted page.
expires_at INT64 Timestamp specifying the expiry date of the hosted page.
id STRING Unique identifier for the hosted page.
object STRING Indicates the type of object, in this case, it would be ‘hosted_page’.
pass_thru_content STRING Content that is passed through to the hosted page.
resource_version INT64 Version of the hosted page resource.
state STRING Current state of the hosted page (e.g., active, expired).
updated_at INT64 Timestamp indicating the last update time of the hosted page.
url STRING URL where the hosted page can be accessed.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

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

  • hosted_page__custom_fields (5 columns)
invoice (89 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
amount_adjusted INT64 Total amount adjusted in the invoice
amount_due INT64 Amount due for payment
amount_paid INT64 Amount already paid
amount_to_collect INT64 Amount yet to be collected
base_currency_code STRING Currency code used as base for the invoice
billing_address__city STRING City of the billing address
billing_address__company STRING Company name in the billing address
billing_address__country STRING Country of the billing address
billing_address__email STRING Email address associated with the billing address
billing_address__first_name STRING First name in the billing address
billing_address__last_name STRING Last name in the billing address
billing_address__line1 STRING First line of the billing address
billing_address__line2 STRING Second line of the billing address
billing_address__line3 STRING Third line of the billing address
billing_address__object STRING Type of object representing the billing address
billing_address__phone STRING Phone number associated with the billing address
billing_address__state STRING State of the billing address
billing_address__state_code STRING State code of the billing address
billing_address__validation_status STRING Status of address validation
billing_address__zip STRING ZIP code of the billing address
business_entity_id STRING ID of the business entity
channel STRING Channel through which the invoice was generated
credits_applied INT64 Total credits applied to the invoice
currency_code STRING Currency code of the invoice
… and 64 more columns

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)
item (25 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
type STRING Type of the item
description STRING Description of the item
archived_at INT64 Date and time when the item was archived
channel STRING Channel the item belongs to
enabled_for_checkout BOOL Flag indicating if the item is enabled for checkout
enabled_in_portal BOOL Flag indicating if the item is enabled in the portal
external_name STRING Name of the item in an external system
gift_claim_redirect_url STRING URL to redirect for gift claim
id STRING Unique identifier for the item
included_in_mrr BOOL Flag indicating if the item is included in Monthly Recurring Revenue
is_giftable BOOL Flag indicating if the item is giftable
is_shippable BOOL Flag indicating if the item is shippable
item_applicability STRING Applicability of the item
item_family_id STRING ID of the item’s family
metered BOOL Flag indicating if the item is metered
name STRING Name of the item
object STRING Type of object
redirect_url STRING URL to redirect for the item
resource_version INT64 Version of the resource
status STRING Status of the item
unit STRING Unit associated with the item
updated_at INT64 Date and time when the item was last updated
usage_calculation STRING Calculation method used for item usage
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

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

  • item__applicable_items (4 columns)
  • item__custom_fields (5 columns)
item_family (10 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
description STRING A brief description of the item family.
channel STRING The channel associated with the item family.
id STRING The unique identifier for the item family.
name STRING The name of the item family.
object STRING The type of object, in this case, ‘item_family’.
resource_version INT64 The resource version of the item family data.
status STRING The status of the item family.
updated_at INT64 The timestamp when the item family was last updated.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

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

  • item_family__custom_fields (5 columns)
item_price (46 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
description STRING Description of the item.
accounting_detail__accounting_category1 STRING The first accounting category.
accounting_detail__accounting_category2 STRING The second accounting category.
accounting_detail__accounting_category3 STRING The third accounting category.
accounting_detail__accounting_category4 STRING The fourth accounting category.
accounting_detail__accounting_code STRING The accounting code associated with the item.
accounting_detail__sku STRING Stock Keeping Unit (SKU) code of the item.
archived_at INT64 Date and time when the item was archived.
billing_cycles INT64 Number of billing cycles for the item.
channel STRING The channel through which the item is sold.
created_at INT64 Date and time when the item was created.
currency_code STRING The currency code used for pricing the item.
external_name STRING External name of the item.
free_quantity INT64 Free quantity allowed for the item.
free_quantity_in_decimal STRING Free quantity allowed represented in decimal format.
id STRING Unique identifier for the item.
invoice_notes STRING Notes to be included in the invoice for the item.
is_taxable BOOL Flag indicating whether the item is taxable.
item_family_id STRING Identifier for the item family to which the item belongs.
item_id STRING Unique identifier for the item.
item_type STRING Type of the item (e.g., product, service).
name STRING Name of the item.
object STRING Object type representing the item.
period INT64 Duration of the item’s billing period.
… and 21 more columns

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)
order (84 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
amount_adjusted INT64 Adjusted amount for the order.
amount_paid INT64 Amount paid for the order.
base_currency_code STRING The base currency code used for the order.
batch_id STRING Unique identifier for the batch the order belongs to.
billing_address__city STRING City in the billing address.
billing_address__company STRING Company name in the billing address.
billing_address__country STRING Country in the billing address.
billing_address__email STRING Email associated with the billing address.
billing_address__first_name STRING First name in the billing address.
billing_address__last_name STRING Last name in the billing address.
billing_address__line1 STRING First address line in the billing address.
billing_address__line2 STRING Second address line in the billing address.
billing_address__line3 STRING Third address line in the billing address.
billing_address__object STRING Type of object representing the billing address.
billing_address__phone STRING Phone number associated with the billing address.
billing_address__state STRING State in the billing address.
billing_address__state_code STRING State code of the billing address.
billing_address__validation_status STRING Validation status of the billing address.
billing_address__zip STRING Zip or postal code in the billing address.
business_entity_id STRING Identifier for the business entity associated with the order.
cancellation_reason STRING Reason for order cancellation.
cancelled_at INT64 Timestamp when the order was cancelled.
created_at INT64 Timestamp when the order was created.
created_by STRING User or system that created the order.
… and 59 more columns

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)
payment_source (52 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
type STRING Type of payment source, e.g., card, bank_account
amazon_payment__agreement_id STRING Unique identifier for the Amazon payment agreement
amazon_payment__email STRING Email associated with the Amazon payment method
bank_account__account_holder_type STRING Type of account holder, e.g., individual or business
bank_account__account_type STRING Type of bank account, e.g., checking or savings
bank_account__bank_name STRING Name of the bank associated with the account
bank_account__echeck_type STRING Type of eCheck, if applicable
bank_account__email STRING Email associated with the bank account
bank_account__first_name STRING First name of the account holder
bank_account__last4 STRING Last four digits of the bank account number
bank_account__last_name STRING Last name of the account holder
bank_account__mandate_id STRING Unique identifier for the mandate related to the bank account
bank_account__name_on_account STRING Name on the bank account
business_entity_id STRING Identifier for the business entity associated with the payment source
card__billing_addr1 STRING First line of the billing address
card__billing_addr2 STRING Second line of the billing address
card__billing_city STRING City of the billing address
card__billing_country STRING Country of the billing address
card__billing_state STRING State of the billing address
card__billing_state_code STRING State code of the billing address
card__billing_zip STRING ZIP or postal code of the billing address
card__brand STRING Brand of the card, e.g., Visa, Mastercard
card__expiry_month INT64 Expiry month of the card
card__expiry_year INT64 Expiry year of the card
… and 27 more columns

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

  • payment_source__custom_fields (5 columns)
plan (51 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
description STRING Description of the plan
accounting_category1 STRING The first category for accounting purposes
accounting_category2 STRING The second category for accounting purposes
accounting_category3 STRING The third category for accounting purposes
accounting_category4 STRING The fourth category for accounting purposes
accounting_code STRING The accounting code associated with the plan
addon_applicability STRING How the add-ons are applicable to the plan
archived_at INT64 Timestamp when the plan was archived
avalara_sale_type STRING Avalara sale type for tax calculations
avalara_service_type INT64 Avalara service type for tax calculations
avalara_transaction_type INT64 Avalara transaction type for tax calculations
billing_cycles INT64 Number of billing cycles for the plan
channel STRING Channel associated with the plan
charge_model STRING The model used for charging
claim_url STRING URL for claiming the plan
currency_code STRING The currency code used for pricing
enabled_in_hosted_pages BOOL Whether the plan is enabled in hosted pages
enabled_in_portal BOOL Whether the plan is enabled in the portal
free_quantity INT64 Free quantity included in the plan
free_quantity_in_decimal STRING Decimal free quantity included in the plan
giftable BOOL Whether the plan is giftable
id STRING The ID of the plan
invoice_name STRING Name used in invoices
invoice_notes STRING Notes included in invoices
… and 26 more columns

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)
promotional_credit (15 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
type STRING The category or classification of the promotional credit.
description STRING Additional information or notes about the promotional credit.
amount INT64 The amount of promotional credit.
amount_in_decimal STRING The decimal representation of the promotional credit amount.
closing_balance INT64 The closing balance after using promotional credit.
created_at INT64 The timestamp when the promotional credit was created.
credit_type STRING The type of promotional credit.
currency_code STRING The currency code of the promotional credit.
customer_id STRING The ID of the customer associated with the promotional credit.
done_by STRING The user who initiated the use of promotional credit.
id STRING The unique identifier of the promotional credit record.
object STRING The object type, usually ‘credit’.
reference STRING A reference related to the promotional credit.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

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

  • promotional_credit__custom_fields (5 columns)
quote (62 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
version INT64 The version of the quote data.
amount_due INT64 The total amount that is due for payment in the quote.
amount_paid INT64 The total amount that has been paid towards the quote.
billing_address__city STRING
billing_address__company STRING
billing_address__country STRING
billing_address__email STRING
billing_address__first_name STRING
billing_address__last_name STRING
billing_address__line1 STRING
billing_address__line2 STRING
billing_address__line3 STRING
billing_address__object STRING
billing_address__phone STRING
billing_address__state STRING
billing_address__state_code STRING
billing_address__validation_status STRING
billing_address__zip STRING
business_entity_id STRING The ID of the business entity related to the quote.
charge_on_acceptance INT64 Whether the charge is applicable on acceptance of the quote.
contract_term_end INT64 The end date of the contract terms for the quote.
contract_term_start INT64 The start date of the contract terms for the quote.
contract_term_termination_fee INT64 The fee applicable for terminating the contract terms.
credits_applied INT64 The credits applied to the quote amount.
… and 37 more columns

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)
quote_line_group (13 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
version INT64 The version of the quote line group.
amount_due INT64 The total amount that is due for payment.
amount_paid INT64 The total amount that has been paid.
billing_cycle_number INT64 The number indicating the current billing cycle.
charge_event STRING Details about the charge event associated with the quote line group.
credits_applied INT64 The amount of credits applied to the quote line group.
id STRING Unique identifier for the quote line group.
object STRING Type of object representing the quote line group.
quote_id STRING Unique identifier for the quote associated with the line group.
sub_total INT64 The subtotal amount of the quote line group.
total INT64 The total amount for the quote line group after all calculations.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

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)
site_migration_detail (9 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
entity_id STRING ID of the entity being migrated at the current site.
entity_id_at_other_site STRING ID of the entity at the other site where migration occurred.
entity_type STRING Type of entity being migrated (e.g., customer, subscription).
migrated_at INT64 Timestamp indicating when the migration took place.
object STRING Type of object being migrated (e.g., user, data).
other_site_name STRING Name of the site from which the entity was migrated.
status STRING Current status of the site migration process.
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

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

  • site_migration_detail__custom_fields (5 columns)
subscription (103 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
activated_at INT64 The date and time when the subscription was activated.
affiliate_token STRING The affiliate token associated with the subscription.
auto_close_invoices BOOL Defines if the invoices are automatically closed or not.
auto_collection STRING Indicates if auto-collection is enabled for the subscription.
base_currency_code STRING The base currency code used for the subscription.
billing_period INT64 The billing period duration for the subscription.
billing_period_unit STRING The unit of the billing period.
business_entity_id STRING The ID of the business entity to which the subscription belongs.
cancel_reason STRING The reason for the cancellation of the subscription.
cancel_reason_code STRING The code associated with the cancellation reason.
cancel_schedule_created_at INT64 The date and time when the cancellation schedule was created.
cancelled_at INT64 The date and time when the subscription was cancelled.
channel STRING The channel through which the subscription was acquired.
contract_term__action_at_term_end STRING The action to be taken at the end of the contract term.
contract_term__billing_cycle INT64 The billing cycle duration of the contract.
contract_term__cancellation_cutoff_period INT64 The period within which cancellation is allowed before the next term.
contract_term__contract_end INT64 The end date of the contract.
contract_term__contract_start INT64 The start date of the contract.
contract_term__created_at INT64 The timestamp when the contract term was created.
contract_term__id STRING The unique identifier of the contract term.
contract_term__remaining_billing_cycles INT64 The remaining billing cycles for the contract term.
contract_term__status STRING The status of the contract term.
contract_term__subscription_id STRING The identifier of the subscription associated with the contract term.
contract_term__total_contract_value INT64 The total value of the contract.
… and 78 more columns

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)
subscription_with_scheduled_changes (103 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
activated_at INT64 The date and time when the subscription was activated.
affiliate_token STRING The affiliate token associated with the subscription.
auto_close_invoices BOOL Defines if the invoices are automatically closed or not.
auto_collection STRING Indicates if auto-collection is enabled for the subscription.
base_currency_code STRING The base currency code used for the subscription.
billing_period INT64 The billing period duration for the subscription.
billing_period_unit STRING The unit of the billing period.
business_entity_id STRING The ID of the business entity to which the subscription belongs.
cancel_reason STRING The reason for the cancellation of the subscription.
cancel_reason_code STRING The code associated with the cancellation reason.
cancel_schedule_created_at INT64 The date and time when the cancellation schedule was created.
cancelled_at INT64 The date and time when the subscription was cancelled.
channel STRING The channel through which the subscription was acquired.
contract_term__action_at_term_end STRING The action to be taken at the end of the contract term.
contract_term__billing_cycle INT64 The billing cycle duration of the contract.
contract_term__cancellation_cutoff_period INT64 The period within which cancellation is allowed before the next term.
contract_term__contract_end INT64 The end date of the contract.
contract_term__contract_start INT64 The start date of the contract.
contract_term__created_at INT64 The timestamp when the contract term was created.
contract_term__id STRING The unique identifier of the contract term.
contract_term__remaining_billing_cycles INT64 The remaining billing cycles for the contract term.
contract_term__status STRING The status of the contract term.
contract_term__subscription_id STRING The identifier of the subscription associated with the contract term.
contract_term__total_contract_value INT64 The total value of the contract.
… and 78 more columns

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)
transaction (52 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
type STRING Type of the transaction.
amount INT64 The total amount of the transaction.
amount_capturable INT64 The remaining amount that can be captured in the transaction.
amount_unused INT64 The amount in the transaction that remains unused.
authorization_reason STRING Reason for authorization of the transaction.
base_currency_code STRING The base currency code of the transaction.
business_entity_id STRING The ID of the business entity related to the transaction.
cn_create_reason_code STRING Reason code for creating a credit note.
cn_date INT64 Date of the credit note.
cn_reference_invoice_id STRING ID of the invoice referenced in the credit note.
cn_status STRING Status of the credit note.
cn_total INT64 Total amount of the credit note.
currency_code STRING The currency code of the transaction.
customer_id STRING The ID of the customer associated with the transaction.
date INT64 Date of the transaction.
deleted BOOL Flag indicating if the transaction is deleted.
error_code STRING Error code associated with the transaction.
error_detail STRING Detailed error information related to the transaction.
error_text STRING Error message text of the transaction.
exchange_rate FLOAT64 Exchange rate used in the transaction.
fraud_flag STRING Flag indicating if the transaction is flagged for fraud.
fraud_reason STRING Reason for flagging the transaction as fraud.
gateway STRING The payment gateway used in the transaction.
gateway_account_id STRING ID of the gateway account used in the transaction.
… and 27 more columns

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)
unbilled_charge (33 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
description STRING Description of the unbilled charge
amount INT64 Total amount of the unbilled charge
amount_in_decimal STRING Total amount in decimal format of the unbilled charge
currency_code STRING Currency code of the amount
customer_id STRING ID of the customer associated with the unbilled charge
date_from INT64 Start date of the charge period
date_to INT64 End date of the charge period
deleted BOOL Flag to indicate if the charge has been deleted
discount_amount INT64 Amount of any discounts applied to the charge
entity_id STRING ID of the entity related to the charge
entity_type STRING Type of entity related to the charge
id STRING Unique ID of the unbilled charge
is_advance_charge BOOL Flag to indicate if the charge is an advance charge
is_voided BOOL Flag to indicate if the charge has been voided
object STRING Type of object representing the unbilled charge
pricing_model STRING Pricing model used for the charge
quantity INT64 Quantity of units for the charge
quantity_in_decimal STRING Quantity of units in decimal format for the charge
subscription_id STRING ID of the subscription associated with the charge
tiers__ending_unit INT64 Ending unit for the tier pricing
tiers__ending_unit_in_decimal STRING Ending unit in decimal format for the tier pricing
tiers__quantity_used INT64 Quantity of units used in the tier
tiers__quantity_used_in_decimal STRING Quantity of units used in decimal format in the tier
tiers__starting_unit INT64 Starting unit for the tier pricing
… and 8 more columns

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

  • unbilled_charge__custom_fields (5 columns)
virtual_bank_account (16 columns)
Column Type Description
_kaivo_id STRING Primary key that uniquely identifies the row. Auto-generated by Kaivo.
account_number STRING The virtual bank account number associated with the customer
bank_name STRING The name of the bank of the virtual bank account
created_at INT64 The date and time when the virtual bank account was created
customer_id STRING The unique identifier of the customer associated with the virtual bank account
deleted BOOL Flag indicating if the virtual bank account has been deleted
email STRING The email address associated with the customer’s virtual bank account
gateway STRING The payment gateway used for processing transactions with this virtual bank account
id STRING The unique identifier of the virtual bank account
reference_id STRING A reference identifier linked to the virtual bank account
resource_version INT64 The version of the virtual bank account resource
routing_number STRING The routing number associated with the virtual bank account
scheme STRING The scheme or type of the virtual bank account
swift_code STRING The SWIFT code associated with the virtual bank account
updated_at INT64 The date and time when the virtual bank account was last updated
_kaivo_extracted_at TIMESTAMP Timestamp that shows when the row was extracted. Auto-generated by Kaivo.

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

  • virtual_bank_account__custom_fields (5 columns)

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.

How long does the initial sync take for Chargebee?

Section titled “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.

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?

Section titled “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?

Section titled “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.

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

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

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

Report on coupon usage to measure how discounts affect revenue.

Use Chargebee data in your AI and BI tools

Section titled “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.

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

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

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

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

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

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

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

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