> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to ChartMogul

The ChartMogul connector lets your AI agent act in each user's ChartMogul account. Each user connects their own ChartMogul API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

**Authentication:** API Key
**Categories:** Analytics, CRM & Sales
**Tools:** 60: 34 read, 20 write, 6 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=CHARTMOGUL)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the ChartMogul connection

   In **AgentKit > Connections**, create a ChartMogul connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'chartmogul_account_get',
  toolInput: {},
  connector: 'chartmogul',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="chartmogul_account_get",
    tool_input={},
    connection_name="chartmogul",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `chartmogul_account_get`

Get Account · Read-only

Get details of the ChartMogul account the API key belongs to.
Returns the account name, currency, time zone and week start, plus any extra settings requested.
Use chartmogul_account_get to check the connection and the account currency.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `include` (`string`, optional): Comma-separated extra settings to include: churn_recognition, churn_when_zero_mrr, auto_churn_subscription, refund_handling, proximate_movement_reclassification. Example: churn_recognition,refund_handling

Example input: `{}`

### `chartmogul_activities_list`

List Activities · Read-only

List MRR activities across all customers (new business, reactivation, expansion, contraction, churn) for a period.
Returns a page of activities with customer, date, type, MRR change and a cursor.
Use chartmogul_activities_list to see what drove MRR changes. Use chartmogul_customer_activities_list for one customer.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
- `end_date` (`string`, optional): Only activities on or before this ISO 8601 time. Example: 2026-10-31
- `order` (`string`, optional): date (oldest first, default) or -date (newest first). One of: date, -date. Example: -date. One of: `date`, `-date`.
- `per_page` (`integer`, optional): Results per page, at most 200 (the default). Example: 50
- `start_date` (`string`, optional): Only activities on or after this ISO 8601 time. Example: 2026-10-01
- `type` (`string`, optional): Only this activity type. One of: new_biz, reactivation, expansion, contraction, churn. Example: churn. One of: `new_biz`, `reactivation`, `expansion`, `contraction`, `churn`.

Example input: `{}`

### `chartmogul_contact_get`

Get Contact · Read-only

Get one contact by UUID.
Returns the contact's name, email, phone, position, customer and custom attributes.
Use chartmogul_contact_get when you know the UUID. Use chartmogul_contacts_list to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_uuid` (`string`, required): ChartMogul contact UUID (con_...), from chartmogul_contacts_list. Example: con_00000000-0000-0000-0000-000000000000
- `attributes_with_history` (`string`, optional): Comma-separated contact fields to include edit history for, such as email or title. Example: email,title
- `with_overrides` (`boolean`, optional): Include the contact's overridden fields. Example: false

Example input: `{"contact_uuid":"<contact_uuid>"}`

### `chartmogul_contacts_list`

List Contacts · Read-only

List contacts, optionally for one customer, source or email.
Returns a page of contacts and a cursor for the next page.
Use chartmogul_contacts_list to find contacts. Use chartmogul_contact_get for one.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
- `customer_external_id` (`string`, optional): Only contacts of the customer with this external ID. Example: cus_0001
- `customer_uuid` (`string`, optional): Only contacts of this customer. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `data_source_uuid` (`string`, optional): Only contacts in this source. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
- `email` (`string`, optional): Only contacts with this email. Example: jane@example.com
- `per_page` (`integer`, optional): Results per page, at most 200 (the default). Example: 50

Example input: `{}`

### `chartmogul_customer_activities_list`

List Customer Activities · Read-only

List a customer's MRR activities (new business, expansion, contraction, churn, reactivation).
Returns a page of activities with date, type, MRR change and description.
Use chartmogul_customer_activities_list for one customer. Use chartmogul_activities_list across all customers.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_uuid` (`string`, required): ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `cursor` (`string`, optional): Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
- `per_page` (`integer`, optional): Results per page, at most 200 (the default). Example: 50

Example input: `{"customer_uuid":"<customer_uuid>"}`

### `chartmogul_customer_attributes_get`

Get Customer Attributes · Read-only

Get a customer's tags, custom attributes and billing-system metadata.
Returns the attributes object, and optionally overrides and edit history.
Use chartmogul_customer_attributes_get to read custom attributes. Use chartmogul_customer_get for the full customer.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_uuid` (`string`, required): ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `attributes_with_history` (`string`, optional): Comma-separated custom attribute names (for example custom.channel) to include edit history for. Example: custom.channel
- `with_overrides` (`boolean`, optional): Include overrides on custom attributes. Example: false

Example input: `{"customer_uuid":"<customer_uuid>"}`

### `chartmogul_customer_get`

Get Customer · Read-only

Get one customer by UUID.
Returns the customer's details, status, MRR, ARR, address, tags and custom attributes, and optionally overrides and attribute history.
Use chartmogul_customer_get when you know the UUID. Use chartmogul_customers_list or chartmogul_customers_search_by_email to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_uuid` (`string`, required): ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `attributes_with_history` (`string`, optional): Comma-separated attribute names to include edit history for, such as company, owner, status, address or custom.channel. Example: company,owner
- `with_overrides` (`boolean`, optional): Include an overrides object flagging the customer's overridden fields. Example: false

Example input: `{"customer_uuid":"<customer_uuid>"}`

### `chartmogul_customer_invoices_list`

List Customer Invoices · Read-only

List the invoices imported through the API for one customer.
Returns a page of invoices with line items and transactions.
Use chartmogul_customer_invoices_list for one customer. Use chartmogul_invoices_list across the account.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_uuid` (`string`, required): ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `cursor` (`string`, optional): Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
- `per_page` (`integer`, optional): Results per page, at most 200 (the default). Example: 50
- `validation_type` (`string`, optional): valid (default), invalid or all. One of: valid, invalid, all. Example: valid. One of: `valid`, `invalid`, `all`.

Example input: `{"customer_uuid":"<customer_uuid>"}`

### `chartmogul_customer_subscriptions_list`

List Customer Subscriptions · Read-only

List a customer's subscriptions.
Returns a page of subscriptions with plan, quantity, MRR, ARR, status and billing cycle.
Use chartmogul_customer_subscriptions_list to see what a customer pays for.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_uuid` (`string`, required): ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `cursor` (`string`, optional): Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
- `per_page` (`integer`, optional): Results per page, at most 200 (the default). Example: 50

Example input: `{"customer_uuid":"<customer_uuid>"}`

### `chartmogul_customers_list`

List Customers · Read-only

List customers, optionally filtered by data source, external ID, email, status or billing system.
Returns a page of customers with UUID, name, status, MRR, ARR and attributes, plus a cursor for the next page.
Use chartmogul_customers_list to browse or filter. Use chartmogul_customers_search_by_email to look up by email only.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
- `data_source_uuid` (`string`, optional): Only customers from this source. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
- `email` (`string`, optional): Only customers with this email. Example: jane@example.com
- `external_id` (`string`, optional): Only the customer with this external ID. Example: cus_0001
- `per_page` (`integer`, optional): Results per page, at most 200 (the default). Example: 50
- `status` (`string`, optional): Only this status: New_Lead, Working_Lead, Qualified_Lead, Unqualified_Lead, Active, Past_Due or Cancelled. One of: New_Lead, Working_Lead, Qualified_Lead, Unqualified_Lead, Active, Past_Due, Cancelled. Example: Active. One of: `New_Lead`, `Working_Lead`, `Qualified_Lead`, `Unqualified_Lead`, `Active`, `Past_Due`, `Cancelled`.
- `system` (`string`, optional): Only customers from this billing system (case-sensitive), for example Stripe or Custom. Example: Stripe
- `with_associated_emails` (`boolean`, optional): With email, also match customers whose contacts have the email. Example: false

