yuanminglee/tap-chargify

tap-chargify

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

This tap:

• Pulls raw data from the Chargify API
• Extracts the following resources:
  • Components
  • Coupons
  • Customers
  • Events
  • Invoices
  • Price points
  • Product families
  • Products
  • Statements
  • Subscriptions
  • Transactions
• Outputs the schema for each resource
• Incrementally pulls data based on the input state

---

Streams

components

• Endpoint: https://reference.chargify.com/v1/components/list-components-for-a-product-family
• Primary key field: id
• Replication strategy: FULL_TABLE

coupons

• Endpoint: https://reference.chargify.com/v1/coupons-editing/list-product-family-coupons
• Primary key field: id
• Replication strategy: FULL_TABLE

customers

• Endpoint: https://reference.chargify.com/v1/customers/list-customers-for-a-site
• Primary key field: id
• Replication strategy: INCREMENTAL

events

• Endpoint: https://reference.chargify.com/v1/events/list-events-for-a-site
• Primary key field: id
• Replication strategy: INCREMENTAL
• Bookmark: created_at

invoices

• Endpoint: https://reference.chargify.com/v1/invoices-legacy/list-all-invoices-by-subscription
• Primary key field: id
• Replication strategy: INCREMENTAL
• Bookmark: due_date

components_price_points

• Endpoint: https://reference.chargify.com/v1/components/list-price-points
• Primary key field: id
• Replication strategy: FULL_TABLE

product_families

• Endpoint: https://reference.chargify.com/v1/product-families/list-product-family-via-site
• Primary key field: id
• Replication strategy: FULL_TABLE

products

• Endpoint: https://reference.chargify.com/v1/products/list-products
• Primary key field: id
• Replication strategy: FULL_TABLE

statements

• Endpoint: https://reference.chargifys.com/v1/statements/list-statements-for-a-site
• Primary key field: id
• Replication strategy: FULL_TABLE

subscriptions

• Endpoint: https://reference.chargify.com/v1/subscriptions/list-subscriptions
• Primary key field: id
• Replication strategy: INCREMENTAL
• Bookmark: updated_at

transactions

• Endpoint: https://reference.chargify.com/v1/transactions/list-transactions-for-the-site
• Primary key field: id
• Replication strategy: INCREMENTAL
• Bookmark: created_at

offers

• Endpoint: https://reference.chargify.com/v1/offers/list-offers
• Primary key field: id
• Replication strategy: FULL_TABLE

product_price_points

• Endpoint: https://reference.chargify.com/v1/products-price-points/read-product-price-points
• Primary key field: id
• Replication strategy: FULL_TABLE

subscriptions_components

• Endpoint: https://reference.chargify.com/v1/subscriptions-components/list-components-for-a-subscription
• Primary key field: component_id,subscription_id
• Replication strategy: FULL_TABLE

coupon_usages

• Endpoint: https://reference.chargify.com/v1/coupons/list-coupon-usages
• Primary key field: id
• Replication strategy: FULL_TABLE

credit_notes

• Endpoint: https://reference.chargify.com/v1/relationship-invoicing/read-all-credit-notes
• Primary key field: uid
• Replication strategy: FULL_TABLE

account_balances

• Endpoint: https://reference.chargify.com/v1/relationship-invoicing/read-account-balances
• Primary key field: subscription_id
• Replication strategy: FULL_TABLE

payment_profiles

• Endpoint: https://reference.chargify.com/v1/payment-profiles/list-payment-profiles
• Primary key field: id
• Replication strategy: FULL_TABLE

reason_codes

• Endpoint: https://reference.chargify.com/v1/reason-codes/index-view
• Primary key field: id
• Replication strategy: FULL_TABLE

subscription_groups

• Endpoint: https://reference.chargify.com/v1/subscription-groups/read-subscription-groups
• Primary key field: uid
• Replication strategy: FULL_TABLE

proforma_invoices

• Endpoint: https://reference.chargify.com/v1/proforma-invoices/read-all-subscription-proforma-invoices
• Primary key field: uid
• Replication strategy: FULL_TABLE

---

Quick Start

1. Install the tap using the following command:

   > pip install tap-chargify
   

2. Create the config file, which is a JSON file named config.json. This file should contain the following properties:

   • api_key - A Chargify API key. Refer to the Chargify documentation for instructions on creating an API key.
   • start_date - The date from which the tap should begin replicating data. This value must be an ISO 8601-compliant date.
   • subdomain The subdomain of your Chargify site. For example: If the full URL were https://test.my-chargify-site.com, this value would be test.

   {
     "api_key": "xx",
     "start_date": "2018-02-22T02:06:58.147Z",
     "subdomain": "test"
   }

3. Run the tap in Discovery Mode using the following command:

   > tap-chargify -c config.json -d
   

   See the Singer docs on discovery mode here.

4. Run the tap in Sync Mode using the following command:

   > tap-chargify -c config.json --catalog catalog-file.json
   

Development

1. Clone this repository.

2. In the directory, run the following command:

   > python -m venv tap-chargify
   > make dev
   

---

Copyright © 2019 Stitch