Getting Started
1
Create or Select a Project
Set up a new project or select an existing one. See Organizations & Projects.
2
Configure the Connector
Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.
Connector Profile · API Key
Requires an API key generated in your ChartMogul profile. Keys do not expire and are sent using HTTP Basic authenticatio…
3
Link an Account
Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:
Link Account · API Key
4
Use Actions
Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.
Actions
74 actions
Action
Description
Get Account Details
Returns useful information about the authenticated ChartMogul account.
List Contacts
List contact objects in the ChartMogul account, optionally filtered by customer, data source, or email.
Get Contact
Retrieve a single contact object from ChartMogul by its UUID.
Create Contact
Create a contact under a specified ChartMogul customer within the selected data source.
Update Contact
Update the modifiable attributes of an existing ChartMogul contact.
Delete Contact
Permanently delete a ChartMogul contact and all of its associated data.
List Customers
List all customers in the ChartMogul account, with optional filters.
Get Customer
Retrieve a single customer object by its ChartMogul UUID.
Create Customer
Create a customer object under a specified ChartMogul data source.
Update Customer
Update the modifiable attributes of an existing customer.
Delete Customer
Permanently delete a customer and all of its associated data.
Search Customers By Email
List all customers matching a given email address.
List Customer Invoices
List the invoices imported via the API for a given customer.
Create Customer Contact
Add an additional contact to an existing customer.
List Invoices
Returns a list of invoice objects created using the API in your ChartMogul account.
Get Invoice
Retrieves a single invoice object from your ChartMogul account.
Import Invoices For A Customer
Creates invoices for a customer identified by ChartMogul UUID, auto-generating subscriptions from the invoice line items…
Import Invoices By Customer External ID
Creates invoices for a customer identified by external ID and data source rather than ChartMogul UUID, auto-generating s…
Update Invoice
Updates invoice-level details such as the date, due date, currency, or collection method.
Delete Invoice
Deletes the specified invoice object and all its associated line items and transactions.
Get Line Item
Retrieve a single invoice line item from ChartMogul by its UUID, or by external ID together with data source UUID.
Create Line Item
Add a subscription, one-time, or trial line item to an existing ChartMogul invoice identified by its UUID.
Create Line Item By External ID
Add a subscription, one-time, or trial line item to a ChartMogul invoice identified by its external ID and data source.
Update Line Item
Partially update an existing ChartMogul invoice line item identified by its UUID, or by external ID together with data s…
Delete Line Item
Delete a ChartMogul invoice line item and all its associated data, identified by UUID or by external ID together with da…
Get All Key Metrics
Retrieve all key ChartMogul metrics as a single combined time series for a date range.
Get MRR Metrics
Retrieve the Monthly Recurring Revenue (MRR) time series with its movement breakdown.
Get ARR Metrics
Retrieve the Annualized Run Rate (ARR) time series for a date range.
Get ARPA Metrics
Retrieve the Average Revenue Per Account (ARPA) time series for a date range.
Get ASP Metrics
Retrieve the Average Sale Price (ASP) time series for a date range.
Get Customer Count Metrics
Retrieve the active customer count time series for a date range.
Get Customer Churn Rate Metrics
Retrieve the Customer Churn Rate time series for a date range.
Get MRR Churn Rate Metrics
Retrieve the Net MRR Churn Rate time series for a date range.
Get LTV Metrics
Retrieve the Customer Lifetime Value (LTV) time series for a date range, always monthly.
List Notes And Call Logs
List notes and call logs for the whole ChartMogul account or for a specific customer.
Get Note Or Call Log
Retrieve a single ChartMogul note or call log by its UUID.
Create Note Or Call Log
Log a free-text note or a call record against a ChartMogul customer.
Update Note Or Call Log
Update the modifiable attributes of an existing ChartMogul note or call log.
Delete Note Or Call Log
Permanently delete a ChartMogul note or call log.
List Opportunities
Lists opportunity objects in your ChartMogul account, with optional filters for customer, owner, pipeline, stage and est…
Get An Opportunity
Retrieves a single opportunity object from your ChartMogul account by its UUID.
Create An Opportunity
Creates an opportunity object for a specified customer in ChartMogul.
Update An Opportunity
Partially updates an opportunity object in your ChartMogul account.
Delete An Opportunity
Permanently deletes an opportunity object in your ChartMogul account.
List Plan Groups
Returns a list of plan group objects in your ChartMogul account.
Get A Plan Group
Retrieves a plan group object from your ChartMogul account.
Create A Plan Group
Creates a plan group object in ChartMogul.
Update A Plan Group
Updates a plan group object in your ChartMogul account.
Delete A Plan Group
Deletes the specified plan group object from your ChartMogul account.
List Plans In A Plan Group
Returns a list of plan objects in a specific plan group in your ChartMogul account.
List Plans
Returns a list of plan objects in your ChartMogul account.
Get A Plan
Retrieves a plan object from your ChartMogul account.
Create A Plan
Creates a plan object in ChartMogul under the specified data source.
Update A Plan
Updates a plan object in your ChartMogul account.
Delete A Plan
Deletes the specified plan object from your ChartMogul account.
List Data Sources
Lists all data source objects in the ChartMogul account.
Get A Data Source
Retrieves a single data source object from the ChartMogul account.
Create A Data Source
Creates a data source object for importing data into ChartMogul.
Delete A Data Source
Permanently delete a data source and every record imported through it.
List Subscription Events
Lists subscription event objects from the ChartMogul account.
Create A Subscription Event
Creates a subscription event for the specified source and customer.
Update A Subscription Event
Updates an existing subscription event.
Delete A Subscription Event
Deletes a subscription event using either its external ID and source UUID or its ChartMogul ID.
List Customer Subscriptions
Returns a list of subscriptions for a given customer.
List Tasks
Lists task objects in your ChartMogul account, with optional filters for customer, assignee, due date range and completi…
Get A Task
Retrieves a single task object from your ChartMogul account by its UUID.
Create A Task
Creates a task object for a specified customer and team member in ChartMogul.
Update A Task
Partially updates a task object in your ChartMogul account, including marking it complete.
Delete A Task
Permanently deletes a task object in your ChartMogul account.
Get Transaction
Retrieve a single ChartMogul payment or refund transaction by its UUID, or by external ID together with data source UUID…
Create Transaction
Record a payment or refund transaction against a ChartMogul invoice identified by its UUID.
Create Transaction By External ID
Record a payment or refund transaction against a ChartMogul invoice identified by its external ID and data source.
Update Transaction
Partially update an existing ChartMogul transaction identified by its UUID, or by external ID together with data source…
Delete Transaction
Delete a ChartMogul transaction and all its associated data, identified by UUID or by external ID together with data sou…