Example input: `{}`

### `chartmogul_customers_search_by_email`

Search Customers by Email · Read-only

Find customers by email address.
Returns a page of matching customers.
Use chartmogul_customers_search_by_email when you only have an email. Use chartmogul_customers_list for other filters.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
- `email` (`string`, optional): Email address to search for. Example: jane@example.com
- `per_page` (`integer`, optional): Results per page, at most 200 (the default). Example: 50
- `with_associated_emails` (`boolean`, optional): Also match customers whose contacts have the email. Example: true

Example input: `{}`

### `chartmogul_invoice_get`

Get Invoice · Read-only

Get one invoice by UUID.
Returns the invoice with its line items and transactions.
Use chartmogul_invoice_get when you know the UUID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `invoice_uuid` (`string`, required): ChartMogul invoice UUID (inv_...), from chartmogul_invoices_list. Example: inv_565c73b2-85b9-49c9-a25e-2b7df6a677c9
- `include_edit_histories` (`boolean`, optional): Include a summary of user edits. Example: false
- `validation_type` (`string`, optional): valid (default), invalid or all. One of: valid, invalid, all. Example: all. One of: `valid`, `invalid`, `all`.
- `with_disabled` (`boolean`, optional): Return the invoice even if disabled. Example: false

Example input: `{"invoice_uuid":"<invoice_uuid>"}`

### `chartmogul_invoices_list`

List Invoices · Read-only

List invoices imported through the API, optionally by source, customer or external ID.
Returns a page of invoices with line items and transactions.
Use chartmogul_invoices_list across the account. Use chartmogul_customer_invoices_list for one customer.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
- `customer_uuid` (`string`, optional): Only this customer's invoices. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `data_source_uuid` (`string`, optional): Only invoices in this source. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
- `external_id` (`string`, optional): Only the invoice with this external ID. Example: inv_0001
- `include_edit_histories` (`boolean`, optional): Include a summary of user edits (automatic sources). Example: false
- `per_page` (`integer`, optional): Results per page, at most 200 (the default). Example: 50
- `validation_type` (`string`, optional): valid (default), invalid or all. One of: valid, invalid, all. Example: valid. One of: `valid`, `invalid`, `all`.
- `with_disabled` (`boolean`, optional): Include disabled invoices. Example: false

Example input: `{}`

### `chartmogul_metrics_all_get`

Get All Key Metrics · Read-only

Get every key SaaS metric (MRR, ARR, ARPA, ASP, customers, churn rates, LTV) for a date range, optionally by country, plan or CFL filter.
Returns one entry per interval with all metrics.
Use chartmogul_metrics_all_get for a dashboard view. Use the single-metric tools for a summary of one metric.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): End of the period, ISO 8601 date. Example: 2026-10-31
- `start_date` (`string`, required): Start of the period, ISO 8601 date. Example: 2026-01-01
- `filters` (`string`, optional): Advanced filter in ChartMogul Filter Language (CFL). Example: currency~ANY~'USD'
- `geo` (`string`, optional): Comma-separated ISO 3166-1 alpha-2 country codes to filter by. Example: US,GB
- `interval` (`string`, optional): Bucket size: day, week, month (default), quarter or year. One of: day, week, month, quarter, year. Example: month. One of: `day`, `week`, `month`, `quarter`, `year`.
- `plans` (`string`, optional): Comma-separated plan UUIDs, external IDs or names (case-sensitive) to filter by. Example: Gold Monthly

Example input: `{"end_date":"<end_date>","start_date":"<start_date>"}`

### `chartmogul_metrics_arpa_get`

Get ARPA · Read-only

Get Average Revenue Per Account (ARPA) for a date range, optionally by country, plan or CFL filter.
Returns a summary (current, previous and percentage change) and one entry per interval.
Use chartmogul_metrics_arpa_get for this metric alone. Use chartmogul_metrics_all_get for every key metric in one call.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): End of the period, ISO 8601 date. Example: 2026-10-31
- `start_date` (`string`, required): Start of the period, ISO 8601 date. Example: 2026-01-01
- `filters` (`string`, optional): Advanced filter in ChartMogul Filter Language (CFL), for example currency~ANY~'USD'. Example: currency~ANY~'USD'
- `geo` (`string`, optional): Comma-separated ISO 3166-1 alpha-2 country codes to filter by. Example: US,GB,DE
- `interval` (`string`, optional): Bucket size: day, week, month, quarter, year (default month). One of: day, week, month, quarter, year. Example: month. One of: `day`, `week`, `month`, `quarter`, `year`.
- `plans` (`string`, optional): Comma-separated plan UUIDs, external IDs or names (case-sensitive) to filter by. Example: Gold Monthly,Silver Monthly

Example input: `{"end_date":"<end_date>","start_date":"<start_date>"}`

### `chartmogul_metrics_arr_get`

Get ARR · Read-only

Get Annualized Run Rate (ARR) for a date range, optionally by country, plan or CFL filter.
Returns a summary (current, previous and percentage change) and one entry per interval.
Use chartmogul_metrics_arr_get for this metric alone. Use chartmogul_metrics_all_get for every key metric in one call.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): End of the period, ISO 8601 date. Example: 2026-10-31
- `start_date` (`string`, required): Start of the period, ISO 8601 date. Example: 2026-01-01
- `filters` (`string`, optional): Advanced filter in ChartMogul Filter Language (CFL), for example currency~ANY~'USD'. Example: currency~ANY~'USD'
- `geo` (`string`, optional): Comma-separated ISO 3166-1 alpha-2 country codes to filter by. Example: US,GB,DE
- `interval` (`string`, optional): Bucket size: day, week, month, quarter, year (default month). One of: day, week, month, quarter, year. Example: month. One of: `day`, `week`, `month`, `quarter`, `year`.
- `plans` (`string`, optional): Comma-separated plan UUIDs, external IDs or names (case-sensitive) to filter by. Example: Gold Monthly,Silver Monthly

Example input: `{"end_date":"<end_date>","start_date":"<start_date>"}`

### `chartmogul_metrics_asp_get`

Get ASP · Read-only

Get Average Sale Price (ASP) for a date range, optionally by country, plan or CFL filter.
Returns a summary (current, previous and percentage change) and one entry per interval.
Use chartmogul_metrics_asp_get for this metric alone. Use chartmogul_metrics_all_get for every key metric in one call.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): End of the period, ISO 8601 date. Example: 2026-10-31
- `start_date` (`string`, required): Start of the period, ISO 8601 date. Example: 2026-01-01
- `filters` (`string`, optional): Advanced filter in ChartMogul Filter Language (CFL), for example currency~ANY~'USD'. Example: currency~ANY~'USD'
- `geo` (`string`, optional): Comma-separated ISO 3166-1 alpha-2 country codes to filter by. Example: US,GB,DE
- `interval` (`string`, optional): Bucket size: month, quarter, year (default month). One of: month, quarter, year. Example: month. One of: `month`, `quarter`, `year`.
- `plans` (`string`, optional): Comma-separated plan UUIDs, external IDs or names (case-sensitive) to filter by. Example: Gold Monthly,Silver Monthly

Example input: `{"end_date":"<end_date>","start_date":"<start_date>"}`

### `chartmogul_metrics_customer_churn_rate_get`

Get Customer Churn Rate · Read-only

Get the customer churn rate for a date range, optionally by country, plan or CFL filter.
Returns a summary (current, previous and percentage change) and one entry per interval.
Use chartmogul_metrics_customer_churn_rate_get for this metric alone. Use chartmogul_metrics_all_get for every key metric in one call.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): End of the period, ISO 8601 date. Example: 2026-10-31
- `start_date` (`string`, required): Start of the period, ISO 8601 date. Example: 2026-01-01
- `filters` (`string`, optional): Advanced filter in ChartMogul Filter Language (CFL), for example currency~ANY~'USD'. Example: currency~ANY~'USD'
- `geo` (`string`, optional): Comma-separated ISO 3166-1 alpha-2 country codes to filter by. Example: US,GB,DE
- `interval` (`string`, optional): Bucket size: day, week, month, quarter, year (default month). One of: day, week, month, quarter, year. Example: month. One of: `day`, `week`, `month`, `quarter`, `year`.
- `plans` (`string`, optional): Comma-separated plan UUIDs, external IDs or names (case-sensitive) to filter by. Example: Gold Monthly,Silver Monthly

Example input: `{"end_date":"<end_date>","start_date":"<start_date>"}`

### `chartmogul_metrics_customer_count_get`

Get Customer Count · Read-only

Get the number of active customers for a date range, optionally by country, plan or CFL filter.
Returns a summary (current, previous and percentage change) and one entry per interval.
Use chartmogul_metrics_customer_count_get for this metric alone. Use chartmogul_metrics_all_get for every key metric in one call.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): End of the period, ISO 8601 date. Example: 2026-10-31
- `start_date` (`string`, required): Start of the period, ISO 8601 date. Example: 2026-01-01
- `filters` (`string`, optional): Advanced filter in ChartMogul Filter Language (CFL), for example currency~ANY~'USD'. Example: currency~ANY~'USD'
- `geo` (`string`, optional): Comma-separated ISO 3166-1 alpha-2 country codes to filter by. Example: US,GB,DE
- `interval` (`string`, optional): Bucket size: day, week, month, quarter, year (default month). One of: day, week, month, quarter, year. Example: month. One of: `day`, `week`, `month`, `quarter`, `year`.
- `plans` (`string`, optional): Comma-separated plan UUIDs, external IDs or names (case-sensitive) to filter by. Example: Gold Monthly,Silver Monthly

Example input: `{"end_date":"<end_date>","start_date":"<start_date>"}`

### `chartmogul_metrics_ltv_get`

Get LTV · Read-only

Get customer lifetime value (LTV) for a date range, optionally by country, plan or CFL filter.
Returns a summary (current, previous and percentage change) and one entry per month.
Use chartmogul_metrics_ltv_get for this metric alone. Use chartmogul_metrics_all_get for every key metric in one call.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): End of the period, ISO 8601 date. Example: 2026-10-31
- `start_date` (`string`, required): Start of the period, ISO 8601 date. Example: 2026-01-01
- `filters` (`string`, optional): Advanced filter in ChartMogul Filter Language (CFL), for example currency~ANY~'USD'. Example: currency~ANY~'USD'
- `geo` (`string`, optional): Comma-separated ISO 3166-1 alpha-2 country codes to filter by. Example: US,GB,DE
- `plans` (`string`, optional): Comma-separated plan UUIDs, external IDs or names (case-sensitive) to filter by. Example: Gold Monthly,Silver Monthly

Example input: `{"end_date":"<end_date>","start_date":"<start_date>"}`

### `chartmogul_metrics_mrr_churn_rate_get`

Get MRR Churn Rate · Read-only

Get the net MRR churn rate for a date range, optionally by country, plan or CFL filter.
Returns a summary (current, previous and percentage change) and one entry per interval.
Use chartmogul_metrics_mrr_churn_rate_get for this metric alone. Use chartmogul_metrics_all_get for every key metric in one call.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): End of the period, ISO 8601 date. Example: 2026-10-31
- `start_date` (`string`, required): Start of the period, ISO 8601 date. Example: 2026-01-01
- `filters` (`string`, optional): Advanced filter in ChartMogul Filter Language (CFL), for example currency~ANY~'USD'. Example: currency~ANY~'USD'
- `geo` (`string`, optional): Comma-separated ISO 3166-1 alpha-2 country codes to filter by. Example: US,GB,DE
- `interval` (`string`, optional): Bucket size: day, week, month, quarter, year (default month). One of: day, week, month, quarter, year. Example: month. One of: `day`, `week`, `month`, `quarter`, `year`.
- `plans` (`string`, optional): Comma-separated plan UUIDs, external IDs or names (case-sensitive) to filter by. Example: Gold Monthly,Silver Monthly

Example input: `{"end_date":"<end_date>","start_date":"<start_date>"}`

### `chartmogul_metrics_mrr_get`

Get MRR · Read-only

Get Monthly Recurring Revenue (MRR) with its movement breakdown (new business, expansion, contraction, churn, reactivation) for a date range, optionally by country, plan or CFL filter.
Returns a summary (current, previous and percentage change) and one entry per interval.
Use chartmogul_metrics_mrr_get for this metric alone. Use chartmogul_metrics_all_get for every key metric in one call.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `end_date` (`string`, required): End of the period, ISO 8601 date. Example: 2026-10-31
- `start_date` (`string`, required): Start of the period, ISO 8601 date. Example: 2026-01-01
- `filters` (`string`, optional): Advanced filter in ChartMogul Filter Language (CFL), for example currency~ANY~'USD'. Example: currency~ANY~'USD'
- `geo` (`string`, optional): Comma-separated ISO 3166-1 alpha-2 country codes to filter by. Example: US,GB,DE
- `interval` (`string`, optional): Bucket size: day, week, month, quarter, year (default month). One of: day, week, month, quarter, year. Example: month. One of: `day`, `week`, `month`, `quarter`, `year`.
- `plans` (`string`, optional): Comma-separated plan UUIDs, external IDs or names (case-sensitive) to filter by. Example: Gold Monthly,Silver Monthly

Example input: `{"end_date":"<end_date>","start_date":"<start_date>"}`

### `chartmogul_notes_list`

List Notes and Call Logs · Read-only

List notes and call logs for the account or one customer.
Returns a page of notes with type, author, text and dates.
Use chartmogul_notes_list to read a customer's history.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `author_email` (`string`, optional): Only notes by this team member. Example: csm@yourcompany.com
- `cursor` (`string`, optional): Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
- `customer_uuid` (`string`, optional): Only notes on this customer. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `per_page` (`integer`, optional): Results per page, at most 200 (the default). Example: 50
- `type` (`string`, optional): note or call. One of: note, call. Example: call. One of: `note`, `call`.

Example input: `{}`

### `chartmogul_opportunities_list`

List Opportunities · Read-only

