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 data equal to or newer than this date will be replicated to your data warehouse.

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

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

Replication Method

Full Table

Primary Key

id

Useful links

components schema on GitHub

Chargify API method

Join components with on
invoices
components.id = invoices.charges.component_id
components.prices.id = invoices.charges.component_id
components.id = invoices.payments_and_credits.component_id
components.prices.id = invoices.payments_and_credits.component_id
price_points
components.id = price_points.component_id
components.prices.id = price_points.component_id
components.id = price_points.prices.component_id
components.prices.id = price_points.prices.component_id
components.default_price_point_id = price_points.id
components.prices.price_point_id = price_points.id
statements
components.id = statements.transactions.component_id
components.prices.id = statements.transactions.component_id
transactions
components.id = transactions.component_id
components.prices.id = transactions.component_id
coupons
components.product_family_id = coupons.product_family_id
product_families
components.product_family_id = product_families.id
products
components.product_family_id = products.product_family.id
subscriptions
components.product_family_id = subscriptions.product.product_family.id

archived

BOOLEAN

created_at

DATE-TIME

default_price_point_id

NUMBER

default_price_point_name

STRING

description

STRING

downgrade_credit

STRING

handle

STRING

id

INTEGER

kind

STRING

name

STRING

price_per_unit_in_cents

INTEGER

price_point_count

NUMBER

price_points_url

STRING

prices

ARRAY

component_id

INTEGER

ending_quantity

INTEGER

formatted_unit_price

STRING

id

INTEGER

price_point_id

INTEGER

starting_quantity

INTEGER

unit_price

STRING

pricing_scheme

STRING

product_family_id

INTEGER

product_family_name

STRING

recurring

BOOLEAN

tax_code

STRING

taxable

BOOLEAN

unit_name

STRING

unit_price

STRING

upgrade_charge

STRING

coupons

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

Replication Method

Full Table

Primary Key

id

Useful links

coupons schema on GitHub

Chargify API method

Join coupons with on
components
coupons.product_family_id = components.product_family_id
product_families
coupons.product_family_id = product_families.id
products
coupons.product_family_id = products.product_family.id
subscriptions
coupons.product_family_id = subscriptions.product.product_family.id

allow_negative_balance

BOOLEAN

amount_in_cents

INTEGER

archived_at

DATE-TIME

code

STRING

compounding_strategy

STRING

conversion_limit

INTEGER

coupon_restrictions

ARRAY

handle

STRING

id

INTEGER

item_id

INTEGER

item_type

STRING

name

STRING

created_at

DATE-TIME

description

STRING

duration_interval

INTEGER

duration_interval_unit

STRING

duration_period_count

NUMBER

end_date

DATE-TIME

id

INTEGER

name

STRING

percentage

NUMBER

product_family_id

INTEGER

recurring

BOOLEAN

stackable

BOOLEAN

start_date

DATE-TIME

updated_at

DATE-TIME

customers

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

Replication Method

Full Table

Primary Key

id

Useful links

customers schema on GitHub

Chargify API method

Join customers with on
invoices
customers.id = invoices.charges.customer_id
customers.parent_id = invoices.charges.customer_id
customers.id = invoices.payments_and_credits.customer_id
customers.parent_id = invoices.payments_and_credits.customer_id
statements
customers.id = statements.transactions.customer_id
customers.parent_id = statements.transactions.customer_id
subscriptions
customers.id = subscriptions.credit_card.customer_id
customers.parent_id = subscriptions.credit_card.customer_id
customers.id = subscriptions.customer.id
customers.parent_id = subscriptions.customer.id
transactions
customers.id = transactions.customer_id
customers.parent_id = transactions.customer_id

address

STRING

address_2

STRING

cc_emails

STRING

city

STRING

country

STRING

created_at

DATE-TIME

first_name

STRING

id

INTEGER

last_name

STRING

organization

STRING

parent_id

INTEGER

phone

