The tap-chargebee Singer tap pulls data from Chargebee that can then be sent to a destination using a Singer target.

Alternative variants #

Multiple variants of tap-chargebee are available. This document describes the default hotgluexyz variant, which is recommended for new users.

Alternative variants are:

Standalone usage #

Install the package using pip: 

pip install git+https://github.com/hotgluexyz/tap-chargebee.git

For additional instructions, refer to the README in the repository.

Usage with Meltano #

Meltano helps you manage your configuration, incremental replication, and scheduled pipelines.

View the Meltano-specific tap-chargebee instructions to learn more.

Capabilities #

Settings #

tap-chargebee requires the configuration of the following settings:

These and other supported settings are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

API Key (api_key) #

Your Chargebee API Key

Site (site) #

Your Chargebee site {site}.chargebee.com

Product Catalog (product_catalog) #

The Chargebee product catalog you wish to use. Valid values are 1.0 or 2.0.

Start Date (start_date) #

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

Select Fields By Default (select_fields_by_default) #

  • Default: true

Select by default any new fields discovered in Quickbooks objects

State Message Threshold (state_message_threshold) #

  • Default: 1000

Used to throttle how often STATE messages are generated when the tap is using the “REST” API.

This is a balance between not slowing down execution due to too many STATE messages produced and how many records must be fetched again if a tap fails unexpectedly. Defaults to 1000 (generate a STATE message every 1000 records).

Max Workers (max_workers) #

  • Default: 8

Maximum number of threads to use

Looking for help? #

If you're having trouble getting the tap-chargebee tap to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!