Chargify integration summary

Stitch’s Chargify integration replicates data using the Chargify API. Refer to the Schema section for a list of objects available for replication.

Chargify feature snapshot

A high-level look at Stitch's Chargify (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Beta

 Supported by

Singer Community
Stitch plan

Standard

 API availability

Available
Singer GitHub repository

singer-io/tap-chargify
REPLICATION SETTINGS
Anchor Scheduling

Supported

 Advanced Scheduling

Supported
Table-level reset

Unsupported

 Configurable Replication Methods

Unsupported
DATA SELECTION
Table selection

Supported

 Column selection

Supported
Select all

Supported
TRANSPARENCY
Extraction Logs

Supported

 Loading Reports

Supported

Connecting Chargify

Chargify setup requirements

To set up Chargify in Stitch, you need:

  • Owner or Admin access in Chargify. A user with either level of access is required to create an API key for Stitch.

Step 1: Create a Chargify API key

  1. Sign into your Chargify account as a user with either Owner or Admin access.
  2. Navigate to Config > Integrations.
  3. Click New API Key.
  4. Copy your API key somewhere secure.

Step 2: Add Chargify as a Stitch data source

  1. Sign into your Stitch account.

  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Chargify icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Chargify” would create a schema called stitch_chargify in the destination. Note: Schema names cannot be changed after you save the integration.

  5. In the API Key field, paste the API key you created in Step 1.
  6. In the Subdomain field, enter your Chargify subdomain. For example: If the full URL of your Chargify site were https://stitch.my-chargify-site.com, this value would be stitch.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Chargify integration. This means that:

  • For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
  • For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.

Change this setting if you want to replicate data beyond Chargify’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 4: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Chargify integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 5: Set objects to replicate

The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

For Chargify integrations, you can select:

  1. Individual tables and columns

  2. All tables and columns

Click the tabs to view instructions for each selection method.

  1. In the integration’s Tables to Replicate tab, locate a table you want to replicate.

  2. To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
  1. Click into the integration from the Stitch Dashboard page.

  2. Click the Tables to Replicate tab.

  3. In the list of tables, click the box next to the Table Names column.

  4. In the menu that displays, click Track all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab

  5. Click the Finalize Your Selections button at the bottom of the page to save your data selections.

Initial and historical replication jobs

After you finish setting up Chargify, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Chargify table reference

components

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

id
API endpoint :

Read components for a product family

The components table contains info about components associated with a product family in Chargify.

components table schema

id
NUMBER

The component ID.

Reference:

archived
BOOLEAN

created_at
DATE-TIME

default_price_point_id
NUMBER

Reference:

default_price_point_name
STRING

description
STRING

downgrade_credit
STRING

handle
STRING

kind
STRING

name
STRING

price_per_unit_in_cents
STRING

price_point_count
NUMBER

price_points_url
STRING

prices
OBJECT

pricing_scheme
STRING

product_family_id
NUMBER

Reference:

product_family_name
STRING

recurring
BOOLEAN

tax_code
STRING

taxable
BOOLEAN

unit_name
STRING

unit_price
NUMBER

upgrade_charge
STRING

coupons

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

id
API endpoint :

Read coupons for a specific product family

The coupons table contains info about coupons associated with a product family in Chargify.

coupons table schema

id
INTEGER

The coupon ID.

allow_negative_balance
BOOLEAN

amount_in_cents
NUMBER

archived_at
DATE-TIME

code
STRING

compounding_strategy
STRING

conversion_limit
NUMBER

coupon_restrictions
ARRAY

Click to expand coupon_restrictions

value
ANYTHING

coupons (table), coupon_restrictions (attribute)

created_at
DATE-TIME

description
STRING

duration_interval
INTEGER

duration_interval_unit
STRING

duration_period_count
NUMBER

end_date
DATE-TIME

name
STRING

percentage
NUMBER

product_family_id
INTEGER

Reference:

recurring
BOOLEAN

stackable
BOOLEAN

start_date
DATE-TIME

updated_at
DATE-TIME

customers

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

id
API endpoint :

Read customers for a site

The customers table contains info about customers associated with your Chargify site.

customers table schema

id
INTEGER

The customer ID.

Reference:

address
STRING

address_2
STRING

cc_emails
STRING

city
STRING

country
STRING

created_at
DATE-TIME

first_name
STRING

last_name
STRING

organization
STRING

parent_id
INTEGER

Reference:

phone
STRING

portal_customer_created_at
DATE-TIME

portal_invite_last_accepted_at
DATE-TIME

portal_invite_last_sent_at
DATE-TIME

reference
INTEGER

state
STRING

tax_exempt
BOOLEAN

updated_at
DATE-TIME

vat_number
STRING

verified
BOOLEAN

zip
STRING

events

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

id
API endpoint :

List events for a site

The events table contains info about activity on your Chargify site.

invoices

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

due_date

Primary Key :

id

 API endpoint :

Read all invoices

The invoices table contains info about invoices in your Chargify instance.

invoices table schema

id
NUMBER

The invoice ID.

amount_due_in_cents
NUMBER

charges
ARRAY

Click to expand charges

amount_in_cents
NUMBER

component_id
NUMBER

Reference:

created_at
DATE-TIME

customer_id
NUMBER

Reference:

ending_balance_in_cents
NUMBER

gateway_order_id
NUMBER

gateway_transaction_id
STRING

id
NUMBER

kind
STRING

memo
STRING

payment_id
NUMBER

Reference:

product_id
NUMBER

Reference:

starting_balance_in_cents
NUMBER

subscription_id
NUMBER

Reference:

success
BOOLEAN

tax_id
NUMBER

transaction_type
STRING

type
STRING

invoices (table), charges (attribute)

created_at
DATE-TIME

number
NUMBER

paid_at
DATE-TIME

payments_and_credits
ARRAY

Click to expand payments_and_credits

amount_in_cents
NUMBER

card_expiration
STRING

card_number
STRING

card_type
STRING

component_id
NUMBER

Reference:

created_at
DATE-TIME

customer_id
NUMBER

Reference:

ending_balance_in_cents
NUMBER

gateway_order_id
NUMBER

gateway_transaction_id
STRING

id
NUMBER

kind
STRING

memo
STRING

payment_id
NUMBER

Reference:

product_id
NUMBER

Reference:

starting_balance_in_cents
NUMBER

subscription_id
NUMBER

Reference:

success
BOOLEAN

tax_id
NUMBER

transaction_type
STRING

type
STRING

invoices (table), payments_and_credits (attribute)

site_id
NUMBER

state
STRING

statement_id
NUMBER

Reference:

subscription_id
NUMBER

Reference:

total_amount_in_cents
NUMBER

updated_at
DATE-TIME

price_points

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

id
API endpoint :

Read product price points

The price_points table contains info about product price points in your Chargify instance.

products

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

id
API endpoint :

List products for a product family

The products table contains info about the prodcts in your Chargify instance.

products table schema

id
INTEGER

The product ID.

Reference:

accounting_code
STRING

archived_at
DATE-TIME

created_at
DATE-TIME

description
STRING

expiration_interval
STRING

expiration_interval_unit
STRING

handle
STRING

initial_charge_after_trial
BOOLEAN

initial_charge_in_cents
INTEGER

interval
INTEGER

interval_unit
STRING

name
STRING

price_in_cents
INTEGER

product_family
OBJECT

Click to expand product_family
products (table), product_family (attribute)

public_signup_pages
ARRAY

Click to expand public_signup_pages

value
ANYTHING

products (table), public_signup_pages (attribute)

request_credit_card
BOOLEAN

require_credit_card
BOOLEAN

return_params
STRING

tax_code
STRING

taxable
BOOLEAN

trial_interval
INTEGER

trial_interval_unit
STRING

trial_price_in_cents
INTEGER

update_return_params
STRING

update_return_url
STRING

updated_at
DATE-TIME

version_number
INTEGER

product_families

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

id
API endpoint :

Read product families for a site

The product_families table contains info about product families in your Chargify instance. Product families house your products, components, and coupons and are used to categorize products, product levels, or service offerings to your subscribers.

product_families table schema

id
INTEGER

The product family ID.

Reference:

accounting_code
STRING

description
STRING

handle
STRING

name
STRING

statements

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

id
API endpoint :

List statements for a site

The statements table contains info about the statements in your Chargify instance. Statements show all account activity for a specific usage period and are similar to invoices, as they can be marked as currently paid or unpaid.

statements table schema

id
NUMBER

The statement ID.

Reference:

basic_html_view
STRING

closed_at
DATE-TIME

created_at
DATE-TIME

customer_billing_address
STRING

customer_billing_address_2
STRING

customer_billing_city
STRING

customer_billing_country
STRING

customer_billing_state
STRING

customer_billing_zip
STRING

customer_first_name
STRING

customer_last_name
STRING

customer_organization
STRING

customer_shipping_address
STRING

customer_shipping_address_2
STRING

customer_shipping_city
STRING

customer_shipping_country
STRING

customer_shipping_state
STRING

customer_shipping_zip
STRING

ending_balance_in_cents
NUMBER

events
ARRAY

future_payments
ARRAY

Click to expand future_payments

value
ANYTHING

statements (table), future_payments (attribute)

html_view
STRING

memo
STRING

opened_at
DATE-TIME

settled_at
DATE-TIME

starting_balance_in_cents
NUMBER

subscription_id
NUMBER

Reference:

text_view
STRING

total_in_cents
NUMBER

transactions
ARRAY

Click to expand transactions

amount_in_cents
NUMBER

component_id
NUMBER

Reference:

created_at
DATE-TIME

customer_id
NUMBER

Reference:

discount_amount_in_cents
NUMBER

ending_balance_in_cents
NUMBER

gateway_order_id
NUMBER

gateway_transaction_id
STRING

gateway_used
STRING

id
NUMBER

Reference:

item_name
STRING

kind
STRING

memo
STRING

original_amount_in_cents
NUMBER

payment_id
NUMBER

product_id
NUMBER

Reference:

starting_balance_in_cents
NUMBER

statement_id
NUMBER

Reference:

subscription_id
NUMBER

Reference:

success
BOOLEAN

tax_id
NUMBER

taxable_amount_in_cents
NUMBER

taxations
ARRAY

Click to expand taxations

value
ANYTHING

statements (table), taxations (attribute)

transaction_type
STRING

type
STRING

statements (table), transactions (attribute)

updated_at
DATE-TIME

subscriptions

View table schema on GitHub
Replication Method :

Full Table

 Primary Key :

id
API endpoint :

Read subscriptions for a site

The subscriptions table contains info about the subscriptions in your Chargify instance.

subscriptions table schema

id
NUMBER

Reference:

activated_at
DATE-TIME

balance_in_cents
NUMBER

cancel_at_end_of_period
BOOLEAN

canceled_at
DATE-TIME

cancellation_message
STRING

cancellation_method
STRING

coupon_codes
STRING

created_at
DATE-TIME

credit_card
OBJECT

Click to expand credit_card

billing_address
STRING

billing_address_2
STRING

billing_city
STRING

billing_country
STRING

billing_state
STRING

billing_zip
STRING

card_type
STRING

current_vault
STRING

customer_id
NUMBER

Reference:

customer_vault_token
STRING

expiration_month
NUMBER

expiration_year
NUMBER

first_name
STRING

id
NUMBER

last_name
STRING

masked_card_number
STRING

payment_type
STRING

vault_token
STRING