STRING

portal_customer_created_at

DATE-TIME

portal_invite_last_accepted_at

DATE-TIME

portal_invite_last_sent_at

DATE-TIME

reference

STRING

state

STRING

tax_exempt

BOOLEAN

updated_at

DATE-TIME

vat_number

STRING

verified

BOOLEAN

zip

STRING

events

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

Replication Method

Full Table

Primary Key

id

Useful links

events schema on GitHub

Chargify API method

Join events with on
statements
events.id = statements.events.event.id
events.event_specific_data.product_id = statements.events.event.event_specific_data.product_id
events.event_specific_data.product_id = statements.transactions.product_id
events.subscription_id = statements.events.event.subscription_id
events.subscription_id = statements.subscription_id
events.subscription_id = statements.transactions.subscription_id
events.event_specific_data.account_transaction_id = statements.transactions.id
invoices
events.event_specific_data.product_id = invoices.charges.product_id
events.event_specific_data.product_id = invoices.payments_and_credits.product_id
events.subscription_id = invoices.charges.subscription_id
events.subscription_id = invoices.payments_and_credits.subscription_id
events.subscription_id = invoices.subscription_id
events.event_specific_data.account_transaction_id = invoices.charges.payment_id
events.event_specific_data.account_transaction_id = invoices.payments_and_credits.payment_id
products
events.event_specific_data.product_id = products.id
subscriptions
events.event_specific_data.product_id = subscriptions.next_product_id
events.event_specific_data.product_id = subscriptions.product.id
events.subscription_id = subscriptions.id
events.event_specific_data.account_transaction_id = subscriptions.signup_payment_id
events.event_specific_data.account_transaction_id = subscriptions.stored_credential_transaction_id
transactions
events.event_specific_data.product_id = transactions.product_id
events.subscription_id = transactions.subscription_id
events.event_specific_data.account_transaction_id = transactions.id
events.event_specific_data.account_transaction_id = transactions.parent_id
events.event_specific_data.account_transaction_id = transactions.payment_id

created_at

DATE-TIME

event_specific_data

OBJECT

account_transaction_id

INTEGER

current_step

OBJECT

action

STRING

day_threshold

INTEGER

email_body

STRING

email_subject

STRING

send_bcc_email

BOOLEAN

send_email

BOOLEAN

send_sms

BOOLEAN

sms_body

STRING

dunner

OBJECT

attempts

INTEGER

created_at

STRING

last_attempted_at

STRING

revenue_at_risk_in_cents

INTEGER

state

STRING

subscription_id

INTEGER

new_product_id

INTEGER

new_subscription_state

STRING

next_step

OBJECT

action

STRING

day_threshold

INTEGER

email_body

STRING

email_subject

STRING

send_bcc_email

BOOLEAN

send_email

BOOLEAN

send_sms

BOOLEAN

sms_body

STRING

previous_product_id

INTEGER

previous_subscription_state

STRING

product_id

INTEGER

id

INTEGER

key

STRING

message

STRING

subscription_id

INTEGER

invoices

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

Replication Method

Key-based Incremental

Primary Key

id

Useful links

invoices schema on GitHub

Chargify API method

