ChartMogul

The ChartMogul modules allow you to create, update, retrieve, and delete customers, plans, plan group, data source, and subscriptions in your ChartMogul account.

Getting Started with ChartMogul

Prerequisites

  • A ChartMogul account

In order to use ChartMogul with {{Make}}, it is necessary to have a ChartMogul account. If you do not have one, you can create a ChartMogul account at app.chartmogul.com/sign_up/1.

For the list of available endpoints, see the ChartMogul API documentation.

Connect ChartMogul to {{Make}}

To connect your ChartMogul account to {{Make}}, you need to obtain the Access Token and Secret Key from your ChartMogul account and insert them in the ChartMogul module scenario.

  1. Login to your ChartMogul account.

  2. Go to Admin (cog-wheel) > API tab.

    61d5aa42b90a3.gif
  3. Copy the Access Token and Secret Key values to a safe place.

    chatmogul-1.png
  4. Log in to your {{Make}} account, add any ChartMogul module scenario, and click the Add button next to the Connection field.

    chartmogul-2.png
  5. Optional: In the Connection name field, enter a name for the connection.

  6. In the Token and Secret Key field, enter the values copied in Step 3 and click Save.

You have successfully established the connection. You can now edit scenario and add more ChartMogul modules. If your connection needs reauthorization at any point, follow the connection renewal steps here.

Customer
List Customers

Returns a list of invoice objects created using the API in your ChartMogul account.

Get a Customer

Retrieves a customer object from your ChartMogul account.

Create a Customer

Creates a customer object in ChartMogul under the specified data source.

Update a Customer

Updates specific modifiable attributes of a customer object in your ChartMogul account.

Delete a Customer

Deletes the specified customer object and all its associated data.

Plan
List Plans

Returns a list of plan objects in your ChartMogul account.

Get a Plan

Retrieves a plan object from your ChartMogul account.

Create a Plan

Creates a plan object in ChartMogul under the specified source.

Update a Plan

Updates a plan object in your ChartMogul account.

Delete a Plan

Deletes the specified plan object in your ChartMogul account.

Plan Group
Get a Plan Group

Retrieves a plan group object from your ChartMogul account.

Create a Plan Group

Creates a plan group object in ChartMogul.

Update a Plan Group

Updates a plan group object in your ChartMogul account.

Deletes a Plan Group

Deletes the specified plan group object from your ChartMogul account.

Data Source
List Data Source

List all data source objects in your ChartMogul account.

Get a Data Source

Retrieves a data source object from your ChartMogul account.

Create a Data Source

Creates a data source object for importing data into ChartMogul.

Delete a Data Source

Deletes the specified data source object and all its associated data.

Invoices
List Invoices

Returns a list of invoice objects created using the API in your ChartMogul account.

Get an Invoice

Retrieves an invoice object from your ChartMogul account.

Import an Invoice

Creates an invoice for a given API customer.

Delete an Invoice

Deletes the specified invoice object and all its associated data.

Import an Invoice Transaction

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

Subscriptions
List Customer's Subscriptions

Returns a list of subscription objects for a given customer.

Cancel a Customer's Subscription

Cancels a subscription that was generated from an imported invoice.

Other
Make an API Call

Performs an arbitrary authorized API call.