Exporting Data

Exporting Data

Reference

Exporting Data

You can export Subscription, Customer, and Transaction data to a CSV file. Simply visit each tab in the UI and look for the “Export” link. After creating an export, the user who initiated it will receive a notification in-app and via email when the export is ready for download.

Your notification settings can be updated at: https://app.chargify.com/notification/settings/edit

You can also use our API to extract data.

Customers Export

  • id The unique identifier for this customer within Chargify. This is the ID displayed in the customer tab
  • first_name The first name of the customer
  • last_name The last name of the customer
  • organization Company/Organization name
  • email The email address of the customer
  • created_at The creation date for this customer. E.g.2016-06-03 12:43:50 -0400
  • reference The unique identifier used within your own application for this customer
  • address The customer’s shipping street address (i.e. “123 Main St.”).
  • address_2 Second line of the customer’s shipping address i.e. “Apt. 100”
  • city The customer’s shipping address city (i.e. “Boston”).
  • state The customer’s shipping address state (i.e. “MA”)
  • zip The customer’s shipping address zip code (i.e. “12345”)
  • country The customer shipping address country, perferably in ISO 3166-1 alpha-2 format (i.e. “US”).
  • phone The phone number of the customer
  • created_at TBD
  • updated_at The date of last update for this customer
  • cc_emails Additional email addresses that will communications

Invoices CSV

The invoices CSV export consists of the line items for each invoice, with the following columns:

  • transaction_id The ID of the Transaction (see API: Transactions )
  • created_at The creation date for this line item
  • invoice_id The ID of the Invoice this line item belongs to (see API: Invoices )
  • invoice_number The unique (to this site) identifier for the Invoice
  • type See API: Transactions for a list of available Transaction types
  • memo A note about the Transaction
  • amount_in_cents The amount in cents of the Transaction
  • starting_balance_in_cents The initial balance on the Subscription before the Transaction has been processed
  • ending_balance_in_cents The remaining balance on the Subscription after the Transaction has been processed
  • subscription_id The Subscription’s unique ID within Chargify
  • customer_id The Customer’s unique ID within Chargify
  • customer_name The Customer’s name
  • product_id The Product’s unique ID within Chargify
  • product_name The Product’s name
  • kind The specific “subtype” for the Transaction type (see API: Invoices for a list of available subtypes)
  • invoice_status The current status of the Invoice
  • invoice_settled_at The date the Invoice was settled at, if applicable customer_organization
  • coupon_name The coupon code, if the Transaction kind is coupon

Products Export

  • id The product name
  • name The product name
  • handle The product API handle
  • description The product description
  • accounting_code The product family accounting code (has no bearing in Chargify, may be used within your app)
  • product_family_id
  • product_family_name Nested attributes pertaining to the product family to which this product belongs
  • product_family_description
  • expiration_interval A numerical interval for the length a subscription to this product will run before it expires. See the description of interval for a description of how this value is coupled with an interval unit to calculate the full interval
  • expiration_interval_unit A string representing the trial interval unit for this product, either month or day
  • return_url The url to which a customer will be returned after a successful signup
  • update_return_url The url to which a customer will be returned after a successful account update.
  • created_at
  • price_in_cents The product price, in integer cents
  • interval 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
  • interval_unit A string representing the interval unit for this product, either month or day
  • initial_charge_in_cents The up front charge you have specified.
  • trial_price_in_cents The price of the trial period for a subscription to this product, in integer cents.
  • trial_interval A numerical interval for the length of the trial period of a subscription to this product. See the description of interval for a description of how this value is coupled with an interval unit to calculate the full interval
  • trial_interval_unit A string representing the trial interval unit for this product, either month or day
  • archived_at Timestamp indicating when this product was archived
  • require_credit_card? true/false: is a credit card required upon signup
  • request_credit_card? true/false: has a credit card been requested?
  • return_params
  • request_shipping_address? true/false: has the shipping address been requested?
  • require_shipping_address? true/false: is the shipping address been required?
  • request_billing_address? true/false: has the billing address been requested?
  • require_billing_address? true/false: is the billing address been required?
  • update_return_params The parameters we will append to your update_return_url.