Join invoices with on
components
invoices.charges.component_id = components.id
invoices.payments_and_credits.component_id = components.id
invoices.charges.component_id = components.prices.id
invoices.payments_and_credits.component_id = components.prices.id
price_points
invoices.charges.component_id = price_points.component_id
invoices.payments_and_credits.component_id = price_points.component_id
invoices.charges.component_id = price_points.prices.component_id
invoices.payments_and_credits.component_id = price_points.prices.component_id
statements
invoices.charges.component_id = statements.transactions.component_id
invoices.payments_and_credits.component_id = statements.transactions.component_id
invoices.charges.customer_id = statements.transactions.customer_id
invoices.payments_and_credits.customer_id = statements.transactions.customer_id
invoices.charges.product_id = statements.events.event.event_specific_data.product_id
invoices.payments_and_credits.product_id = statements.events.event.event_specific_data.product_id
invoices.charges.product_id = statements.transactions.product_id
invoices.payments_and_credits.product_id = statements.transactions.product_id
invoices.statement_id = statements.id
invoices.statement_id = statements.transactions.statement_id
invoices.charges.subscription_id = statements.events.event.subscription_id
invoices.payments_and_credits.subscription_id = statements.events.event.subscription_id
invoices.subscription_id = statements.events.event.subscription_id
invoices.charges.subscription_id = statements.subscription_id
invoices.payments_and_credits.subscription_id = statements.subscription_id
invoices.subscription_id = statements.subscription_id
invoices.charges.subscription_id = statements.transactions.subscription_id
invoices.payments_and_credits.subscription_id = statements.transactions.subscription_id
invoices.subscription_id = statements.transactions.subscription_id
invoices.charges.payment_id = statements.transactions.id
invoices.payments_and_credits.payment_id = statements.transactions.id
transactions
invoices.charges.component_id = transactions.component_id
invoices.payments_and_credits.component_id = transactions.component_id
invoices.charges.customer_id = transactions.customer_id
invoices.payments_and_credits.customer_id = transactions.customer_id
invoices.charges.product_id = transactions.product_id
invoices.payments_and_credits.product_id = transactions.product_id
invoices.statement_id = transactions.statement_id
invoices.charges.subscription_id = transactions.subscription_id
invoices.payments_and_credits.subscription_id = transactions.subscription_id
invoices.subscription_id = transactions.subscription_id
invoices.charges.payment_id = transactions.id
invoices.payments_and_credits.payment_id = transactions.id
invoices.charges.payment_id = transactions.parent_id
invoices.payments_and_credits.payment_id = transactions.parent_id
invoices.charges.payment_id = transactions.payment_id
invoices.payments_and_credits.payment_id = transactions.payment_id
customers
invoices.charges.customer_id = customers.id
invoices.payments_and_credits.customer_id = customers.id
invoices.charges.customer_id = customers.parent_id
invoices.payments_and_credits.customer_id = customers.parent_id
subscriptions
invoices.charges.customer_id = subscriptions.credit_card.customer_id
invoices.payments_and_credits.customer_id = subscriptions.credit_card.customer_id
invoices.charges.customer_id = subscriptions.customer.id
invoices.payments_and_credits.customer_id = subscriptions.customer.id
invoices.charges.product_id = subscriptions.next_product_id
invoices.payments_and_credits.product_id = subscriptions.next_product_id
invoices.charges.product_id = subscriptions.product.id
invoices.payments_and_credits.product_id = subscriptions.product.id
invoices.charges.subscription_id = subscriptions.id
invoices.payments_and_credits.subscription_id = subscriptions.id
invoices.subscription_id = subscriptions.id
invoices.charges.payment_id = subscriptions.signup_payment_id
invoices.payments_and_credits.payment_id = subscriptions.signup_payment_id
invoices.charges.payment_id = subscriptions.stored_credential_transaction_id
invoices.payments_and_credits.payment_id = subscriptions.stored_credential_transaction_id
events
invoices.charges.product_id = events.event_specific_data.product_id
invoices.payments_and_credits.product_id = events.event_specific_data.product_id
invoices.charges.subscription_id = events.subscription_id
invoices.payments_and_credits.subscription_id = events.subscription_id
invoices.subscription_id = events.subscription_id
invoices.charges.payment_id = events.event_specific_data.account_transaction_id
invoices.payments_and_credits.payment_id = events.event_specific_data.account_transaction_id
products
invoices.charges.product_id = products.id
invoices.payments_and_credits.product_id = products.id

amount_due_in_cents

INTEGER

charges

ARRAY

amount_in_cents

INTEGER

component_id

INTEGER

created_at

DATE-TIME

customer_id

INTEGER

ending_balance_in_cents

INTEGER

gateway_order_id

STRING

gateway_transaction_id

STRING

id

INTEGER

kind

STRING

memo

STRING

payment_id

INTEGER

product_id

INTEGER

starting_balance_in_cents

INTEGER

subscription_id

INTEGER

success

BOOLEAN

tax_id

INTEGER

transaction_type

STRING

type

STRING

created_at

DATE-TIME

id

INTEGER

number

STRING

paid_at

DATE-TIME

payments_and_credits

ARRAY

amount_in_cents

INTEGER

card_expiration

STRING

card_number

STRING

card_type

STRING

component_id

INTEGER

created_at

DATE-TIME

customer_id

INTEGER

ending_balance_in_cents

INTEGER

gateway_order_id

STRING

gateway_transaction_id

STRING

id

INTEGER

kind

STRING

memo

STRING

payment_id

INTEGER

product_id

INTEGER

starting_balance_in_cents

INTEGER

subscription_id

INTEGER

success

BOOLEAN

tax_id

INTEGER

transaction_type

STRING

type

STRING

site_id

INTEGER

state

STRING

statement_id

INTEGER

subscription_id

INTEGER

total_amount_in_cents

INTEGER

updated_at

DATE-TIME

price_points

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

Replication Method

Full Table

Primary Key

id

Useful links

price_points schema on GitHub

Chargify API method

Join price_points with on
components
price_points.component_id = components.id
price_points.prices.component_id = components.id
price_points.component_id = components.prices.id
price_points.prices.component_id = components.prices.id
price_points.id = components.default_price_point_id
price_points.id = components.prices.price_point_id
invoices
price_points.component_id = invoices.charges.component_id
price_points.prices.component_id = invoices.charges.component_id
price_points.component_id = invoices.payments_and_credits.component_id
price_points.prices.component_id = invoices.payments_and_credits.component_id
statements
price_points.component_id = statements.transactions.component_id
price_points.prices.component_id = statements.transactions.component_id
transactions
price_points.component_id = transactions.component_id
price_points.prices.component_id = transactions.component_id

archived_at

DATE-TIME

component_id

INTEGER

created_at

DATE-TIME

default

BOOLEAN

handle

STRING

id

INTEGER

name

STRING

prices

ARRAY

component_id

INTEGER

ending_quantity

INTEGER

id

INTEGER

starting_quantity

INTEGER

unit_price

STRING

pricing_scheme

STRING

updated_at

DATE-TIME

product_families

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.

Replication Method

Full Table

Primary Key

id

Useful links

product_families schema on GitHub

Chargify API method

Join product_families with on
components
product_families.id = components.product_family_id
coupons
product_families.id = coupons.product_family_id
products
product_families.id = products.product_family.id
subscriptions
product_families.id = subscriptions.product.product_family.id

accounting_code

STRING

description

STRING

handle

STRING

id

INTEGER

name

STRING

products

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

Replication Method

Full Table

Primary Key

id

Useful links

products schema on GitHub

Chargify API method

Join products with on
components
products.product_family.id = components.product_family_id
coupons
products.product_family.id = coupons.product_family_id
product_families
products.product_family.id = product_families.id
subscriptions
products.product_family.id = subscriptions.product.product_family.id
products.id = subscriptions.next_product_id
products.id = subscriptions.product.id
events
products.id = events.event_specific_data.product_id
invoices
products.id = invoices.charges.product_id
products.id = invoices.payments_and_credits.product_id
statements
products.id = statements.events.event.event_specific_data.product_id
products.id = statements.transactions.product_id
transactions
products.id = transactions.product_id

accounting_code

STRING

archived_at

DATE-TIME

created_at

DATE-TIME

description

STRING

expiration_interval

STRING

expiration_interval_unit

STRING

handle

STRING

id

INTEGER

initial_charge_after_trial

BOOLEAN

initial_charge_in_cents

INTEGER

interval

