Chargebee integration summary

Stitch’s Chargebee integration replicates data using the Chargebee API . Refer to the Schema section for a list of objects available for replication.

Chargebee feature snapshot

A high-level look at Stitch's Chargebee (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status Supported by

Singer Community

Stitch plan

Free

API availability

Not available

Singer GitHub repository

singer-io/tap-chargebee

REPLICATION SETTINGS
Anchor Scheduling

Supported

Advanced Scheduling

Supported

Table-level reset

Unsupported

Configurable Replication Methods

Unsupported

DATA SELECTION
Table selection

Supported

Column selection

Supported

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

Connecting Chargebee

Step 1: Generate an API Key

First, you’ll generate a Chargebee API Key for Stitch. This will allow Stitch to read data from your Chargebee account using the Chargebee API.

  1. Sign into your Chargebee account.
  2. In the left sidenav, click Settings > Configure Chargebee.
  3. Click the API keys and webhooks button.
  4. On the API Keys page, click the + Add API Key button. The Create an API Key modal will display.
  5. Select Read-Only Key as the API key type.
  6. Select All to define the API key’s access. This will grant read-only access to your Chargebee site.
  7. In the Name the API key field, enter Stitch.
  8. Click Create Key.

Chargebee will create the API key and redirect you back to the API Keys page:

Copy the API key somwhere handy - you’ll need it to complete the setup in Stitch.

Step 2: Add Chargebee as a Stitch data source

  1. Sign into your Stitch account.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Chargebee icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Chargebee” would create a schema called stitch_chargebee in the destination. Note: Schema names cannot be changed after you save the integration.

  5. In the API Key field, paste the API key you generated in Step 1.
  6. In the Site field, enter the name of your Chargebee site. This can be found in the URL of your Chargebee site. For example: If the URL was https://stitch.chargebee.com, only stitch would be entered into this field.

Step 3: Define the historical sync

The Sync Historical Data setting will define the starting date for your Chargebee integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Chargebee’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 4: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Chargebee integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 5: Set tables and columns to replicate

To complete the setup, you’ll need to select the tables and columns you want to replicate to your data warehouse.

Check out the Schema section to learn more about the available tables in Chargebee and how they replicate.

  1. In the list of tables that displays - or in the Tables to Replicate tab, if you skipped this step during setup - locate a table you want to replicate.
  2. To track a table, click the checkbox next to the table’s name. A green checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A green checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.

Note: If you change these settings while a replication job is still in progress, they will not be used until the next job starts.

Initial and historical replication jobs

After you finish setting up Chargebee, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.


Chargebee table schemas

Replication Method :

Key-based Incremental

Replication Key :

updated_at

Primary Key :

id

API endpoint :

List addons

The addons table contains info about the addons in your Chargebee account. Addons are additional charges applied to subscriptions apart from base charges.

id
STRING

The addon ID.

Reference:

updated_at
DATE-TIME

The time the addon was last updated. Note: This attribute will be present only if the resource has been updated after 2016-09-28.

accounting_code
STRING

The accounting code used by the addon.

accouting_category1
STRING

The name of the category of your product in Xero. If you’ve integrated with QuickBooks, this will be the Class.

accouting_category2
STRING

The name of the category of your product in Xero.

archived_at
DATE-TIME

The time at which the plan was moved to archived status.

avalara_sale_type
STRING

Applicable only if you use Chargebee’s AvaTax for Communications integration. The type of sale carried out. Possible values are:

  • wholesale
  • retail
  • consumed
  • vendor_use

avalara_service_type
INTEGER

Applicable only if you use Chargebee’s AvaTax for Communications integration. The type of service for the product to be taxed.

avalara_transaction_type
INTEGER

Applicable only if you use Chargebee’s AvaTax for Communications integration. The type of product to be taxed.

charge_type
STRING

The type of charge. Possible values are:

  • recurring: Charges are automatically applied in sync with the billing frequency of the subscription.
  • non_recurring: Charged immediately and only once every time it’s applied.

currency_code
STRING

The currency code (ISO 4217 format) of the addon.

custom_fields
STRING

description
STRING

Description about the addon to show in the hosted pages and customer portal.

enabled_in_portal
BOOLEAN

Indicates if the addon is available to customers to add in the ‘Change Subscription’ option in the customer portal.

invoice_name
STRING

The display name used in invoices.

invoice_notes
STRING

The invoice notes for the addon.

is_shippable
BOOLEAN

Indicates whether the addon can be added to orders.

meta_data
STRING

Additional info about the addon.

name
STRING

The display name used in web interface for identifying the addon.

object
STRING

period
INTEGER

Applicable only for charge_type: recurring. Along with period_unit, this determines the term-price of the addon.

period_unit
STRING

Applicable only for charge_type: recurring. Along with period, this determines the term-price of the addon. Possible values are:

  • week: Charge based on week(s)
  • month: Charge based on month(s)
  • year: Charge based on year(s)
  • not_applicable: Not applicable for the addon

price
INTEGER

The addon price. Addon price is calculated based on the addon type and charge type.

pricing_model
STRING