subscriptions (table), credit_card (attribute)

current_period_ends_at
DATE-TIME

current_period_started_at
DATE-TIME

customer
OBJECT

Click to expand customer

address
STRING

address_2
STRING

cc_emails
STRING

city
STRING

country
STRING

created_at
DATE-TIME

email
STRING

first_name
STRING

id
NUMBER

Reference:

last_name
STRING

organization
STRING

phone
STRING

portal_customer_created_at
DATE-TIME

portal_invite_last_accepted_at
NUMBER

portal_invite_last_sent_at
DATE-TIME

reference
NUMBER

state
STRING

tax_exempt
BOOLEAN

updated_at
DATE-TIME

vat_number
STRING

verified
BOOLEAN

zip
STRING

subscriptions (table), customer (attribute)

delayed_cancel_at
DATE-TIME

expires_at
DATE-TIME

net_terms
NUMBER

next_assessment_at
DATE-TIME

next_product_id
NUMBER

Reference:

payment_collection_method
STRING

payment_type
STRING

previous_state
STRING

product
OBJECT

Click to expand product

accounting_code
STRING

archived_at
DATE-TIME

created_at
DATE-TIME

description
STRING

expiration_interval
NUMBER

expiration_interval_unit
STRING

handle
STRING

id
NUMBER

Reference:

initial_charge_after_trial
BOOLEAN

initial_charge_in_cents
NUMBER

interval
NUMBER

interval_unit
STRING

name
STRING

price_in_cents
NUMBER

product_family
OBJECT

Click to expand product_family
subscriptions (table), product_family (attribute)

public_signup_pages
ARRAY

Click to expand public_signup_pages

id
NUMBER

url
STRING

subscriptions (table), public_signup_pages (attribute)

request_credit_card
BOOLEAN

require_credit_card
BOOLEAN

return_params
STRING

taxable
BOOLEAN

trial_interval
NUMBER

trial_interval_unit
STRING

trial_price_in_cents
NUMBER

update_return_params
STRING

update_return_url
STRING

updated_at
DATE-TIME

version_number
NUMBER

subscriptions (table), product (attribute)

product_price_in_cents
NUMBER

product_version_number
NUMBER

reason_code
STRING

receives_invoice_emails
BOOLEAN

referral_code
STRING

signup_payment_id
NUMBER

Reference:

signup_revenue
NUMBER

snap_day
NUMBER

state
STRING

stored_credential_transaction_id
NUMBER

Reference:

total_revenue_in_cents
NUMBER

trial_ended_at
DATE-TIME

trial_started_at
DATE-TIME

updated_at
DATE-TIME

transactions

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

created_at
Primary Key :

id

 API endpoint :

Read transactions for a site
Loading Behavior:

Append-Only

The transactions table contains info about the transactions for your Chargify site.

transactions table schema

id
NUMBER

The transaction ID.

Reference:

created_at
DATE-TIME

amount_in_cents
NUMBER

card_expiration
STRING

card_number
STRING

card_type
STRING

component_handle
STRING

component_id
NUMBER

Reference:

component_price_point_handle
INTEGER

component_price_point_id
INTEGER

customer_id
NUMBER

Reference:

ending_balance_in_cents
NUMBER

gateway_order_id
NUMBER

gateway_transaction_id
STRING

gateway_used
STRING

item_name
STRING

kind
STRING

memo
STRING

parent_id
NUMBER

Reference:

payment_id
NUMBER

Reference:

period_range_start
STRING

period_range_end
STRING

price_point_handle
STRING

price_point_id
INTEGER

product_id
NUMBER

Reference:

refunded_amount_in_cents
NUMBER

role
STRING

starting_balance_in_cents
NUMBER

statement_id
NUMBER

Reference:

subscription_id
NUMBER

Reference:

success
BOOLEAN

tax_id
NUMBER

transaction_type
STRING

type
STRING

Related Troubleshooting
Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.