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.
- Tools
- 60
- What they doRead · write · destructive
- 34 · 20 · 634 read20 write6 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the ChartMogul connection
In AgentKit > Connections, create a ChartMogul connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolchartmogul_account_getGet details of the ChartMogul account the API key belongs to.Read-onlyGet Account
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.
Inputs
includestring- 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
chartmogul_activities_listList MRR activities across all customers (new business, reactivation, expansion, contraction, churn) for a period.Read-onlyList Activities
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.
Inputs
cursorstring- Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
end_datestring- Only activities on or before this ISO 8601 time. Example: 2026-10-31
orderstring- date (oldest first, default) or -date (newest first). One of: date, -date. Example: -dateone of
date-date per_pageinteger- Results per page, at most 200 (the default). Example: 50
start_datestring- Only activities on or after this ISO 8601 time. Example: 2026-10-01
typestring- Only this activity type. One of: new_biz, reactivation, expansion, contraction, churn. Example: churnone of
new_bizreactivationexpansioncontractionchurn
chartmogul_contact_getGet one contact by UUID.Read-onlyGet Contact
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.
Inputs
contact_uuidstringrequired- ChartMogul contact UUID (con_...), from chartmogul_contacts_list. Example: con_00000000-0000-0000-0000-000000000000
attributes_with_historystring- Comma-separated contact fields to include edit history for, such as email or title. Example: email,title
with_overridesboolean- Include the contact's overridden fields. Example: false
chartmogul_contacts_listList contacts, optionally for one customer, source or email.Read-onlyList Contacts
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.
Inputs
cursorstring- Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
customer_external_idstring- Only contacts of the customer with this external ID. Example: cus_0001
customer_uuidstring- Only contacts of this customer. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
data_source_uuidstring- Only contacts in this source. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
emailstring- Only contacts with this email. Example: jane@example.com
per_pageinteger- Results per page, at most 200 (the default). Example: 50
chartmogul_customer_activities_listList a customer's MRR activities (new business, expansion, contraction, churn, reactivation).Read-onlyList Customer Activities
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.
Inputs
customer_uuidstringrequired- ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
cursorstring- Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
per_pageinteger- Results per page, at most 200 (the default). Example: 50
chartmogul_customer_attributes_getGet a customer's tags, custom attributes and billing-system metadata.Read-onlyGet Customer Attributes
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.
Inputs
customer_uuidstringrequired- ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
attributes_with_historystring- Comma-separated custom attribute names (for example custom.channel) to include edit history for. Example: custom.channel
with_overridesboolean- Include overrides on custom attributes. Example: false
chartmogul_customer_getGet one customer by UUID.Read-onlyGet Customer
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.
Inputs
customer_uuidstringrequired- ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
attributes_with_historystring- Comma-separated attribute names to include edit history for, such as company, owner, status, address or custom.channel. Example: company,owner
with_overridesboolean- Include an overrides object flagging the customer's overridden fields. Example: false
chartmogul_customer_invoices_listList the invoices imported through the API for one customer.Read-onlyList Customer Invoices
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.
Inputs
customer_uuidstringrequired- ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
cursorstring- Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
per_pageinteger- Results per page, at most 200 (the default). Example: 50
validation_typestring- valid (default), invalid or all. One of: valid, invalid, all. Example: validone of
validinvalidall
chartmogul_customer_subscriptions_listList a customer's subscriptions.Read-onlyList Customer Subscriptions
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.
Inputs
customer_uuidstringrequired- ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
cursorstring- Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
per_pageinteger- Results per page, at most 200 (the default). Example: 50
chartmogul_customers_listList customers, optionally filtered by data source, external ID, email, status or billing system.Read-onlyList Customers
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.
Inputs
cursorstring- Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
data_source_uuidstring- Only customers from this source. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
emailstring- Only customers with this email. Example: jane@example.com
external_idstring- Only the customer with this external ID. Example: cus_0001
per_pageinteger- Results per page, at most 200 (the default). Example: 50
statusstring- 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: Activeone of
New_LeadWorking_LeadQualified_LeadUnqualified_LeadActivePast_DueCancelled systemstring- Only customers from this billing system (case-sensitive), for example Stripe or Custom. Example: Stripe
with_associated_emailsboolean- With email, also match customers whose contacts have the email. Example: false
chartmogul_customers_search_by_emailFind customers by email address.Read-onlySearch Customers by Email
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.
Inputs
cursorstring- Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
emailstring- Email address to search for. Example: jane@example.com
per_pageinteger- Results per page, at most 200 (the default). Example: 50
with_associated_emailsboolean- Also match customers whose contacts have the email. Example: true
chartmogul_invoice_getGet one invoice by UUID.Read-onlyGet Invoice
Get one invoice by UUID. Returns the invoice with its line items and transactions. Use chartmogul_invoice_get when you know the UUID.
Inputs
invoice_uuidstringrequired- ChartMogul invoice UUID (inv_...), from chartmogul_invoices_list. Example: inv_565c73b2-85b9-49c9-a25e-2b7df6a677c9
include_edit_historiesboolean- Include a summary of user edits. Example: false
validation_typestring- valid (default), invalid or all. One of: valid, invalid, all. Example: allone of
validinvalidall with_disabledboolean- Return the invoice even if disabled. Example: false
chartmogul_invoices_listList invoices imported through the API, optionally by source, customer or external ID.Read-onlyList Invoices
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.
Inputs
cursorstring- Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
customer_uuidstring- Only this customer's invoices. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
data_source_uuidstring- Only invoices in this source. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
external_idstring- Only the invoice with this external ID. Example: inv_0001
include_edit_historiesboolean- Include a summary of user edits (automatic sources). Example: false
per_pageinteger- Results per page, at most 200 (the default). Example: 50
validation_typestring- valid (default), invalid or all. One of: valid, invalid, all. Example: validone of
validinvalidall with_disabledboolean- Include disabled invoices. Example: false
chartmogul_metrics_all_getGet every key SaaS metric (MRR, ARR, ARPA, ASP, customers, churn rates, LTV) for a date range, optionally by country, plan or CFL filter.Read-onlyGet All Key Metrics
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.
Inputs
end_datestringrequired- End of the period, ISO 8601 date. Example: 2026-10-31
start_datestringrequired- Start of the period, ISO 8601 date. Example: 2026-01-01
filtersstring- Advanced filter in ChartMogul Filter Language (CFL). Example: currency~ANY~'USD'
geostring- Comma-separated ISO 3166-1 alpha-2 country codes to filter by. Example: US,GB
intervalstring- Bucket size: day, week, month (default), quarter or year. One of: day, week, month, quarter, year. Example: monthone of
dayweekmonthquarteryear plansstring- Comma-separated plan UUIDs, external IDs or names (case-sensitive) to filter by. Example: Gold Monthly
chartmogul_metrics_arpa_getGet Average Revenue Per Account (ARPA) for a date range, optionally by country, plan or CFL filter.Read-onlyGet ARPA
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.
Inputs
end_datestringrequired- End of the period, ISO 8601 date. Example: 2026-10-31
start_datestringrequired- Start of the period, ISO 8601 date. Example: 2026-01-01
filtersstring- Advanced filter in ChartMogul Filter Language (CFL), for example currency~ANY~'USD'. Example: currency~ANY~'USD'
geostring- Comma-separated ISO 3166-1 alpha-2 country codes to filter by. Example: US,GB,DE
intervalstring- Bucket size: day, week, month, quarter, year (default month). One of: day, week, month, quarter, year. Example: monthone of
dayweekmonthquarteryear plansstring- Comma-separated plan UUIDs, external IDs or names (case-sensitive) to filter by. Example: Gold Monthly,Silver Monthly
chartmogul_metrics_arr_getGet Annualized Run Rate (ARR) for a date range, optionally by country, plan or CFL filter.Read-onlyGet ARR
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.
Inputs
end_datestringrequired- End of the period, ISO 8601 date. Example: 2026-10-31
start_datestringrequired- Start of the period, ISO 8601 date. Example: 2026-01-01
filtersstring- Advanced filter in ChartMogul Filter Language (CFL), for example currency~ANY~'USD'. Example: currency~ANY~'USD'
geostring- Comma-separated ISO 3166-1 alpha-2 country codes to filter by. Example: US,GB,DE
intervalstring- Bucket size: day, week, month, quarter, year (default month). One of: day, week, month, quarter, year. Example: monthone of
dayweekmonthquarteryear plansstring- Comma-separated plan UUIDs, external IDs or names (case-sensitive) to filter by. Example: Gold Monthly,Silver Monthly
chartmogul_metrics_asp_getGet Average Sale Price (ASP) for a date range, optionally by country, plan or CFL filter.Read-onlyGet ASP
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.
Inputs
end_datestringrequired- End of the period, ISO 8601 date. Example: 2026-10-31
start_datestringrequired- Start of the period, ISO 8601 date. Example: 2026-01-01
filtersstring- Advanced filter in ChartMogul Filter Language (CFL), for example currency~ANY~'USD'. Example: currency~ANY~'USD'
geostring- Comma-separated ISO 3166-1 alpha-2 country codes to filter by. Example: US,GB,DE
intervalstring- Bucket size: month, quarter, year (default month). One of: month, quarter, year. Example: monthone of
monthquarteryear plansstring- Comma-separated plan UUIDs, external IDs or names (case-sensitive) to filter by. Example: Gold Monthly,Silver Monthly
chartmogul_metrics_customer_churn_rate_getGet the customer churn rate for a date range, optionally by country, plan or CFL filter.Read-onlyGet Customer Churn Rate
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.
Inputs
end_datestringrequired- End of the period, ISO 8601 date. Example: 2026-10-31
start_datestringrequired- Start of the period, ISO 8601 date. Example: 2026-01-01
filtersstring- Advanced filter in ChartMogul Filter Language (CFL), for example currency~ANY~'USD'. Example: currency~ANY~'USD'
geostring- Comma-separated ISO 3166-1 alpha-2 country codes to filter by. Example: US,GB,DE
intervalstring- Bucket size: day, week, month, quarter, year (default month). One of: day, week, month, quarter, year. Example: monthone of
dayweekmonthquarteryear plansstring- Comma-separated plan UUIDs, external IDs or names (case-sensitive) to filter by. Example: Gold Monthly,Silver Monthly
chartmogul_metrics_customer_count_getGet the number of active customers for a date range, optionally by country, plan or CFL filter.Read-onlyGet Customer Count
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.
Inputs
end_datestringrequired- End of the period, ISO 8601 date. Example: 2026-10-31
start_datestringrequired- Start of the period, ISO 8601 date. Example: 2026-01-01
filtersstring- Advanced filter in ChartMogul Filter Language (CFL), for example currency~ANY~'USD'. Example: currency~ANY~'USD'
geostring- Comma-separated ISO 3166-1 alpha-2 country codes to filter by. Example: US,GB,DE
intervalstring- Bucket size: day, week, month, quarter, year (default month). One of: day, week, month, quarter, year. Example: monthone of
dayweekmonthquarteryear plansstring- Comma-separated plan UUIDs, external IDs or names (case-sensitive) to filter by. Example: Gold Monthly,Silver Monthly
chartmogul_metrics_ltv_getGet customer lifetime value (LTV) for a date range, optionally by country, plan or CFL filter.Read-onlyGet LTV
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.
Inputs
end_datestringrequired- End of the period, ISO 8601 date. Example: 2026-10-31
start_datestringrequired- Start of the period, ISO 8601 date. Example: 2026-01-01
filtersstring- Advanced filter in ChartMogul Filter Language (CFL), for example currency~ANY~'USD'. Example: currency~ANY~'USD'
geostring- Comma-separated ISO 3166-1 alpha-2 country codes to filter by. Example: US,GB,DE
plansstring- Comma-separated plan UUIDs, external IDs or names (case-sensitive) to filter by. Example: Gold Monthly,Silver Monthly
chartmogul_metrics_mrr_churn_rate_getGet the net MRR churn rate for a date range, optionally by country, plan or CFL filter.Read-onlyGet MRR Churn Rate
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.
Inputs
end_datestringrequired- End of the period, ISO 8601 date. Example: 2026-10-31
start_datestringrequired- Start of the period, ISO 8601 date. Example: 2026-01-01
filtersstring- Advanced filter in ChartMogul Filter Language (CFL), for example currency~ANY~'USD'. Example: currency~ANY~'USD'
geostring- Comma-separated ISO 3166-1 alpha-2 country codes to filter by. Example: US,GB,DE
intervalstring- Bucket size: day, week, month, quarter, year (default month). One of: day, week, month, quarter, year. Example: monthone of
dayweekmonthquarteryear plansstring- Comma-separated plan UUIDs, external IDs or names (case-sensitive) to filter by. Example: Gold Monthly,Silver Monthly
chartmogul_metrics_mrr_getGet 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.Read-onlyGet MRR
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.
Inputs
end_datestringrequired- End of the period, ISO 8601 date. Example: 2026-10-31
start_datestringrequired- Start of the period, ISO 8601 date. Example: 2026-01-01
filtersstring- Advanced filter in ChartMogul Filter Language (CFL), for example currency~ANY~'USD'. Example: currency~ANY~'USD'
geostring- Comma-separated ISO 3166-1 alpha-2 country codes to filter by. Example: US,GB,DE
intervalstring- Bucket size: day, week, month, quarter, year (default month). One of: day, week, month, quarter, year. Example: monthone of
dayweekmonthquarteryear plansstring- Comma-separated plan UUIDs, external IDs or names (case-sensitive) to filter by. Example: Gold Monthly,Silver Monthly
chartmogul_notes_listList notes and call logs for the account or one customer.Read-onlyList Notes and Call Logs
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.
Inputs
author_emailstring- Only notes by this team member. Example: csm@yourcompany.com
cursorstring- Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
customer_uuidstring- Only notes on this customer. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
per_pageinteger- Results per page, at most 200 (the default). Example: 50
typestring- note or call. One of: note, call. Example: callone of
notecall
chartmogul_opportunities_listList opportunities, filtered by customer, owner, pipeline, stage or close-date range.Read-onlyList Opportunities
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.
Inputs
cursorstring- Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
customer_uuidstring- Only this customer's opportunities. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
estimated_close_date_on_or_afterstring- Expected to close on or after this date (ISO 8601). Example: 2026-11-01
estimated_close_date_on_or_beforestring- Expected to close on or before this date (ISO 8601). Example: 2026-12-31
ownerstring- Only opportunities owned by this salesperson email. Example: ae@yourcompany.com
per_pageinteger- Results per page, at most 200 (the default). Example: 50
pipelinestring- Only this pipeline. Example: New Business
pipeline_stagestring- Only this stage. Example: Negotiation
chartmogul_opportunity_getGet one opportunity by UUID.Read-onlyGet Opportunity
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.
Inputs
opportunity_uuidstringrequired- ChartMogul opportunity UUID, from chartmogul_opportunities_list. Example: 8b8e8b7e-1a2b-11ef-9a8b-0a1b2c3d4e5f
chartmogul_plan_getGet one plan by UUID.Read-onlyGet Plan
Get one plan by UUID. Returns the plan's name, interval and external ID. Use chartmogul_plan_get when you know the UUID.
Inputs
plan_uuidstringrequired- ChartMogul plan UUID (pl_...), from chartmogul_plans_list. Example: pl_eed05d54-75b4-431b-adb2-eb6b9e543206
chartmogul_plan_group_plans_listList the plans in a plan group.Read-onlyList Plans in Plan Group
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.
Inputs
plan_group_uuidstringrequired- Plan group UUID (plg_...), from chartmogul_plan_groups_list. Example: plg_b53fdbfc-c5eb-4a61-a589-85146cf8d0ab
cursorstring- Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
per_pageinteger- Results per page, at most 200 (the default). Example: 50
chartmogul_plan_groups_listList plan groups.Read-onlyList Plan Groups
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.
Inputs
cursorstring- Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
per_pageinteger- Results per page, at most 200 (the default). Example: 50
chartmogul_plans_listList subscription plans, optionally by source, external ID or billing system.Read-onlyList Plans
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.
Inputs
cursorstring- Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
data_source_uuidstring- Only plans in this source. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
external_idstring- Only the plan with this external ID. Example: gold_monthly
per_pageinteger- Results per page, at most 200 (the default). Example: 50
systemstring- Only plans from this billing system, for example Stripe or Custom. Example: Custom
chartmogul_source_getGet one data source by UUID.Read-onlyGet Source
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.
Inputs
data_source_uuidstringrequired- ChartMogul source UUID (ds_...), from chartmogul_sources_list. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
with_auto_churn_subscription_settingboolean- Include the past-due subscription handling setting. Example: false
with_invoice_handling_settingboolean- Include the invoice handling setting. Example: false
chartmogul_sources_listList the data sources (billing systems and custom import sources) in the account.Read-onlyList Sources
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.
Inputs
namestring- Only the source with this name. Example: My source
systemstring- Only sources of this billing system, for example Stripe, Recurly or Custom. Example: Custom
with_auto_churn_subscription_settingboolean- Include each source's past-due subscription handling setting. Example: false
with_invoice_handling_settingboolean- Include each source's invoice handling setting. Example: false
chartmogul_subscription_events_listList subscription events, filtered by source, customer, subscription, plan, type or dates.Read-onlyList Subscription Events
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.
Inputs
cursorstring- Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
customer_external_idstring- Only events of this customer external ID. Example: cus_0001
data_source_uuidstring- Only events in this source. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
effective_datestring- Only events effective at exactly this ISO 8601 time. Example: 2026-11-16T00:00:00Z
event_datestring- Only events raised at exactly this ISO 8601 time. Example: 2026-11-16T00:00:00Z
event_typestring- Only this event type, for example subscription_cancelled. Example: subscription_cancelled
external_idstring- Only the event with this external ID. Example: evnt_001
include_edit_historiesboolean- Include a summary of user edits (automatic sources). Example: false
per_pageinteger- Results per page, at most 200 (the default). Example: 50
plan_external_idstring- Only events for this plan. Example: gold_monthly
subscription_external_idstring- Only events of this subscription. Example: sub_0001
with_disabledboolean- Include disabled events. Example: false
chartmogul_task_getGet one task by UUID.Read-onlyGet Task
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.
Inputs
task_uuidstringrequired- ChartMogul task UUID, from chartmogul_tasks_list. Example: 00000000-0000-0000-0000-000000000000
chartmogul_tasks_listList tasks, filtered by customer, assignee, due-date range or completion.Read-onlyList Tasks
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.
Inputs
assigneestring- Only tasks assigned to this email. Example: csm@yourcompany.com
completedboolean- true for completed tasks, false for open ones. Example: false
cursorstring- Cursor from the previous page's response to fetch the next page; leave empty for the first page. Example: MjAyMy0wNi0wOVQxMzoxNjowMC4wMDBa
customer_uuidstring- Only this customer's tasks. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
due_date_on_or_afterstring- Due on or after this date (ISO 8601). Example: 2026-11-01
due_date_on_or_beforestring- Due on or before this date (ISO 8601). Example: 2026-11-30
per_pageinteger- Results per page, at most 200 (the default). Example: 50
chartmogul_contact_createCreate a contact person for a customer.WriteCreate Contact
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.
Inputs
customer_uuidstringrequired- ChartMogul UUID of the customer the contact belongs to. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
data_source_uuidstringrequired- Custom source UUID to store the contact in, from chartmogul_sources_list. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
customarray- Custom attributes, each with key and value; keys must already exist for contacts. Example: [{"key": "role", "value": "Champion"}]
emailstring- Email address, unique for the customer. Example: jane@example.com
external_idstring- Your unique ID for the contact. Example: con_0001
first_namestring- First name. Example: Jane
last_namestring- Last name. Example: Doe
linked_instring- LinkedIn profile URL. Example: https://linkedin.com/in/janedoe
notesstring- Notes about the contact. Example: Prefers email.
phonestring- Phone number. Example: +15555550123
positioninteger- Position in the customer's contact list; 1 is the primary contact. Example: 2
titlestring- Job title. Example: CFO
twitterstring- Twitter profile URL. Example: https://twitter.com/janedoe
chartmogul_contact_updateUpdate a contact's details or custom attributes.WriteUpdate Contact
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.
- Idempotent
Inputs
contact_uuidstringrequired- ChartMogul contact UUID (con_...), from chartmogul_contacts_list. Example: con_00000000-0000-0000-0000-000000000000
customarray- Custom attributes to set, each with key and value; keys must already exist. Example: [{"key": "role", "value": "Champion"}]
emailstring- Email address, unique for the customer. Example: jane@example.com
external_idstring- Your unique ID for the contact. Example: con_0001
first_namestring- First name. Example: Jane
last_namestring- Last name. Example: Doe
linked_instring- LinkedIn profile URL. Example: https://linkedin.com/in/janedoe
notesstring- Notes about the contact. Example: Prefers email.
phonestring- Phone number. Example: +15555550123
positioninteger- Position in the customer's contact list; 1 is the primary contact. Example: 2
titlestring- Job title. Example: CFO
twitterstring- Twitter profile URL. Example: https://twitter.com/janedoe
chartmogul_customer_createCreate a customer in a custom data source.WriteCreate Customer
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.
Inputs
data_source_uuidstringrequired- ChartMogul source UUID (ds_...), from chartmogul_sources_list. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
external_idstringrequired- Your unique ID for the customer (alphanumeric). Example: cus_0001
citystring- City. Example: San Francisco
companystring- The customer's company or organisation. Example: Example Company
countrystring- Country code, ISO 3166-1 alpha-2. Example: US
custom_attributesarray- 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_atstring- 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_atstring- When the customer became a lead, ISO 8601 time in the past. Example: 2026-01-15T10:00:00Z
ownerstring- Email of the team member who owns the customer; must be an existing team member. Example: sales@yourcompany.com
primary_contactobject- 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"}
statestring- US state code, ISO 3166-2, for example US-CA. Example: US-CA
statusstring- 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 Leadone of
New LeadWorking LeadQualified LeadUnqualified Lead tagsarray- Tags to add to the customer. Example: ["enterprise", "beta"]
website_urlstring- The customer's website URL. Example: https://example.com
zipstring- Zip or postal code. Example: 94107
chartmogul_customer_custom_attributes_addAdd custom attributes to a customer, creating new attribute definitions when needed.WriteAdd Customer Custom Attributes
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.
Inputs
customarrayrequired- Attributes to add, each with type (String, Integer, Decimal, Timestamp or Boolean), key and value. Example: [{"type": "Integer", "key": "seats", "value": 25}]
customer_uuidstringrequired- ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
overridesobject- Override flags by namespace, for example {"custom": {"channel": true}}; an overridden value is not changed by later syncs. Example: {"custom": {"seats": true}}
chartmogul_customer_custom_attributes_updateChange the values of a customer's existing custom attributes; attributes not sent are kept.WriteUpdate Customer Custom Attributes
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.
- Idempotent
Inputs
customobjectrequired- Attribute values to set, as key-value pairs; a value can also be {"value": ..., "source": ...}. Example: {"seats": 30, "channel": "Direct"}
customer_uuidstringrequired- ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
overridesobject- Override flags by namespace; true protects the value from later syncs, false removes an override. Example: {"custom": {"channel": true}}
chartmogul_customer_updateUpdate a customer's details, lead status, owner, primary contact, tags or custom attributes.WriteUpdate Customer
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.
- Idempotent
Inputs
customer_uuidstringrequired- ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
citystring- City. Example: San Francisco
companystring- The customer's company or organisation. Example: Example Company
countrystring- Country code, ISO 3166-1 alpha-2. Example: US
custom_attributesobject- Replaces all custom attributes, as key-value pairs; keys must already exist in ChartMogul. Example: {"channel": "Partner", "seats": 25}
free_trial_started_atstring- 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_atstring- When the customer became a lead, ISO 8601 time in the past. Example: 2026-01-15T10:00:00Z
ownerstring- Email of the team member who owns the customer; must be an existing team member. Example: sales@yourcompany.com
primary_contactobject- 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"}
statestring- US state code, ISO 3166-2, for example US-CA. Example: US-CA
statusstring- 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 Leadone of
New LeadWorking LeadQualified LeadUnqualified Lead tagsarray- Replaces all of the customer's tags. Example: ["enterprise"]
website_urlstring- The customer's website URL. Example: https://example.com
zipstring- Zip or postal code. Example: 94107
chartmogul_customers_mergeMerge one customer into another; the from customer's data moves into the into customer.WriteMerge Customers
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.
Inputs
fromobjectrequired- The customer to merge from, as {"customer_uuid": ...} or {"data_source_uuid": ..., "external_id": ...}. Example: {"customer_uuid": "cus_5915ee5a-babd-406b-b8ce-d207133fb4cb"}
intoobjectrequired- The customer to merge into (kept), in the same form as from. Example: {"customer_uuid": "cus_2123290f-09c8-4628-a205-db5596bd58f7"}
chartmogul_invoices_importImport one or more invoices for a customer; ChartMogul builds subscriptions and MRR from their line items.WriteImport Invoices
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.
Inputs
customer_uuidstringrequired- ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
invoicesarrayrequired- 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_editboolean- For automatic sources, true stores the invoices as user edits that survive resyncs. Example: false
chartmogul_note_createCreate a note or call log on a customer.WriteCreate Note or Call Log
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.
Inputs
customer_uuidstringrequired- ChartMogul UUID of the customer. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
typestringrequired- note or call. One of: note, call. Example: noteone of
notecall author_emailstring- Email of the team member who wrote it. Example: csm@yourcompany.com
call_durationinteger- For calls, duration in seconds (default 60). Example: 900
created_atstring- When the note or call happened, ISO 8601 time in the past. Defaults to now. Example: 2026-11-15T14:00:00Z
textstring- Contents, as plain text or HTML. Example: Discussed renewal; customer wants annual billing.
chartmogul_note_updateUpdate a note or call log.WriteUpdate Note or Call Log
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.
- Idempotent
Inputs
note_uuidstringrequired- ChartMogul note UUID, from chartmogul_notes_list. Example: note_00000000-0000-0000-0000-000000000000
author_emailstring- Email of the author. Example: csm@yourcompany.com
call_durationinteger- For calls, duration in seconds. Example: 600
created_atstring- When it happened, ISO 8601. Example: 2026-11-15T14:00:00Z
textstring- New contents. Example: Customer confirmed annual billing.
chartmogul_opportunity_createCreate a sales opportunity for a customer.WriteCreate Opportunity
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.
Inputs
amount_in_centsintegerrequired- Expected value in cents. Example: 500000
currencystringrequired- Three-letter currency code. Example: USD
customer_uuidstringrequired- ChartMogul UUID of the customer. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
estimated_close_datestringrequired- Expected close date, ISO 8601. Example: 2026-12-31
ownerstringrequired- Email of the salesperson responsible. Example: ae@yourcompany.com
pipelinestringrequired- Pipeline name, for example New Business or Renewals; must exist. Example: New Business
pipeline_stagestringrequired- Stage name in the pipeline, for example Discovery, Evaluation, Negotiation, Verbal Commit, Closed Won or Closed Lost. Example: Discovery
customarray- 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_categorystring- pipeline, best_case, committed, lost or won; defaults from the stage. One of: pipeline, best_case, committed, lost, won. Example: best_caseone of
pipelinebest_casecommittedlostwon typestring- recurring (value is MRR), arr (value is ARR) or one-time. One of: recurring, arr, one-time. Example: recurringone of
recurringarrone-time win_likelihoodinteger- Chance of closing, 0 to 100; defaults from the stage. Example: 60
chartmogul_opportunity_updateUpdate an opportunity's owner, pipeline, stage, close date, amount, forecast or custom attributes.WriteUpdate Opportunity
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.
- Idempotent
Inputs
opportunity_uuidstringrequired- ChartMogul opportunity UUID, from chartmogul_opportunities_list. Example: 8b8e8b7e-1a2b-11ef-9a8b-0a1b2c3d4e5f
amount_in_centsinteger- Expected value in cents. Example: 550000
currencystring- Three-letter currency code. Example: USD
customarray- 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_datestring- Expected close date, ISO 8601. Example: 2026-12-15
forecast_categorystring- pipeline, best_case, committed, lost or won; defaults from the stage. One of: pipeline, best_case, committed, lost, won. Example: best_caseone of
pipelinebest_casecommittedlostwon ownerstring- Email of the salesperson responsible. Example: ae@yourcompany.com
pipelinestring- Pipeline name. Example: New Business
pipeline_stagestring- Stage name. Example: Closed Won
typestring- recurring (value is MRR), arr (value is ARR) or one-time. One of: recurring, arr, one-time. Example: recurringone of
recurringarrone-time win_likelihoodinteger- Chance of closing, 0 to 100; defaults from the stage. Example: 60
chartmogul_plan_createCreate a subscription plan in a custom data source.WriteCreate Plan
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.
Inputs
data_source_uuidstringrequired- ChartMogul source UUID (ds_...), from chartmogul_sources_list. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
interval_countintegerrequired- Number of interval units per billing period, greater than 0 (6 with month means half-yearly). Example: 1
interval_unitstringrequired- day, month or year. One of: day, month, year. Example: monthone of
daymonthyear namestringrequired- Plan display name. Example: Gold Monthly
external_idstring- Your unique ID for the plan; generated when left empty. Example: gold_monthly
chartmogul_plan_updateUpdate a plan's name, or its interval when no subscription or invoice uses it yet.WriteUpdate Plan
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.
- Idempotent
Inputs
plan_uuidstringrequired- ChartMogul plan UUID (pl_...), from chartmogul_plans_list. Example: pl_eed05d54-75b4-431b-adb2-eb6b9e543206
interval_countinteger- Number of interval units per billing period. Example: 1
interval_unitstring- day, month or year. One of: day, month, year. Example: monthone of
daymonthyear namestring- Plan display name. Example: Gold Monthly (2026)
chartmogul_source_createCreate a custom data source to import billing data into through the API.WriteCreate Source
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.
Inputs
namestringrequired- Name of the source. Example: In-house billing
chartmogul_subscription_event_createRecord a subscription event (start, update, cancellation, pause, resume, or a scheduled or retracted one) for a customer in a source.WriteCreate Subscription Event
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.
Inputs
customer_external_idstringrequired- Your external ID of the customer. Example: cus_0001
data_source_uuidstringrequired- ChartMogul source UUID (ds_...), from chartmogul_sources_list. Example: ds_fef05d54-47b4-431b-aed2-eb6b9e545430
effective_datestringrequired- When the event takes effect, ISO 8601. Example: 2026-11-16
event_datestringrequired- When the event was raised, ISO 8601; for scheduled types it must be on or before effective_date. Example: 2026-11-16
event_typestringrequired- 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_startone of
subscription_startsubscription_start_scheduledscheduled_subscription_start_retractedsubscription_cancelledsubscription_cancellation_scheduledscheduled_subscription_cancellation_retractedsubscription_updatedsubscription_update_scheduledscheduled_subscription_update_retractedsubscription_event_retractedsubscription_pausedsubscription_resumed subscription_external_idstringrequired- Your external ID of the subscription. Example: sub_0001
amount_in_centsinteger- Final amount per billing period after discounts and taxes, in cents; required for start and update types. Example: 1000
currencystring- Three-letter currency code; required for start and update types. Example: USD
event_orderinteger- Processing order for simultaneous events (ascending). Example: 100
external_idstring- Your unique ID for the event. Example: evnt_001
handle_as_user_editboolean- 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_idstring- Plan external ID; required for start and update types. Example: gold_monthly
quantityinteger- Quantity (non-zero, default 1). Example: 1
retracted_event_idstring- For subscription_event_retracted, the ID of the scheduled event to retract. Example: 73966836
subscription_set_external_idstring- ID grouping several subscriptions into one set. Example: set_0001
tax_amount_in_centsinteger- Tax included in the amount, in cents (default 0). Example: 0
chartmogul_task_createCreate a task on a customer for a team member.WriteCreate Task
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.
Inputs
assigneestringrequired- Email of the team member assigned. Example: csm@yourcompany.com
customer_uuidstringrequired- ChartMogul UUID of the customer. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
due_datestringrequired- Due date, ISO 8601. Example: 2026-11-30
task_detailsstringrequired- What to do, up to 255 characters. Example: Send renewal proposal
completed_atstring- Completion date, ISO 8601 in the past, if already done. Example: 2026-11-16
chartmogul_task_updateUpdate a task's details, assignee, due date or completion date.WriteUpdate Task
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.
- Idempotent
Inputs
task_uuidstringrequired- ChartMogul task UUID, from chartmogul_tasks_list. Example: 00000000-0000-0000-0000-000000000000
assigneestring- Email of the team member assigned. Example: csm@yourcompany.com
completed_atstring- Completion date, ISO 8601 in the past. Example: 2026-11-16
due_datestring- Due date, ISO 8601. Example: 2026-12-05
task_detailsstring- What to do, up to 255 characters. Example: Send revised renewal proposal
chartmogul_transaction_createRecord a payment or refund against an imported invoice.WriteCreate Transaction
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.
Inputs
datestringrequired- When the transaction was attempted, ISO 8601. Example: 2026-11-16 10:00:00
invoice_uuidstringrequired- ChartMogul invoice UUID (inv_...). Example: inv_565c73b2-85b9-49c9-a25e-2b7df6a677c9
resultstringrequired- successful or failed. One of: successful, failed. Example: successfulone of
successfulfailed typestringrequired- payment or refund. One of: payment, refund. Example: paymentone of
paymentrefund amount_in_centsinteger- Partial amount in cents; defaults to the full invoice amount. Example: 5000
external_idstring- Your unique ID for the transaction. Example: trans_00241
handle_as_user_editboolean- For automatic sources, true stores it as a user edit; needs external_id. Example: false
transaction_fees_currencystring- Currency of the fees. Example: USD
transaction_fees_in_centsinteger- Transaction fees in cents (default 0). Example: 150
chartmogul_contact_deleteDelete a contact.DestructiveDelete Contact
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.
- Idempotent
Inputs
contact_uuidstringrequired- ChartMogul contact UUID (con_...), from chartmogul_contacts_list. Example: con_00000000-0000-0000-0000-000000000000
chartmogul_contacts_mergeMerge one contact into another; details missing on the kept contact are copied over and the other contact is removed.DestructiveMerge Contacts
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.
Inputs
from_contact_uuidstringrequired- UUID of the contact to merge from and remove. Example: con_36c9f236-ea66-11ed-b81d-cf0d715ced77
into_contact_uuidstringrequired- UUID of the contact to keep. Example: con_653af916-dea0-11ed-845b-3be1ac0039ac
chartmogul_customer_deleteDelete a customer imported through the API, with all its invoices, subscriptions, transactions and attributes.DestructiveDelete Customer
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.
- Idempotent
Inputs
customer_uuidstringrequired- ChartMogul customer UUID (cus_...), from chartmogul_customers_list. Example: cus_de305d54-75b4-431b-adb2-eb6b9e546012
chartmogul_note_deleteDelete a note or call log.DestructiveDelete Note or Call Log
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.
- Idempotent
Inputs
note_uuidstringrequired- ChartMogul note UUID, from chartmogul_notes_list. Example: note_00000000-0000-0000-0000-000000000000
chartmogul_opportunity_deleteDelete an opportunity.DestructiveDelete Opportunity
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.
- Idempotent
Inputs
opportunity_uuidstringrequired- ChartMogul opportunity UUID, from chartmogul_opportunities_list. Example: 8b8e8b7e-1a2b-11ef-9a8b-0a1b2c3d4e5f
chartmogul_task_deleteDelete a task.DestructiveDelete Task
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.
- Idempotent
Inputs
task_uuidstringrequired- ChartMogul task UUID, from chartmogul_tasks_list. Example: 00000000-0000-0000-0000-000000000000
No tools match.