List opportunities, filtered by customer, owner, pipeline, stage or close-date range.
Returns a page of opportunities and a cursor for the next page.
Use chartmogul_opportunities_list to review the pipeline.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
- `customer_uuid` (`string`, optional): Only this customer's opportunities. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `estimated_close_date_on_or_after` (`string`, optional): Expected to close on or after this date (ISO 8601). Example: 2026-11-01
- `estimated_close_date_on_or_before` (`string`, optional): Expected to close on or before this date (ISO 8601). Example: 2026-12-31
- `owner` (`string`, optional): Only opportunities owned by this salesperson email. Example: ae@yourcompany.com
- `per_page` (`integer`, optional): Results per page, at most 200 (the default). Example: 50
- `pipeline` (`string`, optional): Only this pipeline. Example: New Business
- `pipeline_stage` (`string`, optional): Only this stage. Example: Negotiation

Example input: `{}`

### `chartmogul_opportunity_get`

Get Opportunity · Read-only

Get one opportunity by UUID.
Returns the opportunity's owner, pipeline, stage, close date, amount and forecast.
Use chartmogul_opportunity_get when you know the UUID. Use chartmogul_opportunities_list to search.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `opportunity_uuid` (`string`, required): ChartMogul opportunity UUID, from chartmogul_opportunities_list. Example: 8b8e8b7e-1a2b-11ef-9a8b-0a1b2c3d4e5f

Example input: `{"opportunity_uuid":"<opportunity_uuid>"}`

### `chartmogul_plan_get`

Get Plan · Read-only

Get one plan by UUID.
Returns the plan's name, interval and external ID.
Use chartmogul_plan_get when you know the UUID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `plan_uuid` (`string`, required): ChartMogul plan UUID (pl_...), from chartmogul_plans_list. Example: pl_eed05d54-75b4-431b-adb2-eb6b9e543206

Example input: `{"plan_uuid":"<plan_uuid>"}`

### `chartmogul_plan_group_plans_list`

List Plans in Plan Group · Read-only

List the plans in a plan group.
Returns a page of plans.
Use chartmogul_plan_group_plans_list to see which plans a group covers.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `plan_group_uuid` (`string`, required): Plan group UUID (plg_...), from chartmogul_plan_groups_list. Example: plg_b53fdbfc-c5eb-4a61-a589-85146cf8d0ab
- `cursor` (`string`, optional): Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
- `per_page` (`integer`, optional): Results per page, at most 200 (the default). Example: 50

Example input: `{"plan_group_uuid":"<plan_group_uuid>"}`

### `chartmogul_plan_groups_list`

List Plan Groups · Read-only

List plan groups.
Returns a page of plan groups with UUID, name and plan count.
Use chartmogul_plan_groups_list to find a group. Use chartmogul_plan_group_plans_list for its plans.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
- `per_page` (`integer`, optional): Results per page, at most 200 (the default). Example: 50

Example input: `{}`

### `chartmogul_plans_list`

List Plans · Read-only

List subscription plans, optionally by source, external ID or billing system.
Returns a page of plans with UUID, name, interval and external ID.
Use chartmogul_plans_list to find plan UUIDs for metric filters and invoice imports.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
- `data_source_uuid` (`string`, optional): Only plans in this source. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
- `external_id` (`string`, optional): Only the plan with this external ID. Example: gold_monthly
- `per_page` (`integer`, optional): Results per page, at most 200 (the default). Example: 50
- `system` (`string`, optional): Only plans from this billing system, for example Stripe or Custom. Example: Custom

Example input: `{}`

### `chartmogul_source_get`

Get Source · Read-only

Get one data source by UUID.
Returns the source's name, system, status and optional settings.
Use chartmogul_source_get when you know the UUID. Use chartmogul_sources_list to find it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `data_source_uuid` (`string`, required): ChartMogul source UUID (ds_...), from chartmogul_sources_list. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
- `with_auto_churn_subscription_setting` (`boolean`, optional): Include the past-due subscription handling setting. Example: false
- `with_invoice_handling_setting` (`boolean`, optional): Include the invoice handling setting. Example: false

Example input: `{"data_source_uuid":"<data_source_uuid>"}`

### `chartmogul_sources_list`

List Sources · Read-only

List the data sources (billing systems and custom import sources) in the account.
Returns each source's UUID, name, system, status and creation date.
Use chartmogul_sources_list to get the data_source_uuid needed to create customers, plans and invoices.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `name` (`string`, optional): Only the source with this name. Example: My source
- `system` (`string`, optional): Only sources of this billing system, for example Stripe, Recurly or Custom. Example: Custom
- `with_auto_churn_subscription_setting` (`boolean`, optional): Include each source's past-due subscription handling setting. Example: false
- `with_invoice_handling_setting` (`boolean`, optional): Include each source's invoice handling setting. Example: false

Example input: `{}`

### `chartmogul_subscription_events_list`

List Subscription Events · Read-only

List subscription events, filtered by source, customer, subscription, plan, type or dates.
Returns a page of subscription events.
Use chartmogul_subscription_events_list to audit subscription changes.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
- `customer_external_id` (`string`, optional): Only events of this customer external ID. Example: cus_0001
- `data_source_uuid` (`string`, optional): Only events in this source. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
- `effective_date` (`string`, optional): Only events effective at exactly this ISO 8601 time. Example: 2026-11-16T00:00:00Z
- `event_date` (`string`, optional): Only events raised at exactly this ISO 8601 time. Example: 2026-11-16T00:00:00Z
- `event_type` (`string`, optional): Only this event type, for example subscription_cancelled. Example: subscription_cancelled
- `external_id` (`string`, optional): Only the event with this external ID. Example: evnt_001
- `include_edit_histories` (`boolean`, optional): Include a summary of user edits (automatic sources). Example: false
- `per_page` (`integer`, optional): Results per page, at most 200 (the default). Example: 50
- `plan_external_id` (`string`, optional): Only events for this plan. Example: gold_monthly
- `subscription_external_id` (`string`, optional): Only events of this subscription. Example: sub_0001
- `with_disabled` (`boolean`, optional): Include disabled events. Example: false

Example input: `{}`

### `chartmogul_task_get`

Get Task · Read-only

Get one task by UUID.
Returns the task's details, assignee, due date and completion date.
Use chartmogul_task_get when you know the UUID. Use chartmogul_tasks_list to search.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `task_uuid` (`string`, required): ChartMogul task UUID, from chartmogul_tasks_list. Example: 00000000-0000-0000-0000-000000000000

Example input: `{"task_uuid":"<task_uuid>"}`

### `chartmogul_tasks_list`

List Tasks · Read-only

List tasks, filtered by customer, assignee, due-date range or completion.
Returns a page of tasks and a cursor for the next page.
Use chartmogul_tasks_list to review open or overdue work.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `assignee` (`string`, optional): Only tasks assigned to this email. Example: csm@yourcompany.com
- `completed` (`boolean`, optional): true for completed tasks, false for open ones. Example: false
- `cursor` (`string`, optional): Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
- `customer_uuid` (`string`, optional): Only this customer's tasks. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `due_date_on_or_after` (`string`, optional): Due on or after this date (ISO 8601). Example: 2026-11-01
- `due_date_on_or_before` (`string`, optional): Due on or before this date (ISO 8601). Example: 2026-11-30
- `per_page` (`integer`, optional): Results per page, at most 200 (the default). Example: 50

Example input: `{}`

### `chartmogul_contact_create`

Create Contact · Write

Create a contact person for a customer.
Returns the contact with its UUID.
Use chartmogul_contact_create to add people to a customer. Use chartmogul_contact_update to change one.
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `customer_uuid` (`string`, required): ChartMogul UUID of the customer the contact belongs to. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `data_source_uuid` (`string`, required): Custom source UUID to store the contact in, from chartmogul_sources_list. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
- `custom` (`array`, optional): Custom attributes, each with key and value; keys must already exist for contacts. Example: [{"key": "role", "value": "Champion"}]
- `email` (`string`, optional): Email address, unique for the customer. Example: jane@example.com
- `external_id` (`string`, optional): Your unique ID for the contact. Example: con_0001
- `first_name` (`string`, optional): First name. Example: Jane
- `last_name` (`string`, optional): Last name. Example: Doe
- `linked_in` (`string`, optional): LinkedIn profile URL. Example: https://linkedin.com/in/janedoe
- `notes` (`string`, optional): Notes about the contact. Example: Prefers email.
- `phone` (`string`, optional): Phone number. Example: +15555550123
- `position` (`integer`, optional): Position in the customer's contact list; 1 is the primary contact. Example: 2
- `title` (`string`, optional): Job title. Example: CFO
- `twitter` (`string`, optional): Twitter profile URL. Example: https://twitter.com/janedoe

Example input: `{"customer_uuid":"<customer_uuid>","data_source_uuid":"<data_source_uuid>"}`

### `chartmogul_contact_update`

Update Contact · Write

Update a contact's details or custom attributes.
Returns the updated contact.
Use chartmogul_contact_update to change a contact. Use chartmogul_contacts_merge to combine duplicates.
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `contact_uuid` (`string`, required): ChartMogul contact UUID (con_...), from chartmogul_contacts_list. Example: con_00000000-0000-0000-0000-000000000000
- `custom` (`array`, optional): Custom attributes to set, each with key and value; keys must already exist. Example: [{"key": "role", "value": "Champion"}]
- `email` (`string`, optional): Email address, unique for the customer. Example: jane@example.com
- `external_id` (`string`, optional): Your unique ID for the contact. Example: con_0001
- `first_name` (`string`, optional): First name. Example: Jane
- `last_name` (`string`, optional): Last name. Example: Doe
- `linked_in` (`string`, optional): LinkedIn profile URL. Example: https://linkedin.com/in/janedoe
- `notes` (`string`, optional): Notes about the contact. Example: Prefers email.
- `phone` (`string`, optional): Phone number. Example: +15555550123
- `position` (`integer`, optional): Position in the customer's contact list; 1 is the primary contact. Example: 2
- `title` (`string`, optional): Job title. Example: CFO
- `twitter` (`string`, optional): Twitter profile URL. Example: https://twitter.com/janedoe

Example input: `{"contact_uuid":"<contact_uuid>"}`

### `chartmogul_customer_create`

Create Customer · Write

Create a customer in a custom data source.
Returns the customer with its UUID, status, MRR and ARR.
Use chartmogul_customer_create to add a lead or customer. Use chartmogul_invoices_import afterwards to give it subscription revenue.
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `data_source_uuid` (`string`, required): ChartMogul source UUID (ds_...), from chartmogul_sources_list. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
- `external_id` (`string`, required): Your unique ID for the customer (alphanumeric). Example: cus_0001
- `city` (`string`, optional): City. Example: San Francisco
- `company` (`string`, optional): The customer's company or organisation. Example: Example Company
- `country` (`string`, optional): Country code, ISO 3166-1 alpha-2. Example: US
- `custom_attributes` (`array`, optional): Custom attributes to add, each with type (String, Integer, Decimal, Timestamp or Boolean), key (letters, digits and underscores) and value. Example: [{"type": "String", "key": "channel", "value": "Partner"}]
- `free_trial_started_at` (`string`, optional): When the customer's free trial started, ISO 8601 time in the past, on or after lead_created_at. Example: 2026-01-20T10:00:00Z
- `lead_created_at` (`string`, optional): When the customer became a lead, ISO 8601 time in the past. Example: 2026-01-15T10:00:00Z
- `owner` (`string`, optional): Email of the team member who owns the customer; must be an existing team member. Example: sales@yourcompany.com
- `primary_contact` (`object`, optional): Primary contact with any of first_name, last_name, email, title, phone, linked_in, twitter and notes. Example: {"first_name": "Jane", "last_name": "Doe", "email": "jane@example.com", "title": "CEO"}
- `state` (`string`, optional): US state code, ISO 3166-2, for example US-CA. Example: US-CA
- `status` (`string`, optional): Lead status to set: New Lead, Working Lead, Qualified Lead or Unqualified Lead (subscription statuses are set automatically). One of: New Lead, Working Lead, Qualified Lead, Unqualified Lead. Example: Qualified Lead. One of: `New Lead`, `Working Lead`, `Qualified Lead`, `Unqualified Lead`.
- `tags` (`array`, optional): Tags to add to the customer. Example: ["enterprise", "beta"]
- `website_url` (`string`, optional): The customer's website URL. Example: https://example.com
- `zip` (`string`, optional): Zip or postal code. Example: 94107

Example input: `{"data_source_uuid":"<data_source_uuid>","external_id":"<external_id>"}`

### `chartmogul_customer_custom_attributes_add`

Add Customer Custom Attributes · Write

Add custom attributes to a customer, creating new attribute definitions when needed.
Returns the customer's custom attributes.
Use chartmogul_customer_custom_attributes_add to add attributes. Use chartmogul_customer_custom_attributes_update to change values of existing ones.
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `custom` (`array`, required): Attributes to add, each with type (String, Integer, Decimal, Timestamp or Boolean), key and value. Example: [{"type": "Integer", "key": "seats", "value": 25}]
- `customer_uuid` (`string`, required): ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `overrides` (`object`, optional): Override flags by namespace, for example {"custom": {"channel": true}}; an overridden value is not changed by later syncs. Example: {"custom": {"seats": true}}

Example input: `{"custom":[{"type":"Integer","key":"seats","value":25}],"customer_uuid":"<customer_uuid>"}`

### `chartmogul_customer_custom_attributes_update`

Update Customer Custom Attributes · Write

Change the values of a customer's existing custom attributes; attributes not sent are kept.
Returns the customer's custom attributes.
Use chartmogul_customer_custom_attributes_update to change values. Use chartmogul_customer_custom_attributes_add for new attributes.
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `custom` (`object`, required): Attribute values to set, as key-value pairs; a value can also be {"value": ..., "source": ...}. Example: {"seats": 30, "channel": "Direct"}
- `customer_uuid` (`string`, required): ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `overrides` (`object`, optional): Override flags by namespace; true protects the value from later syncs, false removes an override. Example: {"custom": {"channel": true}}

Example input: `{"custom":{"seats":30,"channel":"Direct"},"customer_uuid":"<customer_uuid>"}`

### `chartmogul_customer_tags_add`

Add Customer Tags · Write

