| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.chartmogul.com/ | link | — | — | — |
Actions (41)
Metrics · 8
- Retrieve ARPAGET /v1/metrics/arpa
Retrieves Average Revenue Per Account (ARPA) for a time period.
documented - Retrieve ARRGET /v1/metrics/arr
Retrieves the Annualized Run Rate (ARR) for a time period.
documented - Retrieve ASPGET /v1/metrics/asp
Retrieves Average Sale Price (ASP) for a time period.
documented - Retrieve LTVGET /v1/metrics/ltv
Retrieves customer lifetime value (LTV).
documented - Retrieve MRRGET /v1/metrics/mrr
Retrieves the Monthly Recurring Revenue (MRR) for a time period.
documented - Retrieve MRR churn rateGET /v1/metrics/mrr-churn-rate
Retrieves MRR churn rate metrics.
documented - Retrieve customer churn rateGET /v1/metrics/churn-rate
Retrieves customer churn rate metrics.
documented - Retrieve customer countGET /v1/metrics/customer_count
Retrieves customer count metrics.
documented
Invoices · 7
- Delete all customer invoicesDELETE /v1/customers/{CUSTOMER_UUID}/invoices
Deletes all invoices for a given customer.
documented - Delete invoiceDELETE /v1/invoices/{INVOICE_UUID}
Deletes a specific invoice.
documented - List customer invoices (import path)GET /v1/customers/{CUSTOMER_UUID}/invoices
Returns invoices for a given customer imported via the API.
documented - List invoicesGET /v1/invoices
Returns a list of invoice objects in your ChartMogul account.
documented - Retrieve invoiceGET /v1/invoices/{INVOICE_UUID}
Retrieves a specific invoice.
documented - Update invoicePATCH /v1/invoices/{INVOICE_UUID}
Updates an invoice (status or other modifiable attributes).
documented - Update invoice statusPATCH /v1/invoices/{INVOICE_UUID}
Updates the status of an invoice.
documented
Import API · 6
- Bulk import data for a data sourcePOST /v1/data_sources/{DATA_SOURCE_UUID}/json_imports
Imports or updates multiple objects for a data source in a single API call.
documented - Create data source (import)POST /v1/data_sources
Creates a data source for external imports.
documented - Import contactPOST /v1/contacts
Imports a contact for a customer/source.
documented - Import customerPOST /v1/customers
Imports a customer into ChartMogul from an external source.
documented - List customer invoices (import)GET /v1/import/customers/{CUSTOMER_UUID}/invoices
Lists invoices for a given customer imported via API.
documented - Track bulk import statusGET /v1/data_sources/{DATA_SOURCE_UUID}/json_imports/{IMPORT_ID}
Tracks the status of a bulk import for a data source.
documented
Contacts · 4
- Add contact to customerPOST /v1/customers/{CUSTOMER_UUID}/contacts
Creates a contact for a given customer within the selected data source.
documented - Create contactPOST /v1/contacts
Creates a contact (import) under a customer/source.
documented - List contactsGET /v1/contacts
Lists contacts for your account.
documented - Retrieve contactGET /v1/contacts/{CONTACT_UUID}
Retrieves a specific contact.
documented
Data Sources · 4
- Create data sourcePOST /v1/data_sources
Creates a data_source for importing data into ChartMogul.
documented - Delete data sourceDELETE /v1/data_sources/{DATA_SOURCE_UUID}
Deletes the specified data source and all its data.
documented - List data sourcesGET /v1/data_sources
Lists all data_source objects in your ChartMogul account.
documented - Retrieve data sourceGET /v1/data_sources/{DATA_SOURCE_UUID}
Retrieves a specific data_source.
documented
Customers · 3
- Create customerPOST /v1/customers
Creates a customer under the specified data source.
documented - List customersGET /v1/customers
Returns a list of customer objects in your ChartMogul account.
documented - Update customerPATCH /v1/customers/{CUSTOMER_UUID}
Updates modifiable attributes of a customer.
documented
Plans · 3
Bulk Import · 2
- Import data in bulkPOST /v1/data_sources/{DATA_SOURCE_UUID}/json_imports
Imports multiple customers, plans, invoices, line items, transactions and subscription events in one request.
documented - Track bulk import statusGET /v1/data_sources/{DATA_SOURCE_UUID}/json_imports/{IMPORT_ID}
Checks the status and progress of a bulk import.
documented