INTEGER

interval_unit

STRING

name

STRING

price_in_cents

INTEGER

product_family

OBJECT

accounting_code

STRING

description

STRING

handle

STRING

id

INTEGER

name

STRING

public_signup_pages

ARRAY

id

INTEGER

return_params

STRING

return_url

STRING

url

STRING

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

statements

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.

Replication Method

Full Table

Primary Key

id

Useful links

statements schema on GitHub

Chargify API method

Join statements with on
components
statements.transactions.component_id = components.id
statements.transactions.component_id = components.prices.id
invoices
statements.transactions.component_id = invoices.charges.component_id
statements.transactions.component_id = invoices.payments_and_credits.component_id
statements.transactions.customer_id = invoices.charges.customer_id
statements.transactions.customer_id = invoices.payments_and_credits.customer_id
statements.events.event.event_specific_data.product_id = invoices.charges.product_id
statements.transactions.product_id = invoices.charges.product_id
statements.events.event.event_specific_data.product_id = invoices.payments_and_credits.product_id
statements.transactions.product_id = invoices.payments_and_credits.product_id
statements.id = invoices.statement_id
statements.transactions.statement_id = invoices.statement_id
statements.events.event.subscription_id = invoices.charges.subscription_id
statements.subscription_id = invoices.charges.subscription_id
statements.transactions.subscription_id = invoices.charges.subscription_id
statements.events.event.subscription_id = invoices.payments_and_credits.subscription_id
statements.subscription_id = invoices.payments_and_credits.subscription_id
statements.transactions.subscription_id = invoices.payments_and_credits.subscription_id
statements.events.event.subscription_id = invoices.subscription_id
statements.subscription_id = invoices.subscription_id
statements.transactions.subscription_id = invoices.subscription_id
statements.transactions.id = invoices.charges.payment_id
statements.transactions.id = invoices.payments_and_credits.payment_id
price_points
statements.transactions.component_id = price_points.component_id
statements.transactions.component_id = price_points.prices.component_id
transactions
statements.transactions.component_id = transactions.component_id
statements.transactions.customer_id = transactions.customer_id
statements.events.event.event_specific_data.product_id = transactions.product_id
statements.transactions.product_id = transactions.product_id
statements.id = transactions.statement_id
statements.transactions.statement_id = transactions.statement_id
statements.events.event.subscription_id = transactions.subscription_id
statements.subscription_id = transactions.subscription_id
statements.transactions.subscription_id = transactions.subscription_id
statements.transactions.id = transactions.id
statements.transactions.id = transactions.parent_id
statements.transactions.id = transactions.payment_id
customers
statements.transactions.customer_id = customers.id
statements.transactions.customer_id = customers.parent_id
subscriptions
statements.transactions.customer_id = subscriptions.credit_card.customer_id
statements.transactions.customer_id = subscriptions.customer.id
statements.events.event.event_specific_data.product_id = subscriptions.next_product_id
statements.transactions.product_id = subscriptions.next_product_id
statements.events.event.event_specific_data.product_id = subscriptions.product.id
statements.transactions.product_id = subscriptions.product.id
statements.events.event.subscription_id = subscriptions.id
statements.subscription_id = subscriptions.id
statements.transactions.subscription_id = subscriptions.id
statements.transactions.id = subscriptions.signup_payment_id
statements.transactions.id = subscriptions.stored_credential_transaction_id
events
statements.events.event.id = events.id
statements.events.event.event_specific_data.product_id = events.event_specific_data.product_id
statements.transactions.product_id = events.event_specific_data.product_id
statements.events.event.subscription_id = events.subscription_id
statements.subscription_id = events.subscription_id
statements.transactions.subscription_id = events.subscription_id
statements.transactions.id = events.event_specific_data.account_transaction_id
products
statements.events.event.event_specific_data.product_id = products.id
statements.transactions.product_id = products.id

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

INTEGER

events

ARRAY

