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
  • Comments
  • 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

   pip install tap-chargebee

2. Create the config file

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

   {
       "start_date": "2010-01-01T00:00:00Z",
       "api_key": "<Chargebee API Key>",
       "site": "<Chargebee Site>",
       "include_deleted": "True|False",
       "request_timeout": 300
   }

   The start_date specifies the date in ISO(YYYY-mm-ddTHH:MM:SSZ) format 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 include_deleted is an optional flag to ask if you want deleted records of all streams or not. Default: true

   The request_timeout is an optional paramater to set timeout for requests. Default: 300 seconds

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