Chargebee

This connector captures data from Chargebee into Flow collections.

It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/source-chargebee:dev provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.

This connector is based on an open-source connector from a third party, with modifications for performance in the Flow system. You can find their documentation here, but keep in mind that the two versions may be significantly different.

Supported data resources

The following data resources are supported through the Chargebee APIs:

• Subscriptions
• Customers
• Invoices
• Orders
• Plans
• Addons
• Items
• Item Prices
• Attached Items

By default, each resource is mapped to a Flow collection through a separate binding.

Prerequisites

• To set up the Chargebee source connector, you'll need the Chargebee API key and the Product Catalog version.

Configuration

You configure connectors either in the Flow web app, or by directly editing the catalog specification file. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the Chargebee source connector.

Properties

Endpoint

Property	Title	Description	Type	Required/Default
/site_api_key	API Key	Chargebee API Key.	string	Required
/site	Site	The site prefix for your Chargebee instance.	string	Required
/start_date	Start Date	UTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated.	string	Required
/product_catalog	Product Catalog	Product Catalog version of your Chargebee site. Instructions on how to find your version you may find under 'API Version' section in the Chargebee docs.	string	Required

Bindings

Property	Title	Description	Type	Required/Default
/stream	Stream	Resource of your Chargebee project from which collections are captured.	string	Required
/syncMode	Sync Mode	Connection method.	string	Required

Sample

captures:
  ${PREFIX}/${CAPTURE_NAME}:
    endpoint:
      connector:
        image: ghcr.io/estuary/source-chargebee:dev
        config:
          site_api_key: <secret>
          site: <your site>
          start_date: 2017-01-25T00:00:00Z
          product_catalog: <your product catalog>
    bindings:
      - resource:
          stream: items
          syncMode: full_refresh
        target: ${PREFIX}/items
      {...}