Skip to main content

ChartMogul Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a ChartMogul location.
chartmogul_api.png

ChartMogul

  1. Click the + icon on the Nexset that will be sent to the ChartMogul destination, and select the Send to Destination option from the menu.

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

  3. ChartMogul destinations can be manually configured to send data to any valid ChartMogul API endpoint. Using this connector, you can import customers, contacts, invoices, transactions, subscription events, and plan data directly into ChartMogul from any Nexla data source. You can also configure Nexla to automatically send the response received from the ChartMogul API after each call to a new Nexla webhook data source.

    First, select the API method that will be used for calls to the ChartMogul API from the Method pulldown menu. Common methods for ChartMogul destinations include:

    • POST: For creating new records (customers, invoices, transactions, data sources, plans)
    • PATCH: For partially updating existing records (updating customer attributes)
    • PUT: For replacing existing records in full
    • DELETE: For removing records

Data Format​

  1. Select the format in which the Nexset data will be sent to the ChartMogul API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call.

ChartMogul's REST API accepts and returns data in JSON format. Select JSON as the content format to ensure compatibility with all ChartMogul API endpoints.

API Endpoint URL​

  1. Enter the URL of the ChartMogul API endpoint to which you want to send the Nexset data in the URL field. The ChartMogul REST API base URL is https://api.chartmogul.com/v1. Common destination endpoint paths include:

    • https://api.chartmogul.com/v1/import/customers — Import new customer records
    • https://api.chartmogul.com/v1/import/customers/{uuid}/invoices — Import invoices for a specific customer
    • https://api.chartmogul.com/v1/import/subscriptions/{uuid}/cancel — Cancel a customer subscription
    • https://api.chartmogul.com/v1/customers/{uuid} — Update an existing customer record (PATCH)
    • https://api.chartmogul.com/v1/plans — Create a new subscription plan
    • https://api.chartmogul.com/v1/data_sources — Create a new data source
    • https://api.chartmogul.com/v1/customers/{uuid}/contacts — Create a contact for a customer

    For update and upsert operations, include the UUID of the record to be updated at the end of the URL.

ChartMogul uses immutable UUIDs (e.g., cus_00000000-0000-0000-0000-000000000000) to identify records. When sending data to endpoints that require a customer or subscription UUID in the URL path, ensure that the UUID is correctly mapped from your source data.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers and corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include the Authorization header or Content-Type header — these are handled automatically by Nexla using the API key from your ChartMogul credential configuration.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this ChartMogul destination, select the attributes from the Exclude Attributes pulldown menu.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Use attribute exclusion to remove internal Nexla metadata fields or source-specific fields that are not valid ChartMogul API parameters — sending unexpected fields may cause ChartMogul to return a 400 Bad Request error.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings. Some algorithms require additional settings — click on an algorithm listed below to view instructions for configuring these settings.

Property Inside JSON Object

  1. Enter the name of the JSON property that should contain the batched records in the Property Name field.
  2. If any additional properties should be included in the request, enter the properties in the Other Props field in JSON format.

Code

  1. Enter the code that will be used to create the batched request in the code editor below the Grouping Algorithm field.

Response Webhook​

Optional

Nexla can automatically send the response received from the ChartMogul API after each call to a new Nexla webhook data source. This option allows you to keep track of the status of each API call and any additional information returned after each call — for example, capturing the ChartMogul-assigned UUID for each newly imported customer.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the ChartMogul API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.

  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing​

After all endpoint settings have been configured, Nexla can send a test payload to the ChartMogul API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the ChartMogul API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to ChartMogul, open the destination resource menu and select Activate.

    The Nexset data will not be sent to ChartMogul until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.