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

EndpointDescription
Create a SourceCreates a data_source object for importing data into ChartMogul.
Retrieve a SourceRetrieves a data_source object from your ChartMogul account.
Delete a SourceDeletes the specified data_source object and all its associated data.
List SourcesLists all data_source objects in your ChartMogul account.

Customers

Create, Update and Delete a Customer

EndpointDescription
Create a CustomerCreates a customer object in ChartMogul under the specified data_source.
Update a CustomerUpdates certain modifiable attributes of a customer object in your ChartMogul account.
Delete a CustomerDeletes the specified customer object that was created using the Import API, and all its associated data.

List Customers

EndpointDescription
List a CustomerList a customer object from your ChartMogul account by Customer UUID.
List Customers by Data Source, System, External ID or StatusLists all customer objects in your ChartMogul account by Data Source, System, External ID or Status.
List Customers by EmailList customer object in your ChartMogul account by Email.

Customer's Contacts

EndpointDescription
Add a Contact to CustomerCreates a contact object in ChartMogul under the specified customer within the selected data_source.
List Customer's ContactsReturns a list of all contact objects associated with a customer in your ChartMogul account.

Customer's Tags and Attributes

EndpointDescription
Add Tags to a CustomerAdds tags to a given customer.
Add Tags to Customers by EmailAdds tags to customers that have the specified email address.
Remove Tags from a CustomerRemoves tags from a given customer.
Add Custom Attributes to a CustomerAdds custom attributes to a given customer.
Add Custom Attributes to Customers with EmailAdds custom attributes to customers that have the specified email address.
Update Custom Attributes of a CustomerUpdates the custom attributes of a given customer.
Remove Custom Attributes from a CustomerRemoves custom attributes from a given customer.
Retrieve Customer’s Tags and AttributesRetrieves the tags and attributes of a given customer.

Merge Customers

EndpointDescription
Merge CustomersAccepts details of two customer objects that you want to merge.

Contacts

EndpointDescription
Create a ContactCreates a contact object in ChartMogul under a specified customer within the selected data_source.
Retrieve a ContactRetrieves a contact object from your ChartMogul account.
Update a ContactUpdates certain modifiable attributes of a contact object in your ChartMogul account.
Delete a ContactDeletes the specified contact object and all associated data.
Merge ContactsAccepts details of two contact objects you want to merge.
List ContactsReturns a list of all contact objects in your ChartMogul account.

Plans

EndpointDescription
Create a PlanCreates a plan object in ChartMogul under the specified data_source.
Retrieve a PlanRetrieves a plan object from your ChartMogul account.
Update a PlanUpdates a plan object in your ChartMogul account.
Delete a PlanDeletes a plan object from your ChartMogul account.
List PlansReturns a list of plan objects in your ChartMogul account.

Plan Groups

EndpointDescription
Create a Plan GroupCreates a plan_group object in ChartMogul.
Retrieve a Plan GroupRetrieves a plan_group object from your ChartMogul account.
Update a Plan GroupUpdates a plan_group object in your ChartMogul account.
Delete a Plan GroupDeletes a plan_group object from your ChartMogul account.
List Plan GroupsReturns a list of plan_group objects in your ChartMogul account.
List Plans in a Plan GroupReturns a list of plan objects in a specific plan_group in your ChartMogul account.

Subscriptions

EndpointDescription
List Customer SubscriptionsReturns a list of subscription objects for a given customer. Subscriptions are auto-generated from invoice objects created using the Import API.
Connect SubscriptionsAccepts details of two subscription objects that you want to connect.
Cancel a Customer’s SubscriptionCancels a subscription that was generated from an imported invoice.

Invoices

EndpointDescription
Import InvoicesCreates invoices for a given API customer. ChartMogul auto-generates subscription objects from these invoices.
Retrieve an InvoiceRetrieves an invoice object from your ChartMogul account.
Update an Invoice StatusUpdates the status of an invoice identified by invoice_external_id under the specified data_source.
Delete an InvoiceDeletes the specified invoice object and all its associated data.
List Customer’s InvoicesReturns a list of invoice objects created using the API for a given customer.
List InvoicesReturns a list of invoice objects created using the API in your ChartMogul account.
Delete All Customer’s InvoicesDeletes all invoices for a given customer and data source.

Transactions

EndpointDescription
Import an Invoice TransactionCreates a transaction object for an invoice imported using the Import API.

Subscription Events

EndpointDescription
Create a Subscription EventCreates a subscription_event object for the specified data_source and customer.
Update a Subscription EventUpdates an existing subscription_event object.
Delete a Subscription EventDeletes a specified subscription_event object either by subscription event external_id and data_source_uuid or subscription event id`.
List Subscription EventsLists an array of subscription_event objects from your ChartMogul account.

Bulk Import

EndpointDescription
Import Data in BulkImports multiple customers, plans, invoices, line items, transactions, and subscription events with a single API query.
Track Import StatusAllows you to track the import status.