Skip to main content

Chargify Data Source

The Chargify connector enables you to ingest subscription billing and revenue data from your Chargify account into Nexla data flows. Use this connector to retrieve subscriptions, customers, products, invoices, events, and other billing-related records for reporting, analytics, revenue operations, and downstream processing. Follow the instructions below to create a new data flow that ingests data from a Chargify source in Nexla.
chargify_api.png

Chargify

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Chargify connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Chargify instance, and click Next; or, create a new Chargify credential for use in this flow.

  3. In Nexla, Chargify data sources can be created using pre-built endpoint templates, which expedite source setup for common Chargify endpoints. Each template is designed specifically for the corresponding Chargify endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Chargify sources can also be configured manually, allowing you to ingest data from Chargify endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Chargify endpoints. Each template is designed specifically for the corresponding Chargify endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

List Subscriptions

This endpoint retrieves a list of all subscriptions within your Chargify site. Use this endpoint to export subscription records for revenue reporting, churn analysis, lifecycle monitoring, or synchronization with a CRM or data warehouse.

  • This endpoint retrieves all subscriptions for your Chargify site. No additional configuration is required beyond selecting this endpoint template—the connector uses your site subdomain from the credential to construct the correct API URL.

  • Each subscription record includes details such as the subscription state (active, canceled, trialing, past_due, etc.), product information, customer reference, billing dates, current period start and end, balance in cents, and payment collection method.

  • The Chargify API returns subscriptions in pages of up to 200 records. The Nexla connector handles pagination automatically, fetching all available pages to ensure complete data retrieval.

Chargify subscription states include active, canceled, expired, trialing, past_due, pending, and suspended. For complete details about the subscription object structure and available filter parameters, see the Chargify API reference for List Subscriptions.

List Customers

This endpoint retrieves a list of all customers (subscribers) within your Chargify site. Use this endpoint to export customer records for CRM synchronization, contact management, customer success workflows, or reporting.

  • This endpoint retrieves all customers for your Chargify site. No additional configuration is required beyond selecting this endpoint template.

  • Each customer record includes fields such as the customer's first name, last name, email address, organization, reference identifier, billing address details, and the Chargify-assigned customer ID.

  • In Chargify, customers represent billing subscribers and are distinct from site users (admin and staff accounts). A single customer can have multiple subscriptions.

The reference field on a Chargify customer record is a custom identifier you can use to cross-reference customers with records in your own system (for example, a CRM contact ID or internal user ID). For complete details about the customer object, see the Chargify API reference for List Customers.

List Products

This endpoint retrieves all products defined within your Chargify site. Use this endpoint to export product catalog data for pricing analysis, product catalog synchronization, or reporting on which plans your subscribers are enrolled in.

  • This endpoint retrieves all products across all product families in your Chargify site. No additional configuration is required beyond selecting this endpoint template.

  • Each product record includes the product name, handle, description, price point details (price in cents, interval, and interval unit), product family association, and trial and expiration settings.

  • Products in Chargify represent subscription plans that customers can subscribe to. They are organized into product families, which group related plans together.

Chargify prices are stored in cents (integer values). For example, a product priced at $49.00 will appear as 4900 in the API response. Divide by 100 when displaying or using prices in downstream systems. For complete details, see the Chargify API reference for List Products.

List Invoices

This endpoint retrieves a list of invoices from your Chargify site. Use this endpoint to export invoice data for accounts receivable reporting, revenue recognition, audit trails, or financial reconciliation.

  • This endpoint retrieves all invoices across your Chargify site. No additional configuration is required beyond selecting this endpoint template.

  • Each invoice record includes the invoice number, issue date, due date, status (open, paid, voided, canceled), total amount due, amount paid, amount remaining, line items, customer information, and associated subscription reference.

  • Invoice statuses in Chargify include open (awaiting payment), paid, voided, and canceled. Invoices are automatically generated based on subscription billing events.