Indicates how the charges for the addon are calculated. Possible values are:

  • flat_fee: Charges single price on a recurring basis.
  • per_unit: Charges the price for each unit of the plan for the subscription on a recurring basis.
  • tiered: Charges different per unit price for the quantity purchased from every tier.
  • volume: Charges the per unit price for the total quantity purchased based on the tier under which it falls.
  • stairstep: Charges a price for a range.

resource_version
INTEGER

The version number of the addon. Each update of the addon results in an incremental change of this value. Note: This attribute will be present only if the resource has been updated after 2016-09-28.

shipping_frequency_period
INTEGER

Defines the shipping frequency in conjunction with shipping_frequency_period_unit. For example: If shipping_frequency_period_unit: week and this value is 2, the customer would be billed every two weeks.

shipping_frequency_period_unit
STRING

Defines the shipping frequency in conjunction with shipping_frequency_period. Possible values are:

  • year
  • month
  • week

sku
STRING

The field is used as Product name/code in your third party accounting application. Chargebee will use it as an alternate name in your accounting application

status
STRING

The status of the addon. Possible values are:

  • active
  • archived

tax_code
STRING

The Avalara tax codes to which items are mapped to should be provided here. Applicable only if you use Chargebee’s AvaTax for Sales integration.

tax_profile_id
STRING

The tax profile of the addon.

taxable
BOOLEAN

Indicates whether the addon is taxable or not.

tiers
ARRAY

Applicable only if the addon uses tiered, volume, or stairstep pricing. The list of tiers for the addon.

ending_unit
INTEGER

The upper limit of a range of units for the tier.

price
INTEGER

The price of the tier if the charge model is stairstep pricing, or the price of each unit in the tier if the charge model is tiered/volume pricing.

starting_unit
INTEGER

The lower limit of a range of units for the tier.

addons (table), tiers (attribute)

type
STRING

unit
STRING

Applicable only for quantity type addons. This specifies the type of quantity. For example: If the addon price is $10 and agent is the unit, it will be displayed as $10/agent.


Replication Method :

Key-based Incremental

Replication Key :

updated_at

Primary Key :

id

API endpoint :

List coupons

The coupons table contains info about the coupons in your Chargebee account.

id
STRING

The coupon ID.

Reference:

updated_at
DATE-TIME

The time the coupon was last updated.

addon_constraint
STRING

The addons the coupon can be applied to. Possible values are:

  • none
  • all
  • specific
  • not_applicable

addon_ids
ARRAY

IDs of the addons associated with the coupon.

apply_discount_on
STRING

apply_on
STRING

The invoice items for which this coupon needs to be applied. Possible values are:

  • invoice_amount: The coupon will be applied to the total invoice amount.
  • each_specified_item: the discount will be applied to each specified plan and addon item.

archived_at
DATE-TIME

The time when the coupon was archived.

created_at
DATE-TIME

The time when the coupon was created.

currency_code
STRING

The currency code (ISO 4217 format) of the coupon. Applicable for fixed_amount coupons.

discount_amount
NUMBER

When discount_type: fixed_amount, this value will be the discount value in cents.

discount_percentage
NUMBER

When discount_type: percentage, this value will be the discount value percentage.

discount_type
STRING

The type of discount. Possible values are:

  • fixed_amount
  • percentage

duration_month
INTEGER

When duration_type: limited_period, this value will be the duration in months the coupon can be applied.

duration_type
STRING

The duration the coupon is applicable. Possible values are:

  • one_time
  • forever
  • limited_period

invoice_name
STRING

The name of the invoice associated with the coupon.

invoice_notes
STRING

Invoice notes for the coupon.

max_redemptions
INTEGER

The maximum number of times the coupon can be redeemed.

meta_data
STRING

Additional info about the coupon.

name
STRING

The display name used in web interface for identifying the coupon.

object
STRING

plan_constraint
STRING

The plans the coupon can be applied to. Possible values are:

  • none
  • all
  • specific
  • not_applicable

plan_ids
ARRAY

IDs of the plans associated with the coupon.

redemptions
INTEGER

The number of times the coupon has been redeemed.

resource_version
INTEGER

The version number of the coupon. Each update of the coupon results in an incremental change of this value. Note: This attribute will be present only if the coupon has been updated after 2016-09-28.

status
STRING

The status of the coupon. Possible values are:

  • active
  • expired
  • archived
  • deleted

Replication Method :

Key-based Incremental

Replication Key :

updated_at

Primary Key :

id

API endpoint :

List credit notes

The credit_notes table contains info about the credit notes in your Chargebee account. A credit note is a document that specifies the money owed by a business to a customer.

id
STRING

The credit note ID.

Reference:

updated_at
DATE-TIME

The time the credit note was last updated.

allocations
ARRAY

Details about invoice allocations made from the credit note.

allocated_amount
INTEGER

The amount of the allocation, in cents.

allocated_at
DATE-TIME

The time the allocation occurred.

invoice_date
DATE-TIME

The closing date of the invoice.

invoice_id
STRING

The invoice ID.

Reference:

invoice_status
STRING

The current status of the invoice. Possible values are:

  • paid
  • posted
  • payment_due
  • not_paid
  • voided
  • pending
credit_notes (table), allocations (attribute)

amount_allocated
INTEGER

The amount allocated to invoices.

amount_available
INTEGER

The yet to be used credits of this credit note.

amount_refunded
INTEGER

