---
canonical_url: "https://docs.composio.dev/toolkits/chartmogul"
markdown_url: "https://docs.composio.dev/toolkits/chartmogul.md"
product: "platform"
version: null
last_updated: null
---

# ChartMogul

ChartMogul is a subscription analytics and revenue data platform for managing customers, billing data, metrics, and sales opportunities.

- **Category:** analytics
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `CHARTMOGUL`
- **Version:** 00000000_00

## Tools

### Create Customer

**Slug:** `CHARTMOGUL_CREATE_CUSTOMER`

Create a customer under a ChartMogul data source using a caller-owned external ID and optional profile or lead details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | Customer city. |
| `name` | string | No | Customer display name. |
| `email` | string | No | Customer-level email address; use contact APIs for multiple people. |
| `state` | string | No | Region code; for US states use ISO 3166-2 form such as US-CA. |
| `company` | string | No | Customer company or organization. |
| `country` | string | No | Two-letter ISO 3166-1 alpha-2 country code. |
| `external_id` | string | Yes | Unique customer identifier from the caller's system. |
| `lead_status` | string ("New Lead" | "Working Lead" | "Qualified Lead" | "Unqualified Lead") | No | Initial lead status; subscription status is calculated by ChartMogul. |
| `owner_email` | string | No | Existing ChartMogul team member email to assign as owner. |
| `postal_code` | string | No | Customer postal or ZIP code. |
| `website_url` | string | No | Customer website URL or domain. |
| `lead_created_at` | string | No | Past ISO 8601 timestamp when this customer became a lead. |
| `data_source_uuid` | string | Yes | ChartMogul source UUID that will own the customer; obtain it from LIST_SOURCES. |
| `free_trial_started_at` | string | No | Past ISO 8601 trial-start timestamp, not earlier than lead_created_at. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer

**Slug:** `CHARTMOGUL_DELETE_CUSTOMER`

Request permanent deletion of a customer and all associated ChartMogul data by UUID. ChartMogul accepts this asynchronously, so confirm disappearance with LIST_CUSTOMERS when completion matters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_uuid` | string | Yes | ChartMogul UUID of the customer to permanently delete with all associated data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account

**Slug:** `CHARTMOGUL_GET_ACCOUNT`

Return the connected ChartMogul account's identity, reporting currency, time zone, week start, and optionally selected churn and refund settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include` | array | No | Additional account settings to include; omit for core account details. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer

**Slug:** `CHARTMOGUL_GET_CUSTOMER`

Return one customer and its identifiers, lifecycle status, revenue values, ownership, location, and attributes by ChartMogul UUID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_uuid` | string | Yes | ChartMogul customer UUID, typically beginning with cus_. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Key Metrics

**Slug:** `CHARTMOGUL_GET_KEY_METRICS`

Return all key subscription metrics and current summaries for a date range, optionally grouped by interval and filtered by countries or plans.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `plans` | array | No | Plan UUIDs, external IDs, or exact case-sensitive names to include. |
| `end_date` | string | Yes | Inclusive end date in ISO 8601 date form. |
| `interval` | string ("day" | "week" | "month" | "quarter" | "year") | No | Time interval used to group metric entries. |
| `countries` | array | No | ISO 3166-1 alpha-2 country codes to include, such as US or DE. |
| `start_date` | string | Yes | Inclusive start date in ISO 8601 date form. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Activities

**Slug:** `CHARTMOGUL_LIST_ACTIVITIES`

Return one page of ChartMogul MRR activities for an optional date range, movement type, and date order, with a cursor when more are available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order` | string ("date" | "-date") | No | Sort by activity date ascending (date) or descending (-date). |
| `cursor` | string | No | Opaque next_cursor from a previous response; omit for the first page. |
| `end_date` | string | No | Inclusive upper activity timestamp in ISO 8601 format. |
| `per_page` | integer | No | Maximum activities to return in this page (1-200). |
| `start_date` | string | No | Inclusive lower activity timestamp in ISO 8601 format. |
| `activity_type` | string ("new_biz" | "reactivation" | "expansion" | "contraction" | "churn") | No | MRR movement type to return; omit to include every type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customers

**Slug:** `CHARTMOGUL_LIST_CUSTOMERS`

Return one page of customers filtered by source, identifier, email, status, or billing system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Customer email address to find. |
| `cursor` | string | No | Opaque next_cursor from a previous response; omit for the first page. |
| `status` | string ("New_Lead" | "Working_Lead" | "Qualified_Lead" | "Unqualified_Lead" | "Active" | "Past_Due" | "Cancelled") | No | Lead or subscription status to filter by. |
| `system` | string | No | Case-sensitive billing system to filter by, such as Stripe, Recurly, or Custom. |
| `per_page` | integer | No | Maximum customers to return in this page (1-200). |
| `external_id` | string | No | Exact external customer identifier to find. |
| `data_source_uuid` | string | No | ChartMogul source UUID whose customers should be returned. |
| `include_associated_contact_emails` | boolean | No | When email is set, also match email addresses on associated contacts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Plans

**Slug:** `CHARTMOGUL_LIST_PLANS`

Return one page of subscription plans, optionally filtered by source, external ID, or billing system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Opaque continuation cursor returned by the previous call; omit for the first page. |
| `system` | string | No | Billing system to filter by, such as Stripe, Recurly, or Custom. |
| `per_page` | integer | No | Maximum plans to return in this page (1-200). |
| `external_id` | string | No | Exact external plan identifier to filter by. |
| `data_source_uuid` | string | No | ChartMogul source UUID whose plans should be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sources

**Slug:** `CHARTMOGUL_LIST_SOURCES`

Return the account's billing data sources, optionally filtered by name or system and with selected source settings included.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Exact source name to filter by. |
| `system` | string | No | Billing system to filter by, such as Stripe, Recurly, or Custom. |
| `include_auto_churn_setting` | boolean | No | Include each source's past-due subscription handling setting. |
| `include_invoice_handling_setting` | boolean | No | Include each source's invoice handling setting. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Customer

**Slug:** `CHARTMOGUL_UPDATE_CUSTOMER`

Update selected profile, ownership, location, timing, website, or lead-status fields on an existing ChartMogul customer. Omitted fields remain unchanged; tags and custom attributes are not replaced.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `city` | string | No | Replacement city. |
| `name` | string | No | Replacement customer display name. |
| `email` | string | No | Replacement customer-level email address. |
| `state` | string | No | Replacement region code, such as US-CA. |
| `company` | string | No | Replacement company or organization. |
| `country` | string | No | Replacement two-letter ISO 3166-1 alpha-2 country code. |
| `lead_status` | string ("New Lead" | "Working Lead" | "Qualified Lead" | "Unqualified Lead") | No | Replacement lead status; subscription status cannot be set directly. |
| `owner_email` | string | No | Existing ChartMogul team member email to assign as owner. |
| `postal_code` | string | No | Replacement postal or ZIP code. |
| `website_url` | string | No | Replacement customer website URL or domain. |
| `customer_uuid` | string | Yes | ChartMogul UUID of the customer to update. |
| `lead_created_at` | string | No | Replacement past ISO 8601 timestamp when the customer became a lead. |
| `free_trial_started_at` | string | No | Replacement past ISO 8601 timestamp when the customer started a free trial. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |