# Chargebee

The tap-chargebee extractor pulls data from the Chargebee API.

# 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

# Using the Command Line Interface

  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.

# Using Meltano UI

  1. Start Meltano UI using meltano ui:

    meltano ui
    
  2. Open the Extractors interface at http://localhost:5000/extractors.

  3. Click the "Add to project" button for "Chargebee".

  4. Configure the settings below in the "Configuration" interface that opens automatically.

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

# 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 in the sidebar.

# Minimal configuration

A minimal configuration of tap-chargebee in your meltano.yml project file will look like this:





 
 
 


plugins:
  extractors:
  - name: tap-chargebee
    variant: hotgluexyz
    config:
      product_catalog: '1.0'
      site: 'example.chargebee.com'
      start_date: '2020-10-01T00:00:00Z'

Sensitive values are most appropriately stored in the environment or your project's .env file:

export TAP_CHARGEBEE_API_KEY=my_client_id

# API Key

Your Chargebee API Key

# How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-chargebee set api_key <api key>

export TAP_CHARGEBEE_API_KEY=<api key>

# Site

Your Chargebee site {site}.chargebee.com

# How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-chargebee set chargebee_site <site>

export TAP_CHARGEBEE_SITE=<site>

# 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 UI, meltano config, or an environment variable:

meltano config tap-chargebee set product_catalog <product catalog>

export TAP_CHARGEBEE_PRODUCT_CATALOG=<product catalog>

# Start Date

This property 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 UI, 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

# For example:
meltano config tap-chargebee set start_date 2020-10-01T00:00:00Z

export TAP_CHARGEBEE_START_DATE=2020-10-01T00:00:00Z

# Select Fields By Default

  • Name: select_fields_by_default
  • Environment variable: TAP_CHARGEBEE_SELECT_FIELDS_BY_DEFAULT
  • Default: true

Select by default any new fields discovered in Chargebee objects

# How to use

Manage this setting using Meltano UI, 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

  • Name: state_message_threshold
  • Environment variable: TAP_CHARGEBEE_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).

# How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-chargebee set state_message_threshold 500

export TAP_CHARGEBEE_STATE_MESSAGE_THRESHOLD=500

# Max Workers

Maximum number of threads to use

# How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-chargebee set max_workers 16

export TAP_CHARGEBEE_MAX_WORKERS=16