Subscriptions Export

  • id
  • customer_id The ID of an existing customer within Chargify.
  • customer_reference The reference value (provided by you) of an existing customer within Chargify.
  • customer_name The full name of your Subscriber
  • customer_email The email address of your Subscriber
  • state The current state of the subscription. Please see the documentation for Subscription States
  • product_id The Product ID of the product for which the Subscription exists
  • next_product_id If a delayed product change is scheduled, the ID of the product that the subscription will be changed to at the next renewal.
  • product_name
  • recurring_price
  • recurring_interval
  • recurring_interval_unit
  • coupon The numeric id of the coupon currently applied to the subscription.
  • created_at
  • created_at_day
  • created_at_month
  • created_at_year
  • current_period_starts_at Timestamp relating to the start of the current (recurring) period
  • current_period_ends_at Timestamp relating to the end of the current (recurring) period (i.e. when the next regularly scheduled attempted charge will occur)
  • next_assessment_at Timestamp that indicates when capture of payment will be tried or retried.
  • trial_started_at Timestamp for when the trial period (if any) began
  • trial_ended_at Timestamp for when the trial period (if any) ended
  • activated_at
  • expires_at Timestamp giving the expiration date of this subscription (if any)
  • canceled_at
  • canceled_at_day
  • canceled_at_month
  • canceled_at_year
  • cancellation_message
  • balance_in_cents
  • balance
  • revenue_in_cents
  • revenue
  • credit_card_masked_number The masked credit card on file. E.g. XXXX-XXXX-XXXX-1111.
  • credit_card_type The type of credit card
  • credit_card_first_name The first name listed on the credit card
  • credit_card_last_name The last name listed on the credit card
  • credit_card_expiration_month The expiration month of the credit card on file
  • credit_card_expiration_year The expiration year of the credit card on file
  • credit_card_vault The location of the credit card token
  • credit_card_vault_token The credit card token
  • credit_card_customer_vault_token
  • credit_card_billing_address The credit card or bank account billing street address (i.e. “123 Main St.”).
  • credit_card_billing_address_2 Second line of the customer’s billing address i.e. “Apt. 100”
  • credit_card_billing_city
  • credit_card_billing_state The credit card or bank account billing address state
  • credit_card_billing_zip The credit card or bank account billing address zip code
  • credit_card_billing_country The credit card or bank account billing address country, in ISO 3166-1 alpha-2 format (i.e. “US”).
  • shipping_address
  • shipping_address_2
  • shipping_city
  • shipping_state
  • shipping_zip
  • shipping_country
  • customer_organization
  • customer_phone
  • cancel_at_end_of_period true/false:
  • delayed_cancel_at Timestamp for when the subscription is currently set to cancel. expires_at Timestamp giving the expiration date of this subscription (if any)
  • product_version_number
  • updated_at
  • referral_code The referral code used at the time of signup
  • state_changed_at
  • cancellation_method The process used to cancel the subscription, if the subscription has been canceled. Can be one of merchant_ui, merchant_api, dunning, or billing_portal.

Tax History

  • id The unique identifier for the Transaction
  • created_at Timestamp indicating when the Transaction was created
  • type The type of the transaction. In this case, tax is labeled as tax.
  • memo A note about the Transaction
  • amount_in_cents The amount in cents of the Transaction
  • ending_balance_in_cents The remaining balance on the subscription after the Transaction has been processed
  • subscription_id The unique identifier for the associated Subscription
  • customer_id The ID of the customer
  • customer_name The name of the customer
  • product_id The id of the product purchased
  • success true/false: was the transaction successful?
  • kind The specific “subtype” for the transaction_type
  • payment_id The unique identifier for the payment being explicitly refunded (in whole or in part) by this transaction. Will be null for all transaction types except for “Refund”. May be null even for Refunds. For partial refunds, more than one Refund transaction may reference the same payment_id.
  • gateway_transaction_id A gateway-specific identifier for the transaction, separate from the gateway_transaction_id:
  • customer_organization
  • gateway_order_id A gateway-specific identifier for the transaction, separate from the gateway_transaction_id.

Transactions Line Item Export

  • id The unique identifier for the Transaction
  • created_at Timestamp indicating when the Transaction was created
  • type The type of the transaction: adjustment, tax, payment, refund, credit, charge, info_transaction
  • memo A note about the Transaction
  • amount_in_cents The amount in cents of the Transaction
  • ending_balance_in_cents The remaining balance on the subscription after the Transaction has been processed
  • subscription_id The unique identifier for the associated Subscription
  • customer_id The ID of the customer
  • customer_name The name of the customer
  • product_id The id of the product purchased
  • success true/false: was the transaction successful?
  • kind The specific “subtype” for the transaction_type
  • payment_id The unique identifier for the payment being explicitly refunded (in whole or in part) by this transaction. Will be null for all transaction types except for “Refund”. May be null even for Refunds. For partial refunds, more than one Refund transaction may reference the same payment_id.
  • gateway_transaction_id A gateway-specific identifier for the transaction, separate from the gateway_transaction_id:
  • customer_organization
  • gateway_order_id A gateway-specific identifier for the transaction, separate from the gateway_transaction_id: