Jump to Content

Back to ChartMogul API Reference Guides and Tutorials Support Contact

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

Data Sources

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

Customers

Endpoint	Description
Create a Customer	Creates a `customer` object in ChartMogul under the specified `data_source`.
Create a Contact	Creates a `contact` object in ChartMogul under the specified `customer` within the selected `data_source`.
Retrieve a Customer	Retrieves a `customer` object from your ChartMogul account.
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.
Merge Customers	Accepts details of two `customer` objects that you want to merge.
List Customers	Lists all `customer` objects in your ChartMogul account.
List Contacts	Returns a list of all `contact` objects associated with a `customer` in your ChartMogul account.

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.