Chargebee

tap-chargebee (hotgluexyz variant)

Subscription billing software

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

Available Variants

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
    :
  2. meltano add extractor tap-chargebee
  3. Configure the tap-chargebee settings using
    meltano config
    :
  4. meltano config tap-chargebee set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-chargebee test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-chargebee may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • catalog
  • discover
  • state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-chargebee settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using

meltano config
with the list subcommand:

meltano config tap-chargebee list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

API Key (api_key)

  • Environment variable: TAP_CHARGEBEE_API_KEY

Your Chargebee API Key


Configure this setting directly using the following Meltano command:

meltano config tap-chargebee set api_key [value]

Site (site)

  • Environment variable: TAP_CHARGEBEE_SITE

Your Chargebee site {site}.chargebee.com


Configure this setting directly using the following Meltano command:

meltano config tap-chargebee set site [value]

Product Catalog (product_catalog)

  • Environment variable: TAP_CHARGEBEE_PRODUCT_CATALOG

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


Configure this setting directly using the following Meltano command:

meltano config tap-chargebee set product_catalog [value]

Start Date (start_date)

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


Configure this setting directly using the following Meltano command:

meltano config tap-chargebee set start_date [value]

Select Fields By Default (select_fields_by_default)

  • Environment variable: TAP_CHARGEBEE_SELECT_FIELDS_BY_DEFAULT
  • Default Value: true

Select by default any new fields discovered in Quickbooks objects


Configure this setting directly using the following Meltano command:

meltano config tap-chargebee set select_fields_by_default [value]

State Message Threshold (state_message_threshold)

  • Environment variable: TAP_CHARGEBEE_STATE_MESSAGE_THRESHOLD
  • Default Value: 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).


Configure this setting directly using the following Meltano command:

meltano config tap-chargebee set state_message_threshold [value]

Max Workers (max_workers)

  • Environment variable: TAP_CHARGEBEE_MAX_WORKERS
  • Default Value: 8

Maximum number of threads to use


Configure this setting directly using the following Meltano command:

meltano config tap-chargebee set max_workers [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

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.

Install

meltano add extractor tap-chargebee

Maintenance Status

  • Maintenance Status

Repo

https://github.com/hotgluexyz/tap-chargebee
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Hotglue

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

Keywords

  • api