Endpoint Overview

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.

Create a Customer

Creates a customer object in ChartMogul under the specified 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.

List Customers

Lists all customer objects in your ChartMogul account.

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.

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.

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.

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.

Import an Invoice Transaction

Creates a transaction object for an invoice imported using the Import API.

List Customer's Subscriptions

Returns a list of subscription objects for a given customer. Subscriptions are auto-generated from invoice objects created using the Import API.

Cancel a Customer's Subscription

Cancels a subscription that was generated from an imported invoice.