The tap-chargebee Meltano extractor pulls data from Chargebee that can then be sent to a destination using a loader.

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:

Getting Started #

Prerequisites #

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration #

  1. Add the tap-chargebee extractor to your project using meltano add :

    meltano add extractor tap-chargebee
  2. Configure the settings below using meltano config .

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline
If you run into any issues, learn how to get help.

Capabilities #

Settings #

tap-chargebee requires the configuration of the following settings:

The settings for extractor tap-chargebee that are known to Meltano 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

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-chargebee set api_key <api_key>

export TAP_CHARGEBEE_API_KEY=<api_key>

Site (site) #

Your Chargebee site {site}.chargebee.com

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-chargebee set site <site>

export TAP_CHARGEBEE_SITE=<site>

Product Catalog (product_catalog) #

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

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-chargebee set product_catalog <product_catalog>

export TAP_CHARGEBEE_PRODUCT_CATALOG=<product_catalog>

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.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-chargebee set start_date YYYY-MM-DDTHH:MM:SSZ

export TAP_CHARGEBEE_START_DATE=YYYY-MM-DDTHH:MM:SSZ

Select Fields By Default (select_fields_by_default) #

Select by default any new fields discovered in Quickbooks objects

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-chargebee set select_fields_by_default false

export TAP_CHARGEBEE_SELECT_FIELDS_BY_DEFAULT=false

State Message Threshold (state_message_threshold) #

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).

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-chargebee set state_message_threshold 1000

export TAP_CHARGEBEE_STATE_MESSAGE_THRESHOLD=1000

Max Workers (max_workers) #

Maximum number of threads to use

How to use #

Manage this setting using meltano config or an environment variable:

meltano config tap-chargebee set max_workers 8

export TAP_CHARGEBEE_MAX_WORKERS=8

Looking for help? #

If you're having trouble getting the tap-chargebee extractor 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!