> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ChartMogul

> How to set up the ChartMogul connector, plus the actions that are available.

![ChartMogul](https://stackone-logos.com/api/chartmogul/filled/svg)

Previewv0.1.0[See changelog](/connectors/chartmogul/changelog)

[74 actions](#actions) · 1 auth method

Billing
CRM
Analytics

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](/gateway/concepts/organizations-and-projects).

**2. Configure the Connector**

Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](/gateway/quickstart#setup-connector-profile).

> **[Connector Profile · API Key](/connectors/chartmogul/guides/connector-profile/api-key)**
>
> Requires an API key generated in your ChartMogul profile. Keys do not expire and are sent using HTTP Basic authenticatio...

**3. Link an Account**

Link an account [from the dashboard](/connect/managing-connectors/linking-accounts#link-from-the-dashboard) (or via [StackOne Hub](/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> **[Link Account · API Key](/connectors/chartmogul/guides/link-account/api-key)**

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](/connect/ai-platforms/overview).

Other ways to call actions are listed in [Protocols & SDKs](/connect/protocols-and-sdks).

## Actions

<input type="search" placeholder="Search actions" aria-label="Search actions" />

74 actions

ActionDescription

Get Account Details`chartmogul_get_account`

Returns useful information about the authenticated ChartMogul account.

List Contacts`chartmogul_list_contacts`

List contact objects in the ChartMogul account, optionally filtered by customer, data source, or email.

Get Contact`chartmogul_get_contact`

Retrieve a single contact object from ChartMogul by its UUID.

Create Contact`chartmogul_create_contact`

Create a contact under a specified ChartMogul customer within the selected data source.

Update Contact`chartmogul_update_contact`

Update the modifiable attributes of an existing ChartMogul contact.

Delete Contact`chartmogul_delete_contact`

Permanently delete a ChartMogul contact and all of its associated data.

List Customers`chartmogul_list_customers`

List all customers in the ChartMogul account, with optional filters.

Get Customer`chartmogul_get_customer`

Retrieve a single customer object by its ChartMogul UUID.

Create Customer`chartmogul_create_customer`

Create a customer object under a specified ChartMogul data source.

Update Customer`chartmogul_update_customer`

Update the modifiable attributes of an existing customer.

Delete Customer`chartmogul_delete_customer`

Permanently delete a customer and all of its associated data.

Search Customers By Email`chartmogul_search_customers_by_email`

List all customers matching a given email address.

List Customer Invoices`chartmogul_list_customer_invoices`

List the invoices imported via the API for a given customer.

Create Customer Contact`chartmogul_create_customer_contact`

Add an additional contact to an existing customer.

List Invoices`chartmogul_list_invoices`

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

Get Invoice`chartmogul_get_invoice`

Retrieves a single invoice object from your ChartMogul account.

Import Invoices For A Customer`chartmogul_import_customer_invoices`

Creates invoices for a customer identified by ChartMogul UUID, auto-generating subscriptions from the invoice line items...

Import Invoices By Customer External ID`chartmogul_import_invoices_by_external_id`

Creates invoices for a customer identified by external ID and data source rather than ChartMogul UUID, auto-generating s...

Update Invoice`chartmogul_update_invoice`

Updates invoice-level details such as the date, due date, currency, or collection method.

Delete Invoice`chartmogul_delete_invoice`

Deletes the specified invoice object and all its associated line items and transactions.

Get Line Item`chartmogul_get_line_item`

Retrieve a single invoice line item from ChartMogul by its UUID, or by external ID together with data source UUID.

Create Line Item`chartmogul_create_line_item`

Add a subscription, one-time, or trial line item to an existing ChartMogul invoice identified by its UUID.

Create Line Item By External ID`chartmogul_create_line_item_by_external_id`

Add a subscription, one-time, or trial line item to a ChartMogul invoice identified by its external ID and data source.

Update Line Item`chartmogul_update_line_item`

Partially update an existing ChartMogul invoice line item identified by its UUID, or by external ID together with data s...

Delete Line Item`chartmogul_delete_line_item`

Delete a ChartMogul invoice line item and all its associated data, identified by UUID or by external ID together with da...

Get All Key Metrics`chartmogul_get_all_key_metrics`

Retrieve all key ChartMogul metrics as a single combined time series for a date range.

Get MRR Metrics`chartmogul_get_mrr_metrics`

Retrieve the Monthly Recurring Revenue (MRR) time series with its movement breakdown.

Get ARR Metrics`chartmogul_get_arr_metrics`

Retrieve the Annualized Run Rate (ARR) time series for a date range.

Get ARPA Metrics`chartmogul_get_arpa_metrics`

Retrieve the Average Revenue Per Account (ARPA) time series for a date range.

Get ASP Metrics`chartmogul_get_asp_metrics`

Retrieve the Average Sale Price (ASP) time series for a date range.

Get Customer Count Metrics`chartmogul_get_customer_count_metrics`

Retrieve the active customer count time series for a date range.

Get Customer Churn Rate Metrics`chartmogul_get_customer_churn_rate_metrics`

Retrieve the Customer Churn Rate time series for a date range.

Get MRR Churn Rate Metrics`chartmogul_get_mrr_churn_rate_metrics`

Retrieve the Net MRR Churn Rate time series for a date range.

Get LTV Metrics`chartmogul_get_ltv_metrics`

Retrieve the Customer Lifetime Value (LTV) time series for a date range, always monthly.

List Notes And Call Logs`chartmogul_list_notes`

List notes and call logs for the whole ChartMogul account or for a specific customer.

Get Note Or Call Log`chartmogul_get_note`

Retrieve a single ChartMogul note or call log by its UUID.

Create Note Or Call Log`chartmogul_create_note`

Log a free-text note or a call record against a ChartMogul customer.

Update Note Or Call Log`chartmogul_update_note`

Update the modifiable attributes of an existing ChartMogul note or call log.

Delete Note Or Call Log`chartmogul_delete_note`

Permanently delete a ChartMogul note or call log.

List Opportunities`chartmogul_list_opportunities`

Lists opportunity objects in your ChartMogul account, with optional filters for customer, owner, pipeline, stage and est...

Get An Opportunity`chartmogul_get_opportunity`

Retrieves a single opportunity object from your ChartMogul account by its UUID.

Create An Opportunity`chartmogul_create_opportunity`

Creates an opportunity object for a specified customer in ChartMogul.

Update An Opportunity`chartmogul_update_opportunity`

Partially updates an opportunity object in your ChartMogul account.

Delete An Opportunity`chartmogul_delete_opportunity`

Permanently deletes an opportunity object in your ChartMogul account.

List Plan Groups`chartmogul_list_plan_groups`

Returns a list of plan group objects in your ChartMogul account.

Get A Plan Group`chartmogul_get_plan_group`

Retrieves a plan group object from your ChartMogul account.

Create A Plan Group`chartmogul_create_plan_group`

Creates a plan group object in ChartMogul.

Update A Plan Group`chartmogul_update_plan_group`

Updates a plan group object in your ChartMogul account.

Delete A Plan Group`chartmogul_delete_plan_group`

Deletes the specified plan group object from your ChartMogul account.

List Plans In A Plan Group`chartmogul_list_plan_group_plans`

Returns a list of plan objects in a specific plan group in your ChartMogul account.

List Plans`chartmogul_list_plans`

Returns a list of plan objects in your ChartMogul account.

Get A Plan`chartmogul_get_plan`

Retrieves a plan object from your ChartMogul account.

Create A Plan`chartmogul_create_plan`

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

Update A Plan`chartmogul_update_plan`

Updates a plan object in your ChartMogul account.

Delete A Plan`chartmogul_delete_plan`

Deletes the specified plan object from your ChartMogul account.

List Data Sources`chartmogul_list_data_sources`

Lists all data source objects in the ChartMogul account.

Get A Data Source`chartmogul_get_data_source`

Retrieves a single data source object from the ChartMogul account.

Create A Data Source`chartmogul_create_data_source`

Creates a data source object for importing data into ChartMogul.

Delete A Data Source`chartmogul_delete_data_source`

Permanently delete a data source and every record imported through it.

List Subscription Events`chartmogul_list_subscription_events`

Lists subscription event objects from the ChartMogul account.

Create A Subscription Event`chartmogul_create_subscription_event`

Creates a subscription event for the specified source and customer.

Update A Subscription Event`chartmogul_update_subscription_event`

Updates an existing subscription event.

Delete A Subscription Event`chartmogul_delete_subscription_event`

Deletes a subscription event using either its external ID and source UUID or its ChartMogul ID.

List Customer Subscriptions`chartmogul_list_customer_subscriptions`

Returns a list of subscriptions for a given customer.

List Tasks`chartmogul_list_tasks`

Lists task objects in your ChartMogul account, with optional filters for customer, assignee, due date range and completi...

Get A Task`chartmogul_get_task`

Retrieves a single task object from your ChartMogul account by its UUID.

Create A Task`chartmogul_create_task`

Creates a task object for a specified customer and team member in ChartMogul.

Update A Task`chartmogul_update_task`

Partially updates a task object in your ChartMogul account, including marking it complete.

Delete A Task`chartmogul_delete_task`

Permanently deletes a task object in your ChartMogul account.

Get Transaction`chartmogul_get_transaction`

Retrieve a single ChartMogul payment or refund transaction by its UUID, or by external ID together with data source UUID...

Create Transaction`chartmogul_create_transaction`

Record a payment or refund transaction against a ChartMogul invoice identified by its UUID.

Create Transaction By External ID`chartmogul_create_transaction_by_external_id`

Record a payment or refund transaction against a ChartMogul invoice identified by its external ID and data source.

Update Transaction`chartmogul_update_transaction`

Partially update an existing ChartMogul transaction identified by its UUID, or by external ID together with data source...

Delete Transaction`chartmogul_delete_transaction`

Delete a ChartMogul transaction and all its associated data, identified by UUID or by external ID together with data sou...


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.