Endpoint Overview

The Import API allows any subscription business (or subscription billing platform) to connect with ChartMogul and leverage the powerful analytics that we deliver.

For a step-by-step guide to integrating with this API, follow this tutorial.

Import API endpoints

Sources

Endpoint	Description
Create a Source	Creates a `data_source` object for importing data into ChartMogul.
Retrieve a Source	Retrieves a `data_source` object from your ChartMogul account.
Delete a Source	Deletes the specified `data_source` object and all its associated data.
List Sources	Lists all `data_source` objects in your ChartMogul account.

Customers

Create, Update and Delete a Customer

Endpoint	Description
Create a Customer	Creates a `customer` object in ChartMogul under the specified `data_source`.
Update a Customer	Updates certain modifiable attributes of a `customer` object in your ChartMogul account.
Delete a Customer	Deletes the specified `customer` object that was created using the Import API, and all its associated data.

List Customers

Endpoint	Description
List a Customer	List a `customer` object from your ChartMogul account by Customer UUID.
List Customers by Data Source, System, External ID or Status	Lists all `customer` objects in your ChartMogul account by Data Source, System, External ID or Status.
List Customers by Email	List `customer` object in your ChartMogul account by Email.

Customer's Contacts

Endpoint	Description
Add a Contact to Customer	Creates a `contact` object in ChartMogul under the specified `customer` within the selected `data_source`.
List Customer's Contacts	Returns a list of all `contact` objects associated with a `customer` in your ChartMogul account.

Customer's Tags and Attributes

Endpoint	Description
Add Tags to a Customer	Adds tags to a given customer.
Add Tags to Customers by Email	Adds tags to customers that have the specified email address.
Remove Tags from a Customer	Removes tags from a given customer.
Add Custom Attributes to a Customer	Adds custom attributes to a given customer.
Add Custom Attributes to Customers with Email	Adds custom attributes to customers that have the specified email address.
Update Custom Attributes of a Customer	Updates the custom attributes of a given customer.
Remove Custom Attributes from a Customer	Removes custom attributes from a given customer.
Retrieve Customer’s Tags and Attributes	Retrieves the tags and attributes of a given customer.

Merge Customers

Endpoint	Description
Merge Customers	Accepts details of two `customer` objects that you want to merge.

Contacts

Endpoint	Description
Create a Contact	Creates a `contact` object in ChartMogul under a specified `customer` within the selected `data_source`.
Retrieve a Contact	Retrieves a `contact` object from your ChartMogul account.
Update a Contact	Updates certain modifiable attributes of a `contact` object in your ChartMogul account.
Delete a Contact	Deletes the specified `contact` object and all associated data.
Merge Contacts	Accepts details of two `contact` objects you want to merge.
List Contacts	Returns a list of all `contact` objects in your ChartMogul account.

Plans

Endpoint	Description
Create a Plan	Creates a `plan` object in ChartMogul under the specified `data_source`.
Retrieve a Plan	Retrieves a `plan` object from your ChartMogul account.
Update a Plan	Updates a `plan` object in your ChartMogul account.
Delete a Plan	Deletes a `plan` object from your ChartMogul account.
List Plans	Returns a list of `plan` objects in your ChartMogul account.

Plan Groups

Endpoint	Description
Create a Plan Group	Creates a `plan_group` object in ChartMogul.
Retrieve a Plan Group	Retrieves a `plan_group` object from your ChartMogul account.
Update a Plan Group	Updates a `plan_group` object in your ChartMogul account.
Delete a Plan Group	Deletes a `plan_group` object from your ChartMogul account.
List Plan Groups	Returns a list of `plan_group` objects in your ChartMogul account.
List Plans in a Plan Group	Returns a list of `plan` objects in a specific `plan_group` in your ChartMogul account.

Subscriptions

Endpoint	Description
List Customer Subscriptions	Returns a list of `subscription` objects for a given customer. Subscriptions are auto-generated from `invoice` objects created using the Import API.
Connect Subscriptions	Accepts details of two `subscription` objects that you want to connect.
Cancel a Customer’s Subscription	Cancels a subscription that was generated from an imported invoice.

Invoices

Endpoint	Description
Import Invoices	Creates invoices for a given API customer. ChartMogul auto-generates `subscription` objects from these invoices.
Retrieve an Invoice	Retrieves an `invoice` object from your ChartMogul account.
Update an Invoice Status	Updates the status of an invoice identified by `invoice_external_id` under the specified `data_source`.
Delete an Invoice	Deletes the specified `invoice` object and all its associated data.
List Customer’s Invoices	Returns a list of `invoice` objects created using the API for a given customer.
List Invoices	Returns a list of `invoice` objects created using the API in your ChartMogul account.
Delete All Customer’s Invoices	Deletes all invoices for a given customer and data source.

Transactions

Endpoint	Description
Import an Invoice Transaction	Creates a `transaction` object for an invoice imported using the Import API.

Subscription Events

Endpoint	Description
Create a Subscription Event	Creates a `subscription_event` object for the specified `data_source` and `customer`.
Update a Subscription Event	Updates an existing `subscription_event` object.
Delete a Subscription Event	Deletes a specified `subscription_event` object either by subscription event `external_id` and `data_source_uuid` or `subscription event` id`.
List Subscription Events	Lists an array of `subscription_event` objects from your ChartMogul account.

Bulk Import

Endpoint	Description
Import Data in Bulk	Imports multiple customers, plans, invoices, line items, transactions, and subscription events with a single API query.
Track Import Status	Allows you to track the import status.