The refunds issued from this credit note.

currency_code
STRING

The currency code (ISO 4217 format) for the credit note.

customer_id
STRING

The ID of the customer associated with the credit note.

Reference:

date
DATE-TIME

The date the credit note was issued.

deleted
BOOLEAN

Indicates whether the credit note was deleted or not.

discounts
ARRAY

Details about the discounts applied to the credit note.

amount
INTEGER

The discount amount, in cents.

description
STRING

The description of the discount line item.

entity_id
STRING

The ID of the entity the discount amount is based on. This value will only be present if entity_type is item_level_coupon or document_level_coupon.

Reference:

entity_type
STRING

The type of the discount line item. Possible values are:

  • item_level_coupon: Represents item-level coupons applied to the invoice.
  • document_level_coupon: Represents document-level coupons applied to the document.
  • promotional_credits: Represents promotional credits in the invoice.
  • prorated_credits: Represents credit adjustments in the invoice.
credit_notes (table), discounts (attribute)

line_item_discounts
ARRAY

The list of discount(s) applied for each line item of the invoice.

coupon_id
STRING

The coupon ID.

Reference:

discount_amount
INTEGER

The discount amount, in cents.

discount_type
STRING

The type of the discount line item. Possible values are:

  • item_level_coupon: Represents item-level coupons applied to the invoice.
  • document_level_coupon: Represents document-level coupons applied to the document.
  • promotional_credits: Represents promotional credits in the invoice.
  • prorated_credits: Represents credit adjustments in the invoice.

line_item_id
STRING

The ID of the line item for which the discount is applicable.

Reference:

credit_notes (table), line_item_discounts (attribute)

line_item_taxes
ARRAY

The list of taxes applied on line items.

is_non_compliance_tax
BOOLEAN

Indicates the non-compliance tax should not be reported to the tax jurisdiction.

is_partial_tax_applied
BOOLEAN

Indicates whether tax is applied only on a portion of the line item or not.

line_item_id
STRING

The ID of the line item for which the tax is applicable.

Reference:

tax_amount
INTEGER

The tax amount, in cents.

tax_juris_code
STRING

The tax jurisdiction code.

tax_juris_name
STRING

The name of the tax jurisdiction.

tax_juris_type
STRING

The type of tax jurisdiction. Possible values are:

  • country
  • federal
  • state
  • county
  • city
  • special
  • unincorporated (Combined tax of state and country)
  • other

tax_name
STRING

The name of the tax applied.

tax_rate
NUMBER

The rate of tax used to calculate the tax amount.

taxable_amount
INTEGER

The actual portion of the line item that is taxable, in cents.

credit_notes (table), line_item_taxes (attribute)

line_item_tiers
ARRAY

The list of tiers applicable for the line item.

ending_unit
INTEGER

The upper limit of a range of units for the tier.

line_item_id
STRING

The line item ID.

Reference:

quantity_used
INTEGER

The number of units purchased in a range.

starting_unit
INTEGER

The lower limit of a range of units for the tier.

unit_amount
INTEGER

The price of the tier if the charge model is stairstep, or the price of each unit in the tier if the charge model is tiered or volume.

credit_notes (table), line_item_tiers (attribute)

line_items
ARRAY

The line items in the credit note.

amount
INTEGER

The total amount of the line item, calculated as unit_amount x quantity.

date_from
DATE-TIME

The start date of the line item.

date_to
DATE-TIME

The end date of the line item.

description
STRING

The description of the line item.

discount_amount
INTEGER

The discount amount applied to the line item, in cents.

entity_id
STRING

The ID of the entity the line item is based on.

entity_type
STRING

The modelled entity (plan, addon, etc.) this line item is based on. Possible values are:

  • plan_setup: The line item is based on a plan setup charge. The entity_id will specify the plan ID (plans: id).
  • plan: The line item is based on a plan entity. The entity_id will specify the plan ID (plans: id).
  • addon: The line item is based on an addon entity. The entity_id will specify the addon ID (addons: id).
  • adhoc: The line item is not modelled. The entity_id attribute will be null.

id
STRING

The line item ID.

Reference:

is_taxed
BOOLEAN

Indicates whether the line item is taxed or not.

item_level_discount_amount
INTEGER

The item level discount amount for the line item, in cents.

pricing_model
STRING

Indicates how the charges for the line item are calculated. Possible values are:

  • flat_fee: Charges single price on a recurring basis.
  • per_unit: Charges the price for each unit of the plan for the subscription on a recurring basis.
  • tiered: Charges different per unit price for the quantity purchased from every tier.
  • volume: Charges the per unit price for the total quantity purchased based on the tier under which it falls.
  • stairstep: Charges a price for a range.

quantity
INTEGER

The quantity of the recurring item, represented by the line item.

subscription_id
STRING

The ID of the subscription associated with the line item.

Reference:

tax_amount
INTEGER

The tax amount of the line item, in cents.

tax_exempt_reason
STRING

The reason or category for why the line item is excluded from the taxable amount. Possible values are:

  • tax_not_configured
  • region_non_taxable
  • export
  • customer_exempt
  • zero_rated
  • reverse_charge
  • high_value_physical_good

tax_rate
NUMBER

The rate of tax used to calculate tax for the line item.

