> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# ChartMogul

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

![ChartMogul logo](https://mintcdn.com/composio-preview/PudKL42NVsy5O-ND/images/toolkits/chartmogul.svg?fit=max\&auto=format\&n=PudKL42NVsy5O-ND\&q=85\&s=90f8a4bf8103b7ee0cd2edea7b8c5808)

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

## Tools

> [accordion] 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
>
> **city** `string`
>
> Customer city.
>
> **name** `string`
>
> Customer display name.
>
> **email** `string`
>
> Customer-level email address; use contact APIs for multiple people.
>
> **state** `string`
>
> Region code; for US states use ISO 3166-2 form such as US-CA.
>
> **company** `string`
>
> Customer company or organization.
>
> **country** `string`
>
> Two-letter ISO 3166-1 alpha-2 country code.
>
> **external\_id** `string` *required*
>
> Unique customer identifier from the caller's system.
>
> **lead\_status** `string ("New Lead" | "Working Lead" | "Qualified Lead" | "Unqualified Lead")`
>
> Initial lead status; subscription status is calculated by ChartMogul.
>
> **owner\_email** `string`
>
> Existing ChartMogul team member email to assign as owner.
>
> **postal\_code** `string`
>
> Customer postal or ZIP code.
>
> **website\_url** `string`
>
> Customer website URL or domain.
>
> **lead\_created\_at** `string`
>
> Past ISO 8601 timestamp when this customer became a lead.
>
> **data\_source\_uuid** `string` *required*
>
> ChartMogul source UUID that will own the customer; obtain it from LIST\_SOURCES.
>
> **free\_trial\_started\_at** `string`
>
> Past ISO 8601 trial-start timestamp, not earlier than lead\_created\_at.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **customer\_uuid** `string` *required*
>
> ChartMogul UUID of the customer to permanently delete with all associated data.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **include** `array`
>
> Additional account settings to include; omit for core account details.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **customer\_uuid** `string` *required*
>
> ChartMogul customer UUID, typically beginning with cus\_.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **plans** `array`
>
> Plan UUIDs, external IDs, or exact case-sensitive names to include.
>
> **end\_date** `string` *required*
>
> Inclusive end date in ISO 8601 date form.
>
> **interval** `string ("day" | "week" | "month" | "quarter" | "year")`
>
> Time interval used to group metric entries.
>
> **countries** `array`
>
> ISO 3166-1 alpha-2 country codes to include, such as US or DE.
>
> **start\_date** `string` *required*
>
> Inclusive start date in ISO 8601 date form.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **order** `string ("date" | "-date")`
>
> Sort by activity date ascending (date) or descending (-date).
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous response; omit for the first page.
>
> **end\_date** `string`
>
> Inclusive upper activity timestamp in ISO 8601 format.
>
> **per\_page** `integer`
>
> Maximum activities to return in this page (1-200).
>
> **start\_date** `string`
>
> Inclusive lower activity timestamp in ISO 8601 format.
>
> **activity\_type** `string ("new_biz" | "reactivation" | "expansion" | "contraction" | "churn")`
>
> MRR movement type to return; omit to include every type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Customers
>
> **Slug:** `CHARTMOGUL_LIST_CUSTOMERS`
>
> Return one page of customers filtered by source, identifier, email, status, or billing system.
>
> #### Input Parameters
>
> **email** `string`
>
> Customer email address to find.
>
> **cursor** `string`
>
> 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")`
>
> Lead or subscription status to filter by.
>
> **system** `string`
>
> Case-sensitive billing system to filter by, such as Stripe, Recurly, or Custom.
>
> **per\_page** `integer`
>
> Maximum customers to return in this page (1-200).
>
> **external\_id** `string`
>
> Exact external customer identifier to find.
>
> **data\_source\_uuid** `string`
>
> ChartMogul source UUID whose customers should be returned.
>
> **include\_associated\_contact\_emails** `boolean`
>
> When email is set, also match email addresses on associated contacts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Customer Subscriptions
>
> **Slug:** `CHARTMOGUL_LIST_CUSTOMER_SUBSCRIPTIONS`
>
> Return one page of subscriptions for a ChartMogul customer.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous response; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum subscriptions to return in this page (1-200).
>
> **customer\_uuid** `string` *required*
>
> ChartMogul UUID of the customer whose subscriptions should be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Invoices
>
> **Slug:** `CHARTMOGUL_LIST_INVOICES`
>
> Return one page of invoices, optionally filtered by source, customer, external ID, validation state, edit-history inclusion, or disabled state.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Opaque next\_cursor from a previous response; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum invoices to return in this page (1-200).
>
> **external\_id** `string`
>
> Exact external invoice identifier to find.
>
> **customer\_uuid** `string`
>
> ChartMogul customer UUID whose invoices should be returned.
>
> **with\_disabled** `boolean`
>
> Include disabled invoices.
>
> **validation\_type** `string ("valid" | "invalid" | "all")`
>
> Return valid, invalid, or all invoices.
>
> **data\_source\_uuid** `string`
>
> ChartMogul source UUID whose invoices should be returned.
>
> **include\_edit\_histories** `boolean`
>
> Include edit history summaries for supported automatic sources.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Plans
>
> **Slug:** `CHARTMOGUL_LIST_PLANS`
>
> Return one page of subscription plans, optionally filtered by source, external ID, or billing system.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Opaque continuation cursor returned by the previous call; omit for the first page.
>
> **system** `string`
>
> Billing system to filter by, such as Stripe, Recurly, or Custom.
>
> **per\_page** `integer`
>
> Maximum plans to return in this page (1-200).
>
> **external\_id** `string`
>
> Exact external plan identifier to filter by.
>
> **data\_source\_uuid** `string`
>
> ChartMogul source UUID whose plans should be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string`
>
> Exact source name to filter by.
>
> **system** `string`
>
> Billing system to filter by, such as Stripe, Recurly, or Custom.
>
> **include\_auto\_churn\_setting** `boolean`
>
> Include each source's past-due subscription handling setting.
>
> **include\_invoice\_handling\_setting** `boolean`
>
> Include each source's invoice handling setting.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **city** `string`
>
> Replacement city.
>
> **name** `string`
>
> Replacement customer display name.
>
> **email** `string`
>
> Replacement customer-level email address.
>
> **state** `string`
>
> Replacement region code, such as US-CA.
>
> **company** `string`
>
> Replacement company or organization.
>
> **country** `string`
>
> Replacement two-letter ISO 3166-1 alpha-2 country code.
>
> **lead\_status** `string ("New Lead" | "Working Lead" | "Qualified Lead" | "Unqualified Lead")`
>
> Replacement lead status; subscription status cannot be set directly.
>
> **owner\_email** `string`
>
> Existing ChartMogul team member email to assign as owner.
>
> **postal\_code** `string`
>
> Replacement postal or ZIP code.
>
> **website\_url** `string`
>
> Replacement customer website URL or domain.
>
> **customer\_uuid** `string` *required*
>
> ChartMogul UUID of the customer to update.
>
> **lead\_created\_at** `string`
>
> Replacement past ISO 8601 timestamp when the customer became a lead.
>
> **free\_trial\_started\_at** `string`
>
> Replacement past ISO 8601 timestamp when the customer started a free trial.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