Invoice amounts in the Chargify API are represented in cents. For complete details about the invoice object structure and available filter parameters (such as filtering by status or date range), see the Chargify API reference for List Invoices.

List Events

This endpoint retrieves a list of events that have occurred within your Chargify site. Use this endpoint to audit activity, build event-driven pipelines, track subscription lifecycle changes, or feed events into a data warehouse for historical analysis.

  • This endpoint retrieves all site-level events from your Chargify account. No additional configuration is required beyond selecting this endpoint template.

  • Each event record includes the event type (such as subscription_state_change, payment_success, payment_failure, signup_success, or renewal_success), a timestamp, the associated subscription or customer ID, and the event-specific data payload.

  • Chargify generates events automatically in response to subscription and billing lifecycle changes. Events provide a full audit trail of all billing activity across your site.

The Chargify Events API returns events in reverse chronological order by default (most recent first). The Nexla connector retrieves events across all available pages. For complete details about event types and the event object structure, see the Chargify API reference for List Events.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Chargify data sources can be manually configured to ingest data from any valid Chargify API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Chargify sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that filter results using query parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Chargify API from the Method pulldown menu. For retrieving data from Chargify, use:

    • GET: For retrieving data such as subscriptions, customers, products, invoices, events, components, coupons, or payment profiles.

    Chargify's REST API also supports POST, PUT, and DELETE for write operations, though data source configurations most commonly use GET.

API Endpoint URL​

  1. Enter the URL of the Chargify API endpoint from which this source will fetch data in the Set API URL field. All Chargify API endpoints use the base URL https://{'{subdomain}'}.chargify.com/ where {'{subdomain}'} is your Chargify site's unique subdomain.

    Examples of commonly used Chargify source endpoints:

    • https://mycompany.chargify.com/subscriptions.json — List all subscriptions
    • https://mycompany.chargify.com/customers.json — List all customers
    • https://mycompany.chargify.com/products.json — List all products
    • https://mycompany.chargify.com/invoices.json — List all invoices
    • https://mycompany.chargify.com/events.json — List site events

Replace mycompany in the example URLs above with your actual Chargify site subdomain. The Chargify API accepts both .json and .xml format suffixes. JSON is the recommended format for all Nexla data flows. All Chargify API requests must use HTTPS—plain HTTP requests will be rejected.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Date/time macros are particularly useful when querying Chargify endpoints that accept date-range query parameters such as start_date, end_date, start_datetime, or end_datetime. For example, you can use macros to retrieve only the events or invoices created within the last day on each ingestion run.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful when, for example, you need to pass a list of Chargify subscription IDs or customer IDs retrieved from another Nexla source into Chargify API requests—enabling per-record or multi-entity data ingestion flows.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data returned by the Chargify API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response.

Chargify API list responses typically return a JSON array of objects. Each object in the array wraps the record data inside a named key corresponding to the resource type (for example, a subscription list returns an array where each element has a subscription key containing the subscription data). Specifying the correct path ensures that Nexla treats each element correctly.

Path to Data is important for Chargify responses. Without specifying the correct path, Nexla may not properly parse the response into individual records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $[*].subscription to access the subscription object from each element in a Chargify subscriptions list response).
    Path to Data Example:

    For the Chargify subscriptions endpoint, the response is a JSON array where each element contains a subscription key. Enter $[*].subscription as the path to data to extract each subscription record as a separate Nexla record.

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record.

For Chargify list responses, response-level context such as the total record count or page information may exist alongside the data array. If preserving this metadata alongside each record is useful for your downstream processing, you can specify a path to these fields using the Metadata configuration.

Metadata paths are particularly useful for preserving Chargify response context like total record counts or pagination details that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers may be required for specific Chargify API operations or versioning requirements.

    You do not need to include Authorization headers here—authentication is handled automatically by Nexla based on your credential configuration. The Chargify API accepts both JSON and XML formats; for JSON responses, include the header Accept:application/json if your endpoint requires it.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Chargify data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.