event

OBJECT

created_at

DATE-TIME

event_specific_data

OBJECT

account_transaction_id

INTEGER

current_step

OBJECT

action

STRING

day_threshold

INTEGER

email_body

STRING

email_subject

STRING

send_bcc_email

BOOLEAN

send_email

BOOLEAN

send_sms

BOOLEAN

sms_body

STRING

dunner

OBJECT

attempts

INTEGER

created_at

STRING

last_attempted_at

STRING

revenue_at_risk_in_cents

INTEGER

state

STRING

subscription_id

INTEGER

new_product_id

INTEGER

new_subscription_state

STRING

next_step

OBJECT

action

STRING

day_threshold

INTEGER

email_body

STRING

email_subject

STRING

send_bcc_email

BOOLEAN

send_email

BOOLEAN

send_sms

BOOLEAN

sms_body

STRING

previous_product_id

INTEGER

previous_subscription_state

STRING

product_id

INTEGER

id

INTEGER

key

STRING

message

STRING

subscription_id

INTEGER

future_payments

ARRAY

html_view

STRING

id

INTEGER

memo

STRING

opened_at

DATE-TIME

settled_at

DATE-TIME

starting_balance_in_cents

INTEGER

subscription_id

INTEGER

text_view

STRING

total_in_cents

INTEGER

transactions

ARRAY

amount_in_cents

INTEGER

component_id

INTEGER

created_at

DATE-TIME

customer_id

INTEGER

discount_amount_in_cents

INTEGER

ending_balance_in_cents

INTEGER

gateway_order_id

STRING

gateway_transaction_id

STRING

gateway_used

STRING

id

INTEGER

item_name

STRING

kind

STRING

memo

STRING

original_amount_in_cents

INTEGER

payment_id

INTEGER

product_id

INTEGER

starting_balance_in_cents

INTEGER

statement_id

INTEGER

subscription_id

INTEGER

success

BOOLEAN

tax_id

INTEGER

taxable_amount_in_cents

INTEGER

taxations

ARRAY

transaction_type

STRING

type

STRING

updated_at

DATE-TIME

subscriptions

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

Replication Method

Full Table

Primary Key

id

Useful links

subscriptions schema on GitHub

Chargify API method

Join subscriptions with on
customers
subscriptions.credit_card.customer_id = customers.id
subscriptions.customer.id = customers.id
subscriptions.credit_card.customer_id = customers.parent_id
subscriptions.customer.id = customers.parent_id
invoices
subscriptions.credit_card.customer_id = invoices.charges.customer_id
subscriptions.customer.id = invoices.charges.customer_id
subscriptions.credit_card.customer_id = invoices.payments_and_credits.customer_id
subscriptions.customer.id = invoices.payments_and_credits.customer_id
subscriptions.next_product_id = invoices.charges.product_id
subscriptions.product.id = invoices.charges.product_id
subscriptions.next_product_id = invoices.payments_and_credits.product_id
subscriptions.product.id = invoices.payments_and_credits.product_id
subscriptions.id = invoices.charges.subscription_id
subscriptions.id = invoices.payments_and_credits.subscription_id
subscriptions.id = invoices.subscription_id
subscriptions.signup_payment_id = invoices.charges.payment_id
subscriptions.stored_credential_transaction_id = invoices.charges.payment_id
subscriptions.signup_payment_id = invoices.payments_and_credits.payment_id
subscriptions.stored_credential_transaction_id = invoices.payments_and_credits.payment_id
statements
subscriptions.credit_card.customer_id = statements.transactions.customer_id
subscriptions.customer.id = statements.transactions.customer_id
subscriptions.next_product_id = statements.events.event.event_specific_data.product_id
subscriptions.product.id = statements.events.event.event_specific_data.product_id
subscriptions.next_product_id = statements.transactions.product_id
subscriptions.product.id = statements.transactions.product_id
subscriptions.id = statements.events.event.subscription_id
subscriptions.id = statements.subscription_id
subscriptions.id = statements.transactions.subscription_id
subscriptions.signup_payment_id = statements.transactions.id
subscriptions.stored_credential_transaction_id = statements.transactions.id
transactions
subscriptions.credit_card.customer_id = transactions.customer_id
subscriptions.customer.id = transactions.customer_id
subscriptions.next_product_id = transactions.product_id
subscriptions.product.id = transactions.product_id
subscriptions.id = transactions.subscription_id
subscriptions.signup_payment_id = transactions.id
subscriptions.stored_credential_transaction_id = transactions.id
subscriptions.signup_payment_id = transactions.parent_id
subscriptions.stored_credential_transaction_id = transactions.parent_id
subscriptions.signup_payment_id = transactions.payment_id
subscriptions.stored_credential_transaction_id = transactions.payment_id
components
subscriptions.product.product_family.id = components.product_family_id
coupons
subscriptions.product.product_family.id = coupons.product_family_id
product_families
subscriptions.product.product_family.id = product_families.id
products
subscriptions.product.product_family.id = products.product_family.id
subscriptions.next_product_id = products.id
subscriptions.product.id = products.id
events
subscriptions.next_product_id = events.event_specific_data.product_id
subscriptions.product.id = events.event_specific_data.product_id
subscriptions.id = events.subscription_id
subscriptions.signup_payment_id = events.event_specific_data.account_transaction_id
subscriptions.stored_credential_transaction_id = events.event_specific_data.account_transaction_id