Add tags to a customer, keeping existing tags.
Returns the customer's full tag list.
Use chartmogul_customer_tags_add to label a customer. Use chartmogul_customer_update to replace all tags.
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_uuid` (`string`, required): ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `tags` (`array`, required): Tags to add. Example: ["churn-risk"]

Example input: `{"customer_uuid":"<customer_uuid>","tags":["churn-risk"]}`

### `chartmogul_customer_update`

Update Customer · Write

Update a customer's details, lead status, owner, primary contact, tags or custom attributes.
Returns the updated customer. Tags and custom attributes sent here replace all existing ones; use chartmogul_customer_custom_attributes_add or chartmogul_customer_tags_add to add without replacing.
Use chartmogul_customer_update to change customer fields.
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_uuid` (`string`, required): ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `city` (`string`, optional): City. Example: San Francisco
- `company` (`string`, optional): The customer's company or organisation. Example: Example Company
- `country` (`string`, optional): Country code, ISO 3166-1 alpha-2. Example: US
- `custom_attributes` (`object`, optional): Replaces all custom attributes, as key-value pairs; keys must already exist in ChartMogul. Example: {"channel": "Partner", "seats": 25}
- `free_trial_started_at` (`string`, optional): When the customer's free trial started, ISO 8601 time in the past, on or after lead_created_at. Example: 2026-01-20T10:00:00Z
- `lead_created_at` (`string`, optional): When the customer became a lead, ISO 8601 time in the past. Example: 2026-01-15T10:00:00Z
- `owner` (`string`, optional): Email of the team member who owns the customer; must be an existing team member. Example: sales@yourcompany.com
- `primary_contact` (`object`, optional): Primary contact with any of first_name, last_name, email, title, phone, linked_in, twitter and notes. Example: {"first_name": "Jane", "last_name": "Doe", "email": "jane@example.com", "title": "CEO"}
- `state` (`string`, optional): US state code, ISO 3166-2, for example US-CA. Example: US-CA
- `status` (`string`, optional): Lead status to set: New Lead, Working Lead, Qualified Lead or Unqualified Lead (subscription statuses are set automatically). One of: New Lead, Working Lead, Qualified Lead, Unqualified Lead. Example: Qualified Lead. One of: `New Lead`, `Working Lead`, `Qualified Lead`, `Unqualified Lead`.
- `tags` (`array`, optional): Replaces all of the customer's tags. Example: ["enterprise"]
- `website_url` (`string`, optional): The customer's website URL. Example: https://example.com
- `zip` (`string`, optional): Zip or postal code. Example: 94107

Example input: `{"customer_uuid":"<customer_uuid>"}`

### `chartmogul_customers_merge`

Merge Customers · Write