unit_amount
INTEGER

The unit amount of the line item, in cents.

credit_notes (table), line_items (attribute)

linked_refunds
ARRAY

Details about refunds issued from the credit note.

applied_amount
INTEGER

The transaction amount applied to the invoice.

applied_at
DATE-TIME

The time the amount was applied.

txn_amount
INTEGER

The total amount of the transaction.

txn_date
DATE-TIME

The date the transaction occured.

txn_id
STRING

the transaction ID.

Reference:

txn_status
STRING

The status of the transaction. Possible values are:

  • in_progress
  • success
  • voided
  • failure
  • timeout
  • needs_attention
credit_notes (table), linked_refunds (attribute)

price_type
STRING

The price type of the credit note. Possible values are:

  • tax_exclusive
  • tax_inclusive

reason_code
STRING

The reason for issuing the credit note. Possible values include:

  • write_off
  • subscription_change
  • subscription_cancellation
  • subscription_pause
  • chargeback
  • product_unsatisfactory
  • service_unsatisfactory
  • order_change
  • order_cancellation
  • waiver
  • other
  • fraudulent

reference_invoice_id
STRING

The ID of the invoice against which the credit note is issued.

Reference:

refunded_at
DATE-TIME

The time when the credit note was fully used.

resource_version
INTEGER

The version number of the credit note. Each update of the credit note results in an incremental change of this value. Note: This attribute will be present only if the credit note has been updated after 2016-09-28.

round_off_amount
INTEGER

The credit note rounded-off amount, in cents.

status
STRING

The status of the credit note. Possible values include:

  • adjusted
  • refunded
  • refund_due
  • voided

sub_total
INTEGER

The credit note subtotal, in cents.

subscription_id
STRING

The ID of the subscription associated with the credit note.

Reference:

taxes
ARRAY

The tax lines of the credit note.

amount
INTEGER

The tax amount, in cents.

description
STRING

The description of the tax item.

name
STRING

The name of the tax applied. For example: GST

credit_notes (table), taxes (attribute)

total
INTEGER

The total credit amount in cents.

type
STRING

The credit note type. Possible values are:

  • adjustment
  • refundable

vat_number
STRING

The VAT number of the customer for whom the credit note is raised.

voided_at
DATE-TIME

The time when the credit note was voided.


Replication Method :

Key-based Incremental

Replication Key :

updated_at

Primary Key :

id

API endpoint :

List customers

The customers table contains info about the customers in your Chargebee account.

id
STRING

The customer ID.

Reference:

updated_at
DATE-TIME

The time the customer was last updated.

allow_direct_debit
BOOLEAN

Indicates whether the customer can pay via direct debit or not.

auto_collection
STRING

Indicates whether payments need to be automatically collected for the customer. Possible values are:

  • on: When an invoice is created, an automatic attempt to charge the customer’s payment method is made.
  • off: Automatic collection of charges will not be made.

backup_payment_source_id
STRING

balances
ARRAY

The list of balances for the customer.

currency_code
STRING

The currency code in ISO 4217 for the balance.

excess_payments
INTEGER

The total unused payments associated with the customer.

promotional_credits
INTEGER

The promotional credits balance for the customer.

refundable_credits
INTEGER

The refundable credits balance for the customer.

unbilled_charges
INTEGER

The total unbilled charges for the customer.

customers (table), balances (attribute)

billing_address
OBJECT

The billing address for the customer.

city
STRING

The city.

company
STRING

The company.

country
STRING

The country.

email
STRING

The email.

first_name
STRING

The first name.

last_name
STRING

The last name.

line1
STRING

The first line of the address.

line2
STRING

The second line of the address.

line3
STRING

The third line of the address.

phone
STRING

The phone number.

state
STRING

The state or province.

state_code
STRING

The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India.

validation_status
STRING

The address verification status. Possible values are:

  • not_validated
  • valid
  • partially_valid
  • invalid

zip
STRING

The zip or postal code.

customers (table), billing_address (attribute)

billing_date
BOOLEAN

Applicable when calendar billing (with customer specific billing date support) is enabled. When set, renewals of all the monthly and yearly subscriptions of this customer will be aligned to this date.

billing_date_mode
STRING

Indicates whether this customer’s billing_date value is derived as per configurations or its specifically set (overriden). When specifically set, the billing_date will not be reset even when all of the monthly/yearly subscriptions are cancelled.

Possible values are:

  • using_defaults: The billing_date value is set based on configured defaults.
  • manually_set: The billing_date is specifically set.

billing_day_of_week
BOOLEAN

Applicable when calendar billing (with customer specific billing date support) is enabled. When set, renewals of all the weekly subscriptions of this customer will be aligned to this week day.

Possible values are:

  • monday
  • tuesday
  • wednesday
  • thursday
  • friday
  • saturday
  • sunday

billing_day_of_week_mode
STRING

Indicates whether this customer’s billing_day_of_week value is derived as per configurations or its specifically set (overriden). When specifically set, the billing_day_of_week will not be reset even when all of the weekly subscriptions are cancelled.

Possible values are:

  • using_defaults: The billing_day_of_week value is set based on configured defaults.
  • manually_set: The billing_day_of_week is specifically set.

card_status
STRING

cf_company_id
INTEGER

company
STRING

The name of the company associated with the customer.

consolidated_invoicing
BOOLEAN

Applicable when consolidated invoicing is enabled. Indicates whether invoice consolidation should happen during subscription renewals. Needs to be set only if this value is different from the defaults configured.

contacts
ARRAY

A list of contacts associated with the customer.

email
STRING

The contact’s email.

enabled
BOOLEAN

Indicates whether the contacted is enabled (true) or disabled (false).

first_name
STRING

The first name of the contact.

id
STRING

The contact ID.

label
STRING

The label/tag provided for the contact.

last_name
STRING

The last name of the contact.

object
STRING

phone
STRING

The phone number of the contact.

send_account_email
STRING

Indicates whether account emails are enabled for the contact.

send_billing_email
STRING

Indicates whether billing emails are enabled for the contact.

customers (table), contacts (attribute)

created_at
DATE-TIME

The time the customer was created.

created_from_ip
STRING

The IP address of the customer.

custom_fields
STRING

customer_type
STRING

Applicable if you use Chargebee’s AvaTax for Sales integration.. The type of the customer. Possible values are:

  • residential
  • business
  • senior_citizen
  • industrial

deleted
BOOLEAN

Indicates whether the customer has been deleted or not.

email
STRING

The customer’s email address.

entity_code
STRING

Applicable if you use Chargebee’s AvaTax for Sales integration.. The exemption category of the customer, for USA and Canada.

excess_payments
INTEGER

The total unused payments associated with the customer.

exemption_details
STRING

Applicable if you use Chargebee’s AvaTax for Sales integration.. Exemption information for the customer.

exempt_number
STRING

Applicable if you use Chargebee’s AvaTax for Sales integration.. Indicates if sales should be exempted for the customer.

first_name
STRING

The first name of the customer.

fraud_flag
STRING

Indicates if the customer has been identified as fraudulent. Possible values are:

  • safe
  • fraudulent

invoice_notes
STRING

Invoice notes associated with the customer.

is_location_valid
BOOLEAN

Indicates if the customer’s location is valid, based on their IP address and the card issuing country. Applicable only for EU, New Zealand, and Australia.

last_name
STRING

The last name of the customer.

locale
STRING

Determines which region-specific language Chargebee uses to communicate with the customer.

meta_data
STRING

Additional info about the customer.

net_term_days
INTEGER

The number of days within which the customer has to make payment for invoices.

object
STRING

payment_method
OBJECT

The primary payment source for the customer.

gateway
STRING

The name of the gateway the payment is associated with. Refer to Chargebee’s documentation for a full list of possible values.

gateway_account_id
STRING

The gateway account the payment method is stored with.

object
STRING

reference_id
STRING

The reference ID.

  • For Amazon and PayPal, this will be the billing agreement ID.
  • For GoCardless direct debit, this will be the mandate ID.
  • For card payments, this will be the ID provided by the gateway/card vault for the specific payment method.

status
STRING

The current status of the payment method. Possible values include:

  • valid
  • expiring
  • expired
  • invalid
  • pending_verification

type
STRING

The type of the payment source. Possible values include:

  • card (Includes credit and debit cards)
  • paypal_express_checkout
  • amazon_payments
  • direct_debit
  • generic
  • alipay
  • unionpay
  • apple_pay
  • wechat_pay
customers (table), payment_method (attribute)

phone
STRING

The customer’s phone number.

pii_cleared
STRING

Indicates whether the customer’s personal info has been cleared. Possible values are:

  • active
  • scheduled_for_clear
  • cleared

preferred_currency_code
STRING

Applicable if the Chargebee Multicurrency feature is enabled. The currency code of the customer’s preferred currency (ISO 4217 format).

primary_payment_source_id
STRING

The ID of the primary payment source for the customer.

Reference:

promotional_credits
INTEGER

The promotional credits balance of the customer.

referral_urls
ARRAY

A list of referral URLs for the customer.

created_at
DATE-TIME

The time the referral URL was created.

external_customer_id
STRING

The ID of the external customer in the referral system.

referral_account_id
STRING

The ID of the referral account.

referral_campaign_id
STRING

The ID of the referral campaign.

referral_external_account_id
STRING

The ID of the external referral account.

referral_sharing_url
STRING

The referral sharing URL for the customer.

referral_system
STRING

The URL for the referral system account. Possible values are:

  • referral_candy
  • referral_saasquatch
  • friendbuy

updated_at
DATE-TIME

The time the referral URL was last updated.

customers (table), referral_urls (attribute)

refundable_credits
INTEGER

The refundable credits balance of the customer.

registered_for_gst
BOOLEAN

Indicates if the customer is registered under GST. Available for Australia only.

resource_version
INTEGER

The version number of the customer. Each update of the customer results in an incremental change of this value. Note: This attribute will be present only if the customer has been updated after 2016-09-28.

taxability
STRING

Indicates if the customer is liable for tax. Possible values are:

  • taxable
  • exempt

unbilled_charges
INTEGER

The total unbilled charges for the customer.

vat_number
STRING

The VAT number for the customer.

vat_number_status
STRING

Applicable only if EU and Australian taxes are configured and the VAT number validation is enabled. Possible values are:

  • valid
  • invalid
  • not_validated
  • undetermined

vat_number_validated_time
DATE-TIME


Replication Method :

Key-based Incremental

Replication Key :

occurred_at

Primary Key :

id

API endpoint :

List events

The events table contains info about the events that have occurred on your Chargebee site. Event records contain data about affected resources and additional details, such as when the change occurred. This can be used to create a log of events for a record and analyze how it has changed over time.

id
STRING

The event ID.

occurred_at
DATE-TIME

The time the event occurred.

api_version
STRING

The Chargebee API version used for rendering the event content.

content
OBJECT

The data associated with the event.

addon
OBJECT

accounting_code
STRING

accouting_category1
STRING

accouting_category2
STRING

archived_at
DATE-TIME

avalara_sale_type
STRING

avalara_service_type
INTEGER

avalara_transaction_type
INTEGER

charge_type
STRING

currency_code
STRING

custom_fields
STRING

description
STRING

enabled_in_portal
BOOLEAN

id
STRING

invoice_name
STRING

invoice_notes
STRING

is_shippable
BOOLEAN

meta_data
STRING

custom_fields
STRING

name
STRING

object
STRING

period
INTEGER

period_unit
STRING

price
INTEGER

pricing_model
STRING

resource_version
INTEGER

shipping_frequency_period
INTEGER

shipping_frequency_period_unit
STRING

sku
STRING

status
STRING

tax_code
STRING

tax_profile_id
STRING

taxable
BOOLEAN

tiers
ARRAY

ending_unit
INTEGER

price
INTEGER

starting_unit
INTEGER

events (table), tiers (attribute)

type
STRING

unit
STRING

updated_at
DATE-TIME

events (table), addon (attribute)

coupon
OBJECT

addon_constraint
STRING

addon_ids
ARRAY

value
STRING

events (table), addon_ids (attribute)

apply_discount_on
STRING

apply_on
STRING

archived_at
DATE-TIME

created_at
DATE-TIME

currency_code
STRING

discount_amount
NUMBER

discount_percentage
NUMBER

discount_type
STRING

duration_month
INTEGER

duration_type
STRING

id
STRING

invoice_name
STRING

invoice_notes
STRING

max_redemptions
INTEGER

meta_data
STRING

name
STRING

object
STRING

plan_constraint
STRING

plan_ids
ARRAY

value
STRING

events (table), plan_ids (attribute)

redemptions
INTEGER

resource_version
INTEGER

status
STRING

updated_at
DATE-TIME

events (table), coupon (attribute)

coupon_code
OBJECT

code
STRING

coupon_id
STRING

coupon_set_name
STRING

coupon_site_id
STRING

status
STRING

events (table), coupon_code (attribute)

coupon_set
OBJECT

archived_count
INTEGER

coupon_id
STRING

id
STRING

meta_data
STRING

name
STRING

redeemed_count
INTEGER

total_count
INTEGER

events (table), coupon_set (attribute)

credit_note
OBJECT

allocations
ARRAY

allocated_amount
INTEGER

allocated_at
DATE-TIME

invoice_date
DATE-TIME

invoice_id
STRING

invoice_status
STRING

events (table), allocations (attribute)

amount_allocated
INTEGER

amount_available
INTEGER

amount_refunded
INTEGER

currency_code
STRING

customer_id
STRING

date
DATE-TIME

deleted
BOOLEAN

discounts
ARRAY

amount
INTEGER

description
STRING

entity_id
STRING

entity_type
STRING

events (table), discounts (attribute)

id
STRING

line_item_discounts
ARRAY

coupon_id
STRING

discount_amount
INTEGER

discount_type
STRING

line_item_id
STRING

events (table), line_item_discounts (attribute)

line_item_taxes
ARRAY

is_non_compliance_tax
BOOLEAN

is_partial_tax_applied
BOOLEAN

line_item_id
STRING

tax_amount
INTEGER

tax_juris_code
STRING

tax_juris_name
STRING

tax_juris_type
STRING

tax_name
STRING

tax_rate
NUMBER

taxable_amount
INTEGER

events (table), line_item_taxes (attribute)

line_item_tiers
ARRAY

ending_unit
INTEGER

line_item_id
STRING

quantity_used
INTEGER

starting_unit
INTEGER

unit_amount
INTEGER

events (table), line_item_tiers (attribute)

line_items
ARRAY

amount
INTEGER

date_from
DATE-TIME

date_to
DATE-TIME

description
STRING

discount_amount
INTEGER

entity_id
STRING

entity_type
STRING

id
STRING

is_taxed
BOOLEAN

item_level_discount_amount
INTEGER

pricing_model
STRING

quantity
INTEGER

subscription_id
STRING

tax_amount
INTEGER

tax_exempt_reason
STRING

tax_rate
NUMBER

unit_amount
INTEGER

events (table), line_items (attribute)

linked_refunds
ARRAY

applied_amount
INTEGER

applied_at
DATE-TIME

txn_amount
INTEGER

txn_date
DATE-TIME

txn_id
STRING

txn_status
STRING

events (table), linked_refunds (attribute)

price_type
STRING

reason_code
STRING

reference_invoice_id
STRING

refunded_at
DATE-TIME

resource_version
INTEGER

round_off_amount
INTEGER

status
STRING