activated_at

DATE-TIME

balance_in_cents

INTEGER

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

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

INTEGER

customer_vault_token

STRING

expiration_month

NUMBER

expiration_year

NUMBER

first_name

STRING

id

INTEGER

last_name

STRING

masked_card_number

STRING

payment_type

STRING

vault_token

STRING

current_period_ends_at

DATE-TIME

current_period_started_at

DATE-TIME

customer

OBJECT

address

STRING

address_2

STRING

cc_emails

STRING

city

STRING

country

STRING

created_at

DATE-TIME

email

STRING

first_name

STRING

id

INTEGER

last_name

STRING

organization

STRING

phone

STRING

portal_customer_created_at

DATE-TIME

portal_invite_last_accepted_at

DATE-TIME

portal_invite_last_sent_at

DATE-TIME

reference

STRING

state

STRING

tax_exempt

BOOLEAN

updated_at

DATE-TIME

vat_number

STRING

verified

BOOLEAN

zip

STRING

delayed_cancel_at

DATE-TIME

expires_at

DATE-TIME

id

INTEGER

net_terms

INTEGER

next_assessment_at

DATE-TIME

next_product_id

INTEGER

payment_collection_method

STRING

payment_type

STRING

previous_state

STRING

product

OBJECT

accounting_code

STRING

archived_at

DATE-TIME

created_at

DATE-TIME

description

STRING

expiration_interval

INTEGER

expiration_interval_unit

STRING

handle

STRING

id

INTEGER

initial_charge_after_trial

BOOLEAN

initial_charge_in_cents

INTEGER

interval

INTEGER

interval_unit

STRING

name

STRING

price_in_cents

INTEGER

product_family

OBJECT

accounting_code

STRING

description

STRING

handle

STRING

id

INTEGER

name

STRING

public_signup_pages

ARRAY

id

INTEGER

url

STRING

request_credit_card

BOOLEAN

require_credit_card

BOOLEAN

return_params

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

NUMBER

product_price_in_cents

INTEGER

product_version_number

INTEGER

reason_code

STRING

receives_invoice_emails

BOOLEAN

referral_code

STRING

signup_payment_id

NUMBER

signup_revenue

STRING

snap_day

STRING

state

STRING

stored_credential_transaction_id

INTEGER

total_revenue_in_cents

INTEGER

trial_ended_at

DATE-TIME

trial_started_at

DATE-TIME