Merge one customer into another; the from customer's data moves into the into customer.
Returns an empty object on success.
Use chartmogul_customers_merge to combine duplicate customers from different sources.
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from` (`object`, required): The customer to merge from, as {"customer_uuid": ...} or {"data_source_uuid": ..., "external_id": ...}. Example: {"customer_uuid": "cus_5915ee5a-babd-406b-b8ce-d207133fb4cb"}
- `into` (`object`, required): The customer to merge into (kept), in the same form as from. Example: {"customer_uuid": "cus_2123290f-09c8-4628-a205-db5596bd58f7"}

Example input: `{"from":{"customer_uuid":"cus_5915ee5a-babd-406b-b8ce-d207133fb4cb"},"into":{"customer_uuid":"cus_2123290f-09c8-4628-a205-db5596bd58f7"}}`

### `chartmogul_invoices_import`

Import Invoices · Write

Import one or more invoices for a customer; ChartMogul builds subscriptions and MRR from their line items.
Returns the created invoices with UUIDs.
Use chartmogul_invoices_import to load billing history from a custom source. Create the customer and plans first (chartmogul_customer_create, chartmogul_plan_create).
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `customer_uuid` (`string`, required): ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `invoices` (`array`, required): Invoices to import. Each needs external_id, date (ISO 8601), currency, customer_external_id and line_items; optional due_date, data_source_uuid, collection_method and transactions. Each line item has a type (subscription or one_time), amount_in_cents and, for subscriptions, subscription_external_id, plan_uuid, service_period_start and service_period_end; optional quantity, discount_amount_in_cents and tax_amount_in_cents. Each transaction has type (payment or refund), date and result (successful or failed). Example: [{"external_id": "inv_0001", "date": "2026-11-01 00:00:00", "currency": "USD", "customer_external_id": "cus_0001", "line_items": [{"type": "subscription", "subscription_external_id": "sub_0001", "plan_uuid": "pl_eed05d54-75b4-431b-adb2-eb6b9e543206", "service_period_start": "2026-11-01 00:00:00", "service_period_end": "2026-12-01 00:00:00", "amount_in_cents": 5000, "quantity": 1}], "transactions": [{"type": "payment", "date": "2026-11-01 00:05:00", "result": "successful"}]}]
- `handle_as_user_edit` (`boolean`, optional): For automatic sources, true stores the invoices as user edits that survive resyncs. Example: false

Example input: `{"customer_uuid":"<customer_uuid>","invoices":[]}`

### `chartmogul_note_create`

Create Note or Call Log · Write

Create a note or call log on a customer.
Returns the note with its UUID.
Use chartmogul_note_create to record a conversation. Use chartmogul_note_update to edit it.
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `customer_uuid` (`string`, required): ChartMogul UUID of the customer. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `type` (`string`, required): note or call. One of: note, call. Example: note. One of: `note`, `call`.
- `author_email` (`string`, optional): Email of the team member who wrote it. Example: csm@yourcompany.com
- `call_duration` (`integer`, optional): For calls, duration in seconds (default 60). Example: 900
- `created_at` (`string`, optional): When the note or call happened, ISO 8601 time in the past. Defaults to now. Example: 2026-11-15T14:00:00Z
- `text` (`string`, optional): Contents, as plain text or HTML. Example: Discussed renewal; customer wants annual billing.

Example input: `{"customer_uuid":"<customer_uuid>","type":"note"}`

### `chartmogul_note_update`

Update Note or Call Log · Write

Update a note or call log.
Returns the updated note.
Use chartmogul_note_update to correct a note.
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `note_uuid` (`string`, required): ChartMogul note UUID, from chartmogul_notes_list. Example: note_00000000-0000-0000-0000-000000000000
- `author_email` (`string`, optional): Email of the author. Example: csm@yourcompany.com
- `call_duration` (`integer`, optional): For calls, duration in seconds. Example: 600
- `created_at` (`string`, optional): When it happened, ISO 8601. Example: 2026-11-15T14:00:00Z
- `text` (`string`, optional): New contents. Example: Customer confirmed annual billing.

Example input: `{"note_uuid":"<note_uuid>"}`

### `chartmogul_opportunity_create`

Create Opportunity · Write

Create a sales opportunity for a customer.
Returns the opportunity with its UUID.
Use chartmogul_opportunity_create to track a deal. Use chartmogul_opportunity_update to move it through stages.
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `amount_in_cents` (`integer`, required): Expected value in cents. Example: 500000
- `currency` (`string`, required): Three-letter currency code. Example: USD
- `customer_uuid` (`string`, required): ChartMogul UUID of the customer. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `estimated_close_date` (`string`, required): Expected close date, ISO 8601. Example: 2026-12-31
- `owner` (`string`, required): Email of the salesperson responsible. Example: ae@yourcompany.com
- `pipeline` (`string`, required): Pipeline name, for example New Business or Renewals; must exist. Example: New Business
- `pipeline_stage` (`string`, required): Stage name in the pipeline, for example Discovery, Evaluation, Negotiation, Verbal Commit, Closed Won or Closed Lost. Example: Discovery
- `custom` (`array`, optional): Custom attributes, each with key and value; keys must already exist for opportunities. On update this replaces all custom attributes. Example: [{"key": "source", "value": "Webinar"}]
- `forecast_category` (`string`, optional): pipeline, best_case, committed, lost or won; defaults from the stage. One of: pipeline, best_case, committed, lost, won. Example: best_case. One of: `pipeline`, `best_case`, `committed`, `lost`, `won`.
- `type` (`string`, optional): recurring (value is MRR), arr (value is ARR) or one-time. One of: recurring, arr, one-time. Example: recurring. One of: `recurring`, `arr`, `one-time`.
- `win_likelihood` (`integer`, optional): Chance of closing, 0 to 100; defaults from the stage. Example: 60

Example input: `{"amount_in_cents":500000,"currency":"<currency>","customer_uuid":"<customer_uuid>","estimated_close_date":"<estimated_close_date>","owner":"<owner>","pipeline":"<pipeline>","pipeline_stage":"<pipeline_stage>"}`

### `chartmogul_opportunity_update`

Update Opportunity · Write

Update an opportunity's owner, pipeline, stage, close date, amount, forecast or custom attributes.
Returns the updated opportunity. Sending custom replaces all custom attributes.
Use chartmogul_opportunity_update to move a deal forward or close it.
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `opportunity_uuid` (`string`, required): ChartMogul opportunity UUID, from chartmogul_opportunities_list. Example: 8b8e8b7e-1a2b-11ef-9a8b-0a1b2c3d4e5f
- `amount_in_cents` (`integer`, optional): Expected value in cents. Example: 550000
- `currency` (`string`, optional): Three-letter currency code. Example: USD
- `custom` (`array`, optional): Custom attributes, each with key and value; keys must already exist for opportunities. On update this replaces all custom attributes. Example: [{"key": "source", "value": "Webinar"}]
- `estimated_close_date` (`string`, optional): Expected close date, ISO 8601. Example: 2026-12-15
- `forecast_category` (`string`, optional): pipeline, best_case, committed, lost or won; defaults from the stage. One of: pipeline, best_case, committed, lost, won. Example: best_case. One of: `pipeline`, `best_case`, `committed`, `lost`, `won`.
- `owner` (`string`, optional): Email of the salesperson responsible. Example: ae@yourcompany.com
- `pipeline` (`string`, optional): Pipeline name. Example: New Business
- `pipeline_stage` (`string`, optional): Stage name. Example: Closed Won
- `type` (`string`, optional): recurring (value is MRR), arr (value is ARR) or one-time. One of: recurring, arr, one-time. Example: recurring. One of: `recurring`, `arr`, `one-time`.
- `win_likelihood` (`integer`, optional): Chance of closing, 0 to 100; defaults from the stage. Example: 60

Example input: `{"opportunity_uuid":"<opportunity_uuid>"}`

### `chartmogul_plan_create`

Create Plan · Write

Create a subscription plan in a custom data source.
Returns the plan with its UUID.
Use chartmogul_plan_create before importing invoices whose line items reference the plan.
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `data_source_uuid` (`string`, required): ChartMogul source UUID (ds_...), from chartmogul_sources_list. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
- `interval_count` (`integer`, required): Number of interval units per billing period, greater than 0 (6 with month means half-yearly). Example: 1
- `interval_unit` (`string`, required): day, month or year. One of: day, month, year. Example: month. One of: `day`, `month`, `year`.
- `name` (`string`, required): Plan display name. Example: Gold Monthly
- `external_id` (`string`, optional): Your unique ID for the plan; generated when left empty. Example: gold_monthly

Example input: `{"data_source_uuid":"<data_source_uuid>","interval_count":1,"interval_unit":"day","name":"<name>"}`

### `chartmogul_plan_update`

Update Plan · Write

Update a plan's name, or its interval when no subscription or invoice uses it yet.
Returns the updated plan.
Use chartmogul_plan_update to rename a plan.
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `plan_uuid` (`string`, required): ChartMogul plan UUID (pl_...), from chartmogul_plans_list. Example: pl_eed05d54-75b4-431b-adb2-eb6b9e543206
- `interval_count` (`integer`, optional): Number of interval units per billing period. Example: 1
- `interval_unit` (`string`, optional): day, month or year. One of: day, month, year. Example: month. One of: `day`, `month`, `year`.
- `name` (`string`, optional): Plan display name. Example: Gold Monthly (2026)

Example input: `{"plan_uuid":"<plan_uuid>"}`

### `chartmogul_source_create`

Create Source · Write

Create a custom data source to import billing data into through the API.
Returns the new source with its UUID.
Use chartmogul_source_create before importing customers, plans and invoices from a system ChartMogul has no integration for.
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Name of the source. Example: In-house billing

Example input: `{"name":"<name>"}`

### `chartmogul_subscription_event_create`

Create Subscription Event · Write

Record a subscription event (start, update, cancellation, pause, resume, or a scheduled or retracted one) for a customer in a source.
Returns the subscription event with its ID.
Use chartmogul_subscription_event_create to feed subscription changes without invoices. Use chartmogul_invoices_import for invoice-based data.
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `customer_external_id` (`string`, required): Your external ID of the customer. Example: cus_0001
- `data_source_uuid` (`string`, required): ChartMogul source UUID (ds_...), from chartmogul_sources_list. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
- `effective_date` (`string`, required): When the event takes effect, ISO 8601. Example: 2026-11-16
- `event_date` (`string`, required): When the event was raised, ISO 8601; for scheduled types it must be on or before effective_date. Example: 2026-11-16
- `event_type` (`string`, required): Event type. One of: subscription_start, subscription_start_scheduled, scheduled_subscription_start_retracted, subscription_cancelled, subscription_cancellation_scheduled, scheduled_subscription_cancellation_retracted, subscription_updated, subscription_update_scheduled, scheduled_subscription_update_retracted, subscription_event_retracted, subscription_paused, subscription_resumed. Example: subscription_start. One of: `subscription_start`, `subscription_start_scheduled`, `scheduled_subscription_start_retracted`, `subscription_cancelled`, `subscription_cancellation_scheduled`, `scheduled_subscription_cancellation_retracted`, `subscription_updated`, `subscription_update_scheduled`, `scheduled_subscription_update_retracted`, `subscription_event_retracted`, `subscription_paused`, `subscription_resumed`.
- `subscription_external_id` (`string`, required): Your external ID of the subscription. Example: sub_0001
- `amount_in_cents` (`integer`, optional): Final amount per billing period after discounts and taxes, in cents; required for start and update types. Example: 1000
- `currency` (`string`, optional): Three-letter currency code; required for start and update types. Example: USD
- `event_order` (`integer`, optional): Processing order for simultaneous events (ascending). Example: 100
- `external_id` (`string`, optional): Your unique ID for the event. Example: evnt_001
- `handle_as_user_edit` (`boolean`, optional): For automatic sources (Stripe, Chargebee and others), true stores the event as a user edit that survives resyncs; needs external_id. Example: false
- `plan_external_id` (`string`, optional): Plan external ID; required for start and update types. Example: gold_monthly
- `quantity` (`integer`, optional): Quantity (non-zero, default 1). Example: 1
- `retracted_event_id` (`string`, optional): For subscription_event_retracted, the ID of the scheduled event to retract. Example: 73966836
- `subscription_set_external_id` (`string`, optional): ID grouping several subscriptions into one set. Example: set_0001
- `tax_amount_in_cents` (`integer`, optional): Tax included in the amount, in cents (default 0). Example: 0

Example input: `{"customer_external_id":"<customer_external_id>","data_source_uuid":"<data_source_uuid>","effective_date":"<effective_date>","event_date":"<event_date>","event_type":"subscription_start","subscription_external_id":"<subscription_external_id>"}`

### `chartmogul_task_create`

Create Task · Write

Create a task on a customer for a team member.
Returns the task with its UUID.
Use chartmogul_task_create to schedule follow-up work. Use chartmogul_task_update to complete it.
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `assignee` (`string`, required): Email of the team member assigned. Example: csm@yourcompany.com
- `customer_uuid` (`string`, required): ChartMogul UUID of the customer. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
- `due_date` (`string`, required): Due date, ISO 8601. Example: 2026-11-30
- `task_details` (`string`, required): What to do, up to 255 characters. Example: Send renewal proposal
- `completed_at` (`string`, optional): Completion date, ISO 8601 in the past, if already done. Example: 2026-11-16

Example input: `{"assignee":"<assignee>","customer_uuid":"<customer_uuid>","due_date":"<due_date>","task_details":"<task_details>"}`

### `chartmogul_task_update`

Update Task · Write

Update a task's details, assignee, due date or completion date.
Returns the updated task.
Use chartmogul_task_update to reassign or complete a task (set completed_at).
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `task_uuid` (`string`, required): ChartMogul task UUID, from chartmogul_tasks_list. Example: 00000000-0000-0000-0000-000000000000
- `assignee` (`string`, optional): Email of the team member assigned. Example: csm@yourcompany.com
- `completed_at` (`string`, optional): Completion date, ISO 8601 in the past. Example: 2026-11-16
- `due_date` (`string`, optional): Due date, ISO 8601. Example: 2026-12-05
- `task_details` (`string`, optional): What to do, up to 255 characters. Example: Send revised renewal proposal

Example input: `{"task_uuid":"<task_uuid>"}`

### `chartmogul_transaction_create`

Create Transaction · Write

Record a payment or refund against an imported invoice.
Returns the transaction with its UUID.
Use chartmogul_transaction_create when an invoice is paid or refunded after import.
Needs an API key with read and write access.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `date` (`string`, required): When the transaction was attempted, ISO 8601. Example: 2026-11-16 10:00:00
- `invoice_uuid` (`string`, required): ChartMogul invoice UUID (inv_...). Example: inv_565c73b2-85b9-49c9-a25e-2b7df6a677c9
- `result` (`string`, required): successful or failed. One of: successful, failed. Example: successful. One of: `successful`, `failed`.
- `type` (`string`, required): payment or refund. One of: payment, refund. Example: payment. One of: `payment`, `refund`.
- `amount_in_cents` (`integer`, optional): Partial amount in cents; defaults to the full invoice amount. Example: 5000
- `external_id` (`string`, optional): Your unique ID for the transaction. Example: trans_00241
- `handle_as_user_edit` (`boolean`, optional): For automatic sources, true stores it as a user edit; needs external_id. Example: false
- `transaction_fees_currency` (`string`, optional): Currency of the fees. Example: USD
- `transaction_fees_in_cents` (`integer`, optional): Transaction fees in cents (default 0). Example: 150

Example input: `{"date":"<date>","invoice_uuid":"<invoice_uuid>","result":"successful","type":"payment"}`

### `chartmogul_contact_delete`

Delete Contact · Destructive

Delete a contact.
Returns an empty response on success.
Use chartmogul_contact_delete to remove a contact permanently.
Needs an API key with read and write access.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `contact_uuid` (`string`, required): ChartMogul contact UUID (con_...), from chartmogul_contacts_list. Example: con_00000000-0000-0000-0000-000000000000

Example input: `{"contact_uuid":"<contact_uuid>"}`

### `chartmogul_contacts_merge`

Merge Contacts · Destructive

Merge one contact into another; details missing on the kept contact are copied over and the other contact is removed. This cannot be undone.
Returns the merged contact.
Use chartmogul_contacts_merge to combine duplicate contacts.
Needs an API key with read and write access.

Read only: no. Destructive: yes. Idempotent (safe to retry): no.

Inputs:

- `from_contact_uuid` (`string`, required): UUID of the contact to merge from and remove. Example: con_36c9f236-ea66-11ed-b81d-cf0d715ced77
- `into_contact_uuid` (`string`, required): UUID of the contact to keep. Example: con_653af916-dea0-11ed-845b-3be1ac0039ac

Example input: `{"from_contact_uuid":"<from_contact_uuid>","into_contact_uuid":"<into_contact_uuid>"}`

### `chartmogul_customer_delete`

Delete Customer · Destructive

Delete a customer imported through the API, with all its invoices, subscriptions, transactions and attributes. This cannot be undone.
Returns an empty response on success.
Use chartmogul_customer_delete only for API-imported customers; customers from integrations are deleted in the ChartMogul app.
Needs an API key with read and write access.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `customer_uuid` (`string`, required): ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012

Example input: `{"customer_uuid":"<customer_uuid>"}`

### `chartmogul_note_delete`

Delete Note or Call Log · Destructive

Delete a note or call log.
Returns an empty response on success.
Use chartmogul_note_delete to remove a note permanently.
Needs an API key with read and write access.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `note_uuid` (`string`, required): ChartMogul note UUID, from chartmogul_notes_list. Example: note_00000000-0000-0000-0000-000000000000

Example input: `{"note_uuid":"<note_uuid>"}`

### `chartmogul_opportunity_delete`

Delete Opportunity · Destructive

Delete an opportunity.
Returns an empty response on success.
Use chartmogul_opportunity_delete to remove a deal permanently.
Needs an API key with read and write access.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `opportunity_uuid` (`string`, required): ChartMogul opportunity UUID, from chartmogul_opportunities_list. Example: 8b8e8b7e-1a2b-11ef-9a8b-0a1b2c3d4e5f

Example input: `{"opportunity_uuid":"<opportunity_uuid>"}`

### `chartmogul_task_delete`

Delete Task · Destructive

Delete a task.
Returns an empty response on success.
Use chartmogul_task_delete to remove a task permanently.
Needs an API key with read and write access.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `task_uuid` (`string`, required): ChartMogul task UUID, from chartmogul_tasks_list. Example: 00000000-0000-0000-0000-000000000000

Example input: `{"task_uuid":"<task_uuid>"}`

## Related

Other Analytics connectors ([all 177](/agentkit/connectors/?category=analytics)):

- [Google Sheets](/agentkit/connectors/googlesheets/): Scalekit connector, OAuth, 48 tools
- [HubSpot](/agentkit/connectors/hubspot/): Scalekit connector, OAuth, 457 tools
- [AWS Redshift](/agentkit/connectors/redshift/): Scalekit connector, Trusted identity provider, 10 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