sub_total
INTEGER

subscription_id
STRING

taxes
ARRAY

amount
INTEGER

description
STRING

name
STRING

events (table), taxes (attribute)

total
INTEGER

type
STRING

updated_at
DATE-TIME

vat_number
STRING

voided_at
DATE-TIME

events (table), credit_note (attribute)

customer
OBJECT

allow_direct_debit
BOOLEAN

auto_collection
STRING

backup_payment_source_id
STRING

balances
ARRAY

currency_code
STRING

excess_payments
INTEGER

promotional_credits
INTEGER

refundable_credits
INTEGER

unbilled_charges
INTEGER

events (table), balances (attribute)

billing_address
OBJECT

city
STRING

company
STRING

country
STRING

email
STRING

first_name
STRING

last_name
STRING

line1
STRING

line2
STRING

line3
STRING

phone
STRING

state
STRING

state_code
STRING

validation_status,
STRING

zip
STRING

events (table), billing_address (attribute)

billing_date
BOOLEAN

billing_date_mode
STRING

billing_day_of_week
BOOLEAN

billing_day_of_week_mode
STRING

card_status
STRING

cf_company_id
INTEGER

company
STRING

consolidated_invoicing
BOOLEAN

contacts
ARRAY

email
STRING

enabled
BOOLEAN

first_name
STRING

id
STRING

label
STRING

last_name
STRING

object
STRING

phone
STRING

send_account_email
STRING

send_billing_email
STRING

events (table), contacts (attribute)

created_at
DATE-TIME

created_from_ip
STRING

custom_fields
STRING

customer_type
STRING

deleted
BOOLEAN

email
STRING

entity_code
STRING

excess_payments
INTEGER

exempt_number
STRING

exemption_details
STRING

custom_fields
STRING

first_name
STRING

fraud_flag
STRING

id
STRING

invoice_notes
STRING

is_location_valid
BOOLEAN

last_name
STRING

locale
STRING

meta_data
STRING

net_term_days
INTEGER

object
STRING

payment_method
OBJECT

gateway
STRING

gateway_account_id
STRING

object
STRING

reference_id
STRING

status
STRING

type
STRING

events (table), payment_method (attribute)

phone
STRING

pii_cleared
STRING

preferred_currency_code
STRING

primary_payment_source_id
STRING

promotional_credits
INTEGER

referral_urls
ARRAY

created_at
DATE-TIME

external_customer_id
STRING

referral_account_id
STRING

referral_campaign_id
STRING

referral_external_account_id
STRING

referral_sharing_url
STRING

referral_system
STRING

updated_at
DATE-TIME

events (table), referral_urls (attribute)

refundable_credits
INTEGER

registered_for_gst
BOOLEAN

resource_version
INTEGER

taxability
STRING

unbilled_charges
INTEGER

updated_at
DATE-TIME

vat_number
STRING

vat_number_status
STRING

vat_number_validated_time
DATE-TIME

events (table), customer (attribute)

gift
OBJECT

auto_claim
BOOLEAN

claim_expiry_date
DATE-TIME

gift_receiver
OBJECT

customer_id
STRING

email
STRING

first_name
STRING

last_name
STRING

subscription_id
STRING

events (table), gift_receiver (attribute)

gift_timelines
ARRAY

occurred_at
DATE-TIME

status
STRING

events (table), gift_timelines (attribute)

gifter
OBJECT

customer_id
STRING

invoice_id
STRING

note
STRING

signature
STRING

events (table), gifter (attribute)

id
STRING

resource_version
INTEGER

scheduled_at
DATE-TIME

status
STRING

updated_at
DATE-TIME

events (table), gift (attribute)

invoice
OBJECT

adjustment_credit_notes
ARRAY

cn_date
DATE-TIME

cn_id
STRING

cn_reason_code
STRING

cn_status
STRING

cn_total
INTEGER

events (table), adjustment_credit_notes (attribute)

amount_adjusted
INTEGER

amount_due
INTEGER

amount_paid
INTEGER

amount_to_collect
INTEGER

applied_credits
ARRAY

applied_amount
INTEGER

applied_at
DATE-TIME

cn_date
DATE-TIME

cn_id
STRING

cn_reason_code
STRING

cn_status
STRING

events (table), applied_credits (attribute)

base_currency_code
STRING

billing_address
OBJECT

city
STRING

company
STRING

country
STRING

email
STRING

first_name
STRING

last_name
STRING

line1
STRING

line2
STRING

line3
STRING

object
STRING

phone
STRING

state
STRING

state_code
STRING

validation_status
STRING

zip
STRING

events (table), billing_address (attribute)

credits_applied
INTEGER

currency_code
STRING

customer_id
STRING

date
DATE-TIME

deleted
BOOLEAN

discounts
ARRAY

amount
INTEGER

description
STRING

entity_id
STRING

entity_type
STRING

object
STRING

events (table), discounts (attribute)

due_date
DATE-TIME

dunning_status
STRING

exchange_rate
NUMBER

expected_payment_date
DATE-TIME

first_invoice
BOOLEAN

has_advance_charges
BOOLEAN

id
STRING

is_gifted
BOOLEAN

issued_credit_notes
ARRAY

cn_date
DATE-TIME

cn_id
STRING

cn_reason_code
STRING

cn_status
STRING

cn_total
INTEGER

events (table), issued_credit_notes (attribute)

line_item_discounts
ARRAY

coupon_id
STRING

discount_amount
INTEGER

discount_type
STRING

line_item_id
STRING

events (table), line_item_discounts (attribute)

line_item_taxes
ARRAY

is_non_compliance_tax
BOOLEAN

is_partial_tax_applied
BOOLEAN

line_item_id
STRING

tax_amount
INTEGER

tax_juris_code
STRING

tax_juris_name
STRING

tax_juris_type
STRING

tax_name
STRING

tax_rate
INTEGER

taxable_amount
INTEGER

events (table), line_item_taxes (attribute)

line_item_tiers
ARRAY

ending_unit
INTEGER

line_item_id
STRING

quantity_used
INTEGER

starting_unit
INTEGER

unit_amount
INTEGER

events (table), line_item_tiers (attribute)

line_items
ARRAY

amount
INTEGER

date_from
DATE-TIME

date_to
DATE-TIME

description
STRING

discount_amount
INTEGER

entity_id
STRING

entity_type
STRING

id
STRING

is_taxed
BOOLEAN

item_level_discount_amount
INTEGER

object
STRING

pricing_model
STRING

quantity
INTEGER

subscription_id
STRING

tax_amount
INTEGER

tax_exempt_reason
STRING

tax_rate
INTEGER

unit_amount
INTEGER

events (table), line_items (attribute)

linked_orders
ARRAY

batch_id
STRING

created_at
DATE-TIME

document_number
STRING

fulfillment_status
STRING

id
STRING

order_type
STRING

reference_id
STRING

status
STRING

events (table), linked_orders (attribute)

linked_payments
ARRAY

applied_amount
INTEGER

applied_at
DATE-TIME

txn_amount
INTEGER

txn_date
DATE-TIME

txn_id
STRING

txn_status
STRING

events (table), linked_payments (attribute)

net_term_days
INTEGER

new_sales_amount
INTEGER

next_retry_at
DATE-TIME

notes
ARRAY

entity_id
STRING

entity_type
STRING

note
STRING

events (table), notes (attribute)

object
STRING

paid_at
DATE-TIME

po_number
STRING

price_type
STRING

recurring
BOOLEAN

resource_version
INTEGER

round_off_amount
INTEGER

shipping_address
OBJECT

city
STRING

company
STRING

country
STRING

email
STRING

first_name
STRING

last_name
STRING

line1
STRING

line2
STRING

line3
STRING

phone
STRING

state
STRING

state_code
STRING

validation_status,
STRING

zip
STRING

events (table), shipping_address (attribute)

status
STRING

sub_total
INTEGER

subscription_id
STRING

tax
INTEGER

taxes
ARRAY

amount
INTEGER

description
STRING

name
STRING

events (table), taxes (attribute)

term_finalized
BOOLEAN

total
INTEGER

updated_at
DATE-TIME

vat_number
STRING

voided_at
DATE-TIME

write_off_amount
INTEGER

events (table), invoice (attribute)

order
OBJECT

amount_adjusted
INTEGER

amount_paid
INTEGER

batch_id
STRING

billing_address
OBJECT

city
STRING

company
STRING

country
STRING

email
STRING

first_name
STRING

last_name
STRING

line1
STRING

line2
STRING

line3
STRING

object
STRING

phone
STRING

state
STRING

state_code
STRING

validation_status
STRING

zip
STRING

events (table), billing_address (attribute)

cancellation_reason
STRING

cancelled_at
DATE-TIME

created_at
DATE-TIME

created_by
STRING

currency_code
STRING

customer_id
STRING

deleted
BOOLEAN

delivered_at
DATE-TIME

discount
INTEGER

document_number
STRING

fulfillment_status
STRING

gift_id
STRING

gift_note
STRING

id
STRING

invoice_id
STRING

invoice_round_off_amount
INTEGER

is_gifted
BOOLEAN

line_item_discounts
ARRAY

coupon_id
STRING

discount_amount
INTEGER

discount_type
STRING

line_item_id
STRING

events (table), line_item_discounts (attribute)

line_item_taxes
ARRAY

is_non_compliance_tax
BOOLEAN

is_partial_tax_applied
BOOLEAN

line_item_id
STRING

tax_amount
INTEGER

tax_juris_code
STRING

tax_juris_name
STRING

tax_juris_type
STRING

tax_name
STRING

tax_rate
INTEGER

taxable_amount
INTEGER

events (table), line_item_taxes (attribute)

linked_credit_notes
ARRAY

amount
INTEGER

amount_adjusted
INTEGER

amount_refunded
INTEGER

id
STRING

status
STRING

type
STRING

events (table), linked_credit_notes (attribute)

note
STRING

order_date
DATE-TIME

order_line_items
ARRAY

amount
INTEGER

amount_adjusted
INTEGER

amount_paid
INTEGER

description
STRING

discount_amount
INTEGER

entity_id
STRING

entity_type
STRING

fulfillment_amount
INTEGER

fulfillment_quantity
INTEGER

id
STRING

invoice_id
STRING

invoice_line_item_id
STRING

is_shippable
BOOLEAN

item_level_discount_amount