In this article, we provide an overview of our API and some common solutions to help you understand how your business can build a custom integration with ChartMogul.
Here’s what we cover in this article:
- API overview
- Getting started with the API
- API solutions
Resources and further reading:
|Enrichment API||Adding, modifying, and accessing customer metadata for deeper insights with segmentation.||Import|
|Import API||Importing customers, plans, and invoices to add subscriptions. Includes the Subscription Events API to report committed monthly recurring revenue (CMRR).||Import|
|Metrics API||Sending key subscription metrics to an external application.||Export|
Getting started with the API
- Click ADD A SOURCE and select Custom Source.
- Enter a unique name in the Name field.
- Click NEXT to create the custom data source.
Once your setup is complete, visit our Developer Hub for comprehensive guides and documentation for building an integration.
We’ve outlined some common scenarios and the solutions our customers have developed using our API.
Integrating your billing system or data warehouse
Scenario: You want to import subscription data from a billing system that is not supported by ChartMogul or stored in a data warehouse.
Solution: Use the Import API to build an integration for importing subscription data. Your team can customize how data is sent and edit it as needed. Once you’ve integrated your billing system, use the Enrichment API to clean up duplicate customer records and close gaps in subscription history.
The key data points required to build an integration are:
- Customers — their unique identifier, such as an ID or email address.
- Plans — sometimes called products, which customers pay for on a recurring basis.
- Invoices — sometimes called transactions, which must include information about the customer, the amount billed, their plan, their related subscription, and the service period dates.
- Cancellations — the date a subscription was canceled.
View the full list of data points in our Developer Hub.
Subscriptions are generated automatically based on line item data in an invoice. Customers become subscribers and contribute to MRR after their first invoice. Transaction data is not required; however, it is used to generate cash flow reports.
Learn how Cronofy integrated the ChartMogul Import API on our blog.
Integrating your Customer Relationship Management (CRM) software
Scenario: You've integrated your billing system, and ChartMogul is receiving customer and billing data. However, leads and trials are tracked in your CRM software, and you want to track them in ChartMogul.
Solution: Use the Import API to integrate your CRM and send trial and lead data to ChartMogul before the customer is created in your billing system. Once connected, you’ll be able to access the Leads and Free Trials reports.
For further analysis, use the Enrichment API to add and modify additional data to customer records — such as marketing campaign or product usage — as custom attributes. Custom attributes are similar to custom fields and create new filters for segmentation.
Integrating your external reporting tool
Scenario: You want to share your ChartMogul metrics externally, such as with your team or investors.
Solution: Use the Metrics API to export key subscription metrics and add them to reports or presentations. Send a complete overview, or segment the data by plan or region.
Learn how Ghost built a public metrics dashboard on our blog.