updated_at

DATE-TIME

transactions

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

Replication Method

Key-based Incremental

Loading Behavior

Append-Only

Primary Key

id

Replication Key

created_at

Useful links

transactions schema on GitHub

Chargify API method

Join transactions with on
components
transactions.component_id = components.id
transactions.component_id = components.prices.id
invoices
transactions.component_id = invoices.charges.component_id
transactions.component_id = invoices.payments_and_credits.component_id
transactions.customer_id = invoices.charges.customer_id
transactions.customer_id = invoices.payments_and_credits.customer_id
transactions.product_id = invoices.charges.product_id
transactions.product_id = invoices.payments_and_credits.product_id
transactions.statement_id = invoices.statement_id
transactions.subscription_id = invoices.charges.subscription_id
transactions.subscription_id = invoices.payments_and_credits.subscription_id
transactions.subscription_id = invoices.subscription_id
transactions.id = invoices.charges.payment_id
transactions.parent_id = invoices.charges.payment_id
transactions.payment_id = invoices.charges.payment_id
transactions.id = invoices.payments_and_credits.payment_id
transactions.parent_id = invoices.payments_and_credits.payment_id
transactions.payment_id = invoices.payments_and_credits.payment_id
price_points
transactions.component_id = price_points.component_id
transactions.component_id = price_points.prices.component_id
statements
transactions.component_id = statements.transactions.component_id
transactions.customer_id = statements.transactions.customer_id
transactions.product_id = statements.events.event.event_specific_data.product_id
transactions.product_id = statements.transactions.product_id
transactions.statement_id = statements.id
transactions.statement_id = statements.transactions.statement_id
transactions.subscription_id = statements.events.event.subscription_id
transactions.subscription_id = statements.subscription_id
transactions.subscription_id = statements.transactions.subscription_id
transactions.id = statements.transactions.id
transactions.parent_id = statements.transactions.id
transactions.payment_id = statements.transactions.id
customers
transactions.customer_id = customers.id
transactions.customer_id = customers.parent_id
subscriptions
transactions.customer_id = subscriptions.credit_card.customer_id
transactions.customer_id = subscriptions.customer.id
transactions.product_id = subscriptions.next_product_id
transactions.product_id = subscriptions.product.id
transactions.subscription_id = subscriptions.id
transactions.id = subscriptions.signup_payment_id
transactions.parent_id = subscriptions.signup_payment_id
transactions.payment_id = subscriptions.signup_payment_id
transactions.id = subscriptions.stored_credential_transaction_id
transactions.parent_id = subscriptions.stored_credential_transaction_id
transactions.payment_id = subscriptions.stored_credential_transaction_id
events
transactions.product_id = events.event_specific_data.product_id
transactions.subscription_id = events.subscription_id
transactions.id = events.event_specific_data.account_transaction_id
transactions.parent_id = events.event_specific_data.account_transaction_id
transactions.payment_id = events.event_specific_data.account_transaction_id
products
transactions.product_id = products.id

amount_in_cents

INTEGER

card_expiration

STRING

card_number

STRING

card_type

STRING

component_handle

STRING

component_id

INTEGER

component_price_point_handle

STRING

component_price_point_id

INTEGER

created_at

DATE-TIME

customer_id

INTEGER

ending_balance_in_cents

INTEGER

gateway_order_id

NUMBER

gateway_transaction_id

STRING

gateway_used

STRING

id

INTEGER

item_name

STRING

kind

STRING

memo

STRING

parent_id

INTEGER

payment_id

INTEGER

period_range_end

STRING

period_range_start

STRING

price_point_handle

STRING

price_point_id

INTEGER

product_id

INTEGER

refunded_amount_in_cents

INTEGER

role

STRING

starting_balance_in_cents

INTEGER

statement_id

INTEGER

subscription_id

INTEGER

success

BOOLEAN

tax_id

INTEGER

transaction_type

STRING

type

STRING


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.