
Chargify is a subscription billing software service that offers a recurring billing and subscription management space.

## Authentication

![Add authentication](add_authentication.png)

Log into the Chargify app and open your dashboard. From the sidebar menu, under Config, click on Integrations. You will then be able to create a new API key, which you will paste in the Tray authentication window. You also need to provide your site name. For instance if your Chargify site URL is "https://trayio.chargify.com" you will enter "trayio".


add_authentication.png

chargify

Address line 1

Address line 2

List of emails that should be cc’d on all customer communications

CC email

CC email list

City

Country

Email

First name

Last name

Organization

Phone

The unique identifier used within your own application for this customer

Reference

State

Tick box to give customer tax exempt status

Tax exempt

VAT number

ZIP/Post Code

create_customer

Create customer

The first name of the person authorizing the ACH agreement.

ACH authorizer first name

The last name of the person authorizing the ACH agreement.

ACH authorizer last name

Agreement terms

Next billing at

Calendar billing

Billing date

Calendar billing first charge

Coupon code

Required only for the payment profile drop down. Must be customer related to subscription.

Customer ID

Tick box to shift expiry of subscription to align with next billing at date

Expiration tracks next billing change

Payment collection method

Payment Profile ID

Used only for delayed product change. Tick box to indicate that a changed value for product_handle should schedule the product change to the next subscription renewal.

Product change delay

Subscription ID

update_subscription

Update subscription

Add a coupon to an existing subscription. 

add_coupon_to_subscription

Add coupon to subscription

Product ID

archive_product

Archive product

cancel_subscription

Cancel subscription

Percentage

Flat amount

Coupon

create_coupon

Create coupon

If true any coupons associated with the subscription will be applied to the migration.

Include coupons

If true the initial charges will be assessed

Include initial charge

If true the customer will migrate to the new product with a trial if one is available.

Include trial

If true the billing period will not change and a prorated charge will be issued for the new product. Otherwise the subscription's billing period will be reset to today and the full price of the new product will be charged.

Preserve period

Product handle

Migration

The subscription must be in the active or trialing state in order to be migrated.

create_migration

Create migration

Untick box if you do not want a Public Page automatically created for this product

Auto create signup page

Description

A numerical interval for the length a subscription to this product will run before it expires.

Expiration interval

Expiration interval unit

Initial charge in cents

The numerical interval. i.e. an interval of 30 coupled with an interval_unit of day would mean this product would renew every 30 days

Renewal interval

Renewal interval unit

Name

Price in cents

Found under Catalog > Products in Chargify

Product family ID

Request billing address

Request credit card

Request shipping address

Require billing address

Require credit card

Require shipping address

Return url

A string representing the tax code related to the product type.

Tax code

Taxable

A numerical interval for the length of the trial period of a subscription to this product. 

Trial interval

Trial interval unit

Trial price in cents

Trial type

The url to which a customer will be returned after a successful account update

Update return url

create_product

Create product

create_subscription

Create subscription

delete_customer

Delete customer

Get the exact URL required for a customer to access the Billing portal.

get_billing_management_link

Get billing management link

Returns an invoice based on the ID provided.

End date

Invoice ID

Start date

get_invoice

Get invoice

get_product

Get product

list_country_codes_ddl

List country codes DDL

Lists all customers associated with your site

Page

Sorting

list_customers

List customers

list_customer_subscriptions

List customer subscriptions

Results per page

list_events_by_site

List events by site

Retrieve a list of all events for a subscription

list_events_by_subscription

List events by subscription

Retrieve a list of invoices for a site filtered if required

Status

State / Status

list_invoices

List invoices

Retrieve a list of payment profiles for a site

list_payment_profiles

List payment profiles

list_payment_profiles_by_customer_ddl

List payment profiles by customer DDL

List all  for a site. Can be filtered if required.

Date type filter

The date of type selected in dropdown above e.g. created at

To date

Product

Product revision number

From date

list_subscriptions

List subscriptions

Retrieve list of transactions by site. Can be filtered if required.

Order by

Since date

Transaction type

Transaction types list

Until date

list_transactions_by_site

List transactions by site

Retrieve list of transactions by subscription. Can be filtered if required.

list_transactions_by_subscription

List transactions by subscription

Search for a customer by ID, email, reference or organization.

Search

search_customers

Search customers

update_customer

Update customer

update_product

Update product

After a subscription has been created, you may enable or disable the on/off component any time. The method creates a new allocation, setting the current allocated quantity for the Component and recording a memo.

If the change in cost is an upgrade, this determines if the charge should accrue to the next renewal or if capture should be attempted immediately. Defaults to the site setting if one is not provided.

Accrue charge

Component ID

 The type of credit to be created if the change in cost is a downgrade. Defaults to the component and then site setting if one is not provided.

Downgrade credit

A memo to record along with the allocation.

Memo

For On/Off components, turn them off or on.

Quantity

The type of charge to be created if the change in cost is an upgrade. Defaults to the component and then site setting if one is not provided.

Upgrade charge

create_allocation_for_on_or_off_component

Create Allocation for On or Off Component

Chargify

Added new operation:
Create allocation on or off component

Chargify 1.4

Chargify 1.3

Added an Endpoint
Add coupon to subscription

Chargify 1.2

Chargify 1.1

Initial release of the Chargify connector.
Implemented main operations for:
Customers
Events
Invoices
Products
Subscriptions
Transactions

Chargify

Overview

Authentication

All Operations