dreadjr / tap-chargebee

Singer.io tap for extracting data from the Chargebee API

tap-chargebee

This is a Singer tap that produces JSON-formatted data following the Singer spec.

This tap:

• Pulls raw data from the Chargebee API
• Extracts the following resources:
  • Addons
  • Coupons
  • Credit Notes
  • Customers
  • Events
  • Gifts
  • Invoices
  • Orders
  • Payment Sources
  • Plans
  • Subscriptions
  • Transactions
  • Virtual Bank Accounts
• Outputs the schema for each resource
• Incrementally pulls data based on the input state

Quick Start

1. Install the tap locally

   pip install -e .

2. Create the config file

   Create a JSON file called config.json. Its contents should look like:

    {
        "start_date": "2010-01-01",
        "api_key": "<Chargebee API Key>",
        "site": "<Chargebee Site>",
        "product_catalog": "1.0"
    }

   The start_date specifies the date at which the tap will begin pulling data (for those resources that support this).

   The api_key is the API key for your Chargebee site.

   The site parameter represents the name of your specific Chargebee site (e.g. https://{site}.chargebee.com/api/v2/subscriptions)

   The product_catalog is which Chargebee product catalog to use. Valid arguments are 1.0 or 2.0

3. Run the Tap in Discovery Mode

   tap-chargebee --config config.json --discover > catalog.json

   See the Singer docs on discovery mode here.

4. Run the Tap in Sync Mode

   tap-chargebee --config config.json --catalog catalog.json

---

Copyright © 2019 Stitch