Chargify is currently in beta. The info in this guide is subject to change.
This integration is powered by Singer's Chargify tap. For support, visit the GitHub repo or join the Singer Slack.
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 | |
Stitch plan |
Standard |
API availability |
Available |
Singer GitHub repository | |||
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
- Sign into your Chargify account as a user with either Owner or Admin access.
- Navigate to Config > Integrations.
- Click New API Key.
- Copy your API key somewhere secure.
Step 2: Add Chargify as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Chargify icon.
-
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. - In the API Key field, paste the API key you created in Step 1.
- 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 bestitch
.
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:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
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:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- 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.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
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
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 1 of this integration.
This is the latest version of the Chargify integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs
> customers
), while case is maintained in PostgreSQL destinations (CusTomERs
> CusTomERs
). Refer to the Loading Guide for your destination for more info.
components
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The components
table contains info about components associated with a product family in Chargify.
id
The component ID. Reference: |
|||||||
archived
|
|||||||
created_at
|
|||||||
default_price_point_id
Reference: |
|||||||
default_price_point_name
|
|||||||
description
|
|||||||
downgrade_credit
|
|||||||
handle
|
|||||||
kind
|
|||||||
name
|
|||||||
price_per_unit_in_cents
|
|||||||
price_point_count
|
|||||||
price_points_url
|
|||||||
prices
|
|||||||
pricing_scheme
|
|||||||
product_family_id
Reference: |
|||||||
product_family_name
|
|||||||
recurring
|
|||||||
tax_code
|
|||||||
taxable
|
|||||||
unit_name
|
|||||||
unit_price
|
|||||||
upgrade_charge
|
coupons
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The coupons
table contains info about coupons associated with a product family in Chargify.
id
The coupon ID. |
allow_negative_balance
|
amount_in_cents
|
archived_at
|
code
|
compounding_strategy
|
conversion_limit
|
coupon_restrictions
|
created_at
|
description
|
duration_interval
|
duration_interval_unit
|
duration_period_count
|
end_date
|
name
|
percentage
|
product_family_id
Reference: |
recurring
|
stackable
|
start_date
|
updated_at
|
customers
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The customers
table contains info about customers associated with your Chargify site.
id
The customer ID. Reference: |
address
|
address_2
|
cc_emails
|
city
|
country
|
created_at
|
first_name
|
last_name
|
organization
|
parent_id
Reference: |
phone
|
portal_customer_created_at
|
portal_invite_last_accepted_at
|
portal_invite_last_sent_at
|
reference
|
state
|
tax_exempt
|
updated_at
|
vat_number
|
verified
|
zip
|
events
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The events
table contains info about activity on your Chargify site.
id
The event ID. Reference: |
||
created_at
|
||
event_specific_data
|
||
key
|
||
message
|
||
subscription_id
The ID of the subscription associated with the event. Reference: |
invoices
Replication Method : |
Key-based Incremental |
Replication Key |
due_date |
Primary Key |
id |
API endpoint : |
The invoices
table contains info about invoices in your Chargify instance.
id
The invoice ID. |
|||||||||||||||||||||
amount_due_in_cents
|
|||||||||||||||||||||
charges
|
|||||||||||||||||||||
created_at
|
|||||||||||||||||||||
number
|
|||||||||||||||||||||
paid_at
|
|||||||||||||||||||||
payments_and_credits
|
|||||||||||||||||||||
site_id
|
|||||||||||||||||||||
state
|
|||||||||||||||||||||
statement_id
Reference: |
|||||||||||||||||||||
subscription_id
Reference: |
|||||||||||||||||||||
total_amount_in_cents
|
|||||||||||||||||||||
updated_at
|
price_points
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The price_points
table contains info about product price points in your Chargify instance.
id
The price point ID. Reference: |
|||||
archived_at
|
|||||
component_id
Reference: |
|||||
created_at
|
|||||
default
|
|||||
handle
|
|||||
name
|
|||||
prices
|
|||||
pricing_scheme
|
|||||
updated_at
|
products
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The products
table contains info about the prodcts in your Chargify instance.
id
The product ID. Reference: |
|||||
accounting_code
|
|||||
archived_at
|
|||||
created_at
|
|||||
description
|
|||||
expiration_interval
|
|||||
expiration_interval_unit
|
|||||
handle
|
|||||
initial_charge_after_trial
|
|||||
initial_charge_in_cents
|
|||||
interval
|
|||||
interval_unit
|
|||||
name
|
|||||
price_in_cents
|
|||||
product_family
|
|||||
public_signup_pages
|
|||||
request_credit_card
|
|||||
require_credit_card
|
|||||
return_params
|
|||||
tax_code
|
|||||
taxable
|
|||||
trial_interval
|
|||||
trial_interval_unit
|
|||||
trial_price_in_cents
|
|||||
update_return_params
|
|||||
update_return_url
|
|||||
updated_at
|
|||||
version_number
|
product_families
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
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.
id
The product family ID. Reference: |
accounting_code
|
description
|
handle
|
name
|
statements
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
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.
id
The statement ID. Reference: |
|||||||||||||||||||||||||
basic_html_view
|
|||||||||||||||||||||||||
closed_at
|
|||||||||||||||||||||||||
created_at
|
|||||||||||||||||||||||||
customer_billing_address
|
|||||||||||||||||||||||||
customer_billing_address_2
|
|||||||||||||||||||||||||
customer_billing_city
|
|||||||||||||||||||||||||
customer_billing_country
|
|||||||||||||||||||||||||
customer_billing_state
|
|||||||||||||||||||||||||
customer_billing_zip
|
|||||||||||||||||||||||||
customer_first_name
|
|||||||||||||||||||||||||
customer_last_name
|
|||||||||||||||||||||||||
customer_organization
|
|||||||||||||||||||||||||
customer_shipping_address
|
|||||||||||||||||||||||||
customer_shipping_address_2
|
|||||||||||||||||||||||||
customer_shipping_city
|
|||||||||||||||||||||||||
customer_shipping_country
|
|||||||||||||||||||||||||
customer_shipping_state
|
|||||||||||||||||||||||||
customer_shipping_zip
|
|||||||||||||||||||||||||
ending_balance_in_cents
|
|||||||||||||||||||||||||
events
|
|||||||||||||||||||||||||
future_payments
|
|||||||||||||||||||||||||
html_view
|
|||||||||||||||||||||||||
memo
|
|||||||||||||||||||||||||
opened_at
|
|||||||||||||||||||||||||
settled_at
|
|||||||||||||||||||||||||
starting_balance_in_cents
|
|||||||||||||||||||||||||
subscription_id
Reference: |
|||||||||||||||||||||||||
text_view
|
|||||||||||||||||||||||||
total_in_cents
|
|||||||||||||||||||||||||
transactions
|
|||||||||||||||||||||||||
updated_at
|
subscriptions
Replication Method : |
Full Table |
Primary Key |
id |
API endpoint : |
The subscriptions
table contains info about the subscriptions in your Chargify instance.
id
Reference: |
||||||||||||||||||||||||||||||||||
activated_at
|
||||||||||||||||||||||||||||||||||
balance_in_cents
|
||||||||||||||||||||||||||||||||||
cancel_at_end_of_period
|
||||||||||||||||||||||||||||||||||
canceled_at
|
||||||||||||||||||||||||||||||||||
cancellation_message
|
||||||||||||||||||||||||||||||||||
cancellation_method
|
||||||||||||||||||||||||||||||||||
coupon_codes
|
||||||||||||||||||||||||||||||||||
created_at
|
||||||||||||||||||||||||||||||||||
credit_card
|
||||||||||||||||||||||||||||||||||
current_period_ends_at
|
||||||||||||||||||||||||||||||||||
current_period_started_at
|
||||||||||||||||||||||||||||||||||
customer
|
||||||||||||||||||||||||||||||||||
delayed_cancel_at
|
||||||||||||||||||||||||||||||||||
expires_at
|
||||||||||||||||||||||||||||||||||
net_terms
|
||||||||||||||||||||||||||||||||||
next_assessment_at
|
||||||||||||||||||||||||||||||||||
next_product_id
Reference: |
||||||||||||||||||||||||||||||||||
payment_collection_method
|
||||||||||||||||||||||||||||||||||
payment_type
|
||||||||||||||||||||||||||||||||||
previous_state
|
||||||||||||||||||||||||||||||||||
product
|
||||||||||||||||||||||||||||||||||
product_price_in_cents
|
||||||||||||||||||||||||||||||||||
product_version_number
|
||||||||||||||||||||||||||||||||||
reason_code
|
||||||||||||||||||||||||||||||||||
receives_invoice_emails
|
||||||||||||||||||||||||||||||||||
referral_code
|
||||||||||||||||||||||||||||||||||
signup_payment_id
Reference: |
||||||||||||||||||||||||||||||||||
signup_revenue
|
||||||||||||||||||||||||||||||||||
snap_day
|
||||||||||||||||||||||||||||||||||
state
|
||||||||||||||||||||||||||||||||||
stored_credential_transaction_id
Reference: |
||||||||||||||||||||||||||||||||||
total_revenue_in_cents
|
||||||||||||||||||||||||||||||||||
trial_ended_at
|
||||||||||||||||||||||||||||||||||
trial_started_at
|
||||||||||||||||||||||||||||||||||
updated_at
|
transactions
Replication Method : |
Key-based Incremental |
Replication Key |
created_at |
Primary Key |
id |
API endpoint : | |
Loading Behavior: |
The transactions
table contains info about the transactions for your Chargify site.
id
The transaction ID. Reference: |
created_at
|
amount_in_cents
|
card_expiration
|
card_number
|
card_type
|
component_handle
|
component_id
Reference: |
component_price_point_handle
|
component_price_point_id
|
customer_id
Reference: |
ending_balance_in_cents
|
gateway_order_id
|
gateway_transaction_id
|
gateway_used
|
item_name
|
kind
|
memo
|
parent_id
Reference: |
payment_id
Reference: |
period_range_start
|
period_range_end
|
price_point_handle
|
price_point_id
|
product_id
Reference: |
refunded_amount_in_cents
|
role
|
starting_balance_in_cents
|
statement_id
Reference: |
subscription_id
Reference: |
success
|
tax_id
|
transaction_type
|
type
|
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.