Skip to main content
ChartMogul logo
  • Category: analytics
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: CHARTMOGUL
  • Version: 00000000_00

Tools

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

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHARTMOGUL_DELETE_CUSTOMERRequest permanent deletion of a customer and all associated ChartMogul data by UUID. ChartMogul accepts this asynchronously, so confirm disappearance with LIST_CUSTOMERS when completion matters.

Input Parameters

string
required
ChartMogul UUID of the customer to permanently delete with all associated data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHARTMOGUL_GET_ACCOUNTReturn the connected ChartMogul account’s identity, reporting currency, time zone, week start, and optionally selected churn and refund settings.

Input Parameters

array
Additional account settings to include; omit for core account details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHARTMOGUL_GET_CUSTOMERReturn one customer and its identifiers, lifecycle status, revenue values, ownership, location, and attributes by ChartMogul UUID.

Input Parameters

string
required
ChartMogul customer UUID, typically beginning with cus_.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHARTMOGUL_GET_KEY_METRICSReturn all key subscription metrics and current summaries for a date range, optionally grouped by interval and filtered by countries or plans.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHARTMOGUL_LIST_ACTIVITIESReturn one page of ChartMogul MRR activities for an optional date range, movement type, and date order, with a cursor when more are available.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHARTMOGUL_LIST_CUSTOMERSReturn one page of customers filtered by source, identifier, email, status, or billing system.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHARTMOGUL_LIST_CUSTOMER_SUBSCRIPTIONSReturn one page of subscriptions for a ChartMogul customer.

Input Parameters

string
Opaque next_cursor from a previous response; omit for the first page.
integer
Maximum subscriptions to return in this page (1-200).
string
required
ChartMogul UUID of the customer whose subscriptions should be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHARTMOGUL_LIST_INVOICESReturn one page of invoices, optionally filtered by source, customer, external ID, validation state, edit-history inclusion, or disabled state.

Input Parameters

string
Opaque next_cursor from a previous response; omit for the first page.
integer
Maximum invoices to return in this page (1-200).
string
Exact external invoice identifier to find.
string
ChartMogul customer UUID whose invoices should be returned.
boolean
Include disabled invoices.
string ("valid" | "invalid" | "all")
Return valid, invalid, or all invoices.
string
ChartMogul source UUID whose invoices should be returned.
boolean
Include edit history summaries for supported automatic sources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHARTMOGUL_LIST_PLANSReturn one page of subscription plans, optionally filtered by source, external ID, or billing system.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHARTMOGUL_LIST_SOURCESReturn the account’s billing data sources, optionally filtered by name or system and with selected source settings included.

Input Parameters

string
Exact source name to filter by.
string
Billing system to filter by, such as Stripe, Recurly, or Custom.
boolean
Include each source’s past-due subscription handling setting.
boolean
Include each source’s invoice handling setting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CHARTMOGUL_UPDATE_CUSTOMERUpdate selected profile, ownership, location, timing, website, or lead-status fields on an existing ChartMogul customer. Omitted fields remain unchanged; tags and custom attributes are not replaced.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not