\n\n \n\n## Installation\n\nThis library supports node.js 18.x or above.\n\n```sh\nnpm install --save chartmogul-node\n```\n\n## Configuration\nFirst create a `Config` object by passing your api key, available from the administration section of your ChartMogul account.\n\n```js\nconst ChartMogul = require('chartmogul-node');\nconst config = new ChartMogul.Config(process.env.CHARTMOGUL_API_KEY);\n```\n\nYou need to pass this config object as the first argument to each request.\n\n\n### Test your authentication\n\n```js\nChartMogul.Ping.ping(config)\n .then(res => console.log(res))\n .catch(err => console.error(err))\n```\n\n## Usage\n\nThe library can be used both with promise and callback patterns. Supply the callback function as the last argmunent.\n\nHere are sample examples:\n\n**Using as promise**\n\n```js\nconst ChartMogul = require('chartmogul-node');\n\nconst config = new ChartMogul.Config('apiKey');\n\nChartMogul.Customer.create(config, {\n data_source_uuid: 'ds_e243129a-12c0-4e29-8f54-07da7905fbd1',\n external_id: 'cus_0001',\n name: 'Adam Smith',\n email: 'adam@smith.com',\n country: 'US',\n city: 'New York'\n})\n.then(res => {\n console.log(res);\n})\n.catch(e => console.error(e.message, e.httpStatus, e.response));\n```\n\n**Using with a callback**\n\n```js\nconst ChartMogul = require('chartmogul-node');\n\nconst config = new ChartMogul.Config('apiKey');\n\nChartMogul.Customer.create(config, data, (err, res) => {\n if(err) {\n console.error(err.message, err.httpStatus, err.response)\n }\n console.log(res);\n});\n```\n\n### Import API\n\nAvailable methods in Import API:\n\n#### [Data Sources](https://dev.chartmogul.com/reference/sources/)\n\n```js\nChartMogul.DataSource.create(config, data)\nChartMogul.DataSource.retrieve(config, dataSourceUuid, query)\nChartMogul.DataSource.all(config, query)\nChartMogul.DataSource.destroy(config, dataSourceUuid)\n```\n\n#### [Customers](https://dev.chartmogul.com/reference/customers/)\n\n```js\nChartMogul.Customer.create(config, data)\nChartMogul.Customer.retrieve(config, customerUuid)\nChartMogul.Customer.all(config, { per_page: 20 })\nChartMogul.Customer.modify(config, customerUuid, data)\nChartMogul.Customer.destroy(config, customerUuid)\nChartMogul.Customer.merge(config, {\n 'from': {'customer_uuid': 'cus_5915ee5a-babd-406b-b8ce-d207133fb4cb'},\n 'into': {'customer_uuid': 'cus_2123290f-09c8-4628-a205-db5596bd58f7'}\n})\nChartMogul.Customer.unmerge(config, {\n 'customer_uuid': 'cus_cd9e5f29-6299-40e5-b343-0bd1ed228b4f',\n 'data_source_uuid': 'ds_788ec6ae-dd51-11ee-bd46-a3ec952dc041',\n 'external_id': 'cus_O075O8NH0LrtG8',\n 'move_to_new_customer': []\n})\n// DEPRECATED: Use ChartMogul.Metrics.Customer.connectSubscriptions instead\nChartMogul.Customer.connectSubscriptions(config, customerUuid, {\n subscriptions: [{ uuid: 'sub_uuid' }]\n})\n// DEPRECATED: Use ChartMogul.Metrics.Customer.disconnectSubscriptions instead\nChartMogul.Customer.disconnectSubscriptions(config, customerUuid, {\n subscriptions: [{ uuid: 'sub_uuid' }]\n})\n\nChartMogul.Customer.contacts(config, customerUuid, { per_page: 10, cursor: 'cursor==' })\nChartMogul.Customer.createContact(config, customerUuid, data)\n\nChartMogul.Customer.notes(config, customerUuid, { per_page: 10, cursor: 'cursor==' })\nChartMogul.Customer.createNote(config, customerUuid, data)\n\nChartMogul.Customer.opportunities(config, customerUuid, { per_page: 10, cursor: 'cursor==' })\nChartMogul.Customer.createOpportunity(config, customerUuid, data)\n\nChartMogul.Customer.tasks(config, customerUuid, { per_page: 10, cursor: 'cursor==' })\nChartMogul.Customer.createTask(config, customerUuid, data)\n```\n\n#### [Contacts](https://dev.chartmogul.com/reference/contacts/)\n\n```js\nChartMogul.Contact.create(config, data)\nChartMogul.Contact.retrieve(config, contactUuid)\nChartMogul.Contact.modify(config, contactUuid)\nChartMogul.Contact.destroy(config, contactUuid)\nChartMogul.Contact.merge(config, intoUuid, fromUuid);\nChartMogul.Contact.all(config, { per_page: 10, cursor: 'cursor==' })\n\n```\n\n#### [Customer Notes](https://dev.chartmogul.com/reference/notes-and-call-logs/)\n\n```js\nChartMogul.CustomerNote.create(config, data)\nChartMogul.CustomerNote.retrieve(config, noteUuid)\nChartMogul.CustomerNote.patch(config, noteUuid, data)\nChartMogul.CustomerNote.destroy(config, noteUuid)\nChartMogul.CustomerNote.all(config, { per_page: 10, cursor: 'cursor==', customer_uuid: customerUuid})\n\n```\n\n#### [Opportunities](https://dev.chartmogul.com/reference/opportunities/)\n\n```js\nChartMogul.Opportunity.create(config, data)\nChartMogul.Opportunity.retrieve(config, opportunityUuid)\nChartMogul.Opportunity.patch(config, opportunityUuid, data)\nChartMogul.Opportunity.destroy(config, opportunityUuid)\nChartMogul.Opportunity.all(config, { per_page: 10, cursor: 'cursor==', customer_uuid: customerUuid})\n```\n\n#### [Tasks](https://dev.chartmogul.com/reference/tasks/)\n\n```js\nChartMogul.Task.create(config, data)\nChartMogul.Task.retrieve(config, taskUuid)\nChartMogul.Task.patch(config, taskUuid, data)\nChartMogul.Task.destroy(config, taskUuid)\nChartMogul.Task.all(config, { per_page: 10, cursor: 'cursor==', customer_uuid: customerUuid})\n```\n\n\n#### [Plans](https://dev.chartmogul.com/reference/plans/)\n\n```js\nChartMogul.Plan.create(config, data)\nChartMogul.Plan.retrieve(config, uuid)\nChartMogul.Plan.modify(config, uuid, { name: 'new name' })\nChartMogul.Plan.destroy(config, uuid)\nChartMogul.Plan.all(config, query)\n```\n\n#### [Plan Groups](https://dev.chartmogul.com/reference/plan-groups/)\n\n```js\nChartMogul.PlanGroup.create(config, data)\nChartMogul.PlanGroup.retrieve(config, planGroupUuid)\nChartMogul.PlanGroup.modify(config, planGroupUuid, data)\nChartMogul.PlanGroup.destroy(config, planGroupUuid)\nChartMogul.PlanGroup.all(config, query)\nChartMogul.PlanGroup.all(config, planGroupUuid, query)\n```\n\n#### [Subscriptions](https://dev.chartmogul.com/reference/subscriptions/)\n\n```js\n// DEPRECATED: Use ChartMogul.Metrics.Customer.subscriptions instead\nChartMogul.Subscription.all(config, customerUuid, query)\nChartMogul.Subscription.cancel(config, subscriptionUuid, { cancelled_at: '' })\nChartMogul.Subscription.modify(config, subscriptionUuid, { cancellation_dates: [] })\n\n// Recommended: Use Metrics API for subscriptions\nChartMogul.Metrics.Customer.subscriptions(config, customerUuid, query)\nChartMogul.Metrics.Customer.connectSubscriptions(config, dataSourceUuid, customerUuid, {\n subscriptions: [{ uuid: 'sub_uuid', data_source_uuid: 'ds_uuid' }]\n})\nChartMogul.Metrics.Customer.disconnectSubscriptions(config, dataSourceUuid, customerUuid, {\n subscriptions: [{ uuid: 'sub_uuid', data_source_uuid: 'ds_uuid' }]\n})\n```\n\n#### [Invoices](https://dev.chartmogul.com/reference/invoices/)\n\n```js\nChartMogul.Invoice.create(config, customerUuid, data)\nChartMogul.Invoice.retrieve(config, invoiceUuid)\nChartMogul.Invoice.destroy(config, invoiceUuid)\nChartMogul.Invoice.all(config, customerUuid, query)\nChartMogul.Invoice.all(config, query)\nChartMogul.Invoice.destroy_all(config, dataSourceUuid, customerUuid)\n```\n\n#### [Transactions](https://dev.chartmogul.com/reference/transactions/)\n\n```js\nChartMogul.Transaction.create(config, invoiceUuid, data)\n```\n\n#### [Subscription events](https://dev.chartmogul.com/reference/subscription-events/)\n\n```js\nChartMogul.SubscriptionEvent.create(config, {\n subscription_event: {\n event_type: 'subscription_cancelled',\n event_date: '2022-06-13',\n effective_date: '2022-06-13',\n subscription_external_id: 'sub_ex_id_1',\n customer_external_id: 'cus_ex_id_1',\n data_source_uuid: '4175177b-3e4b-45b6-b6fb-426d6fd79028'\n }\n})\nChartMogul.SubscriptionEvent.updateWithParams(config, {\n subscription_event: {\n id: 1,\n plan_external_id: 'gazillion_monthly'\n }\n})\nChartMogul.SubscriptionEvent.deleteWithParams(config, {\n subscription_event: {\n id: 1\n }\n})\nChartMogul.SubscriptionEvent.all(config, query)\n```\n\n### Enrichment API\n\nAvailable methods in Enrichment API:\n\n#### [Customers](https://dev.chartmogul.com/reference/customers/)\n\n```js\nChartMogul.Customer.search(config, { email: 'bob@example.com' })\n```\n\n#### [Customer Attributes](https://dev.chartmogul.com/reference/customers/attributes/)\n\n```js\nChartMogul.Customer.attributes(config, customerUuid)\n```\n\n#### [Tags](https://dev.chartmogul.com/reference/customers/tags/)\n\n```js\nChartMogul.Tag.add(config, customerUuid, {\n 'tags': ['important', 'Prio1']\n});\nChartMogul.Tag.add(config, {\n 'email': 'adam@smith.com',\n 'tags': ['important', 'Prio1']\n})'\nChartMogul.Tag.remove(config, customerUuid, {\n 'tags': ['Prio1', 'discountable']\n});\n```\n\n#### [Custom Attributes](https://dev.chartmogul.com/reference/customers/attributes/)\n\n```js\nChartMogul.CustomAttribute.add(config, customerUuid, {\n 'custom': [\n { 'type': 'Integer', 'key': 'age', 'value': 8 }\n ]\n});\nChartMogul.CustomAttribute.add(config, {\n 'email': 'adam@example.com',\n 'custom': [\n { 'type': 'Integer', 'key': 'age', 'value': 8 }\n ]\n});\nChartMogul.CustomAttribute.update(config, customerUuid, {\n 'custom': {\n 'age': 20,\n 'channel': 'Twitter'\n }\n});\nChartMogul.CustomAttribute.remove(config, customerUuid, {\n 'custom': ['CAC']\n});\n```\n\n### [Metrics API](https://dev.chartmogul.com/reference/metrics/)\n\nAvailable methods in Metrics API:\n\n```js\nChartMogul.Metrics.all(config, {\n 'start-date': '2015-01-01',\n 'end-date': '2015-11-24',\n 'interval': 'month',\n 'geo': 'GB',\n 'plans': 'Bronze Plan',\n 'filters': \"currency~ANY~'USD'\"\n})\nChartMogul.Metrics.mrr(config, query)\nChartMogul.Metrics.arr(config, query)\nChartMogul.Metrics.arpa(config, query)\nChartMogul.Metrics.asp(config, query)\nChartMogul.Metrics.customerCount(config, query)\nChartMogul.Metrics.customerChurnRate(config, query)\nChartMogul.Metrics.mrrChurnRate(config, query)\nChartMogul.Metrics.ltv(config, query)\nChartMogul.Metrics.Customer.activities(config, customerUuid, query)\nChartMogul.Metrics.Customer.subscriptions(config, customerUuid, query)\nChartMogul.Metrics.Customer.connectSubscriptions(config, dataSourceUuid, customerUuid, data)\nChartMogul.Metrics.Customer.disconnectSubscriptions(config, dataSourceUuid, customerUuid, data)\nChartMogul.Metrics.Activity.all(config, query)\nChartMogul.Metrics.ActivitiesExport.create(config, query)\nChartMogul.Metrics.ActivitiesExport.retrieve(config, id)\n```\n\n### Account\n\nAvailable methods:\n\n```js\nChartMogul.Account.retrieve(config)\n```\n\n### Errors\n\nThe library throws following error objects.\n\n- `ChartMogul.ChartMogulError`\n- `ChartMogul.ConfigurationError`\n- `ChartMogul.ForbiddenError`\n- `ChartMogul.NotFoundError`\n- `ChartMogul.ResourceInvalidError`\n- `ChartMogul.SchemaInvalidError`\n- `ChartMogul.DeprecatedParamError`\n\nThe following table describes the properties of the error object.\n\n| Property | Type | Description |\n|:----------:|:----------------:|:-------------------------------------------------------------------:|\n| `message` | string | The error message |\n| `httpStatus` | number | When the error occurs during an HTTP request, the HTTP status code. |\n| `response` | object or string | HTTP response as JSON, or raw response if not parsable to JSON |\n\n### Rate Limits & Exponential Backoff\n\nThe library will keep retrying if the request exceeds the rate limit or if there's any network related error.\nBy default, the request will be retried for 20 times (approximated 15 minutes) before finally giving up.\n\nYou can change the retry count using `Config` object:\n\n```js\nconst ChartMogul = require('chartmogul-node');\nconst config = new ChartMogul.Config(process.env.CHARTMOGUL_API_KEY);\nconfig.retries = 15; // 0 disables retrying\n```\n\n## Development\n\nTo work on the library:\n\n* Fork it\n* Create your feature branch (`git checkout -b my-new-feature`)\n* Install dependencies: `npm install`\n* Fix bugs or add features. Make sure the changes pass the coding guidelines by runing: `npm run lint`\n* Write tests for your new features. For HTTP mocking `nock` library is used. Run tests with `npm test` and check test coverage with `npm run cover`\n* If all tests are passed, push to the branch (`git push origin my-new-feature`)\n* Create a new Pull Request\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/chartmogul/chartmogul-node.\n\n## Releasing\n\nSee [RELEASING.md](RELEASING.md) for the full release process.\n\n## Security\n\n### Verifying Releases\n\nAll releases of this library are published as [immutable GitHub Releases](https://github.com/chartmogul/chartmogul-node/releases) with protected tags and as a package on [npmjs.com](https://www.npmjs.com/package/chartmogul-node).\n\nTo maximize supply chain security:\n- **Commit your `package-lock.json` or `yarn.lock`** to version control — it records integrity hashes (SHA-512) for all dependencies, ensuring reproducible and tamper-evident installs\n- **Use `npm ci`** in CI environments for deterministic builds from the lockfile\n\n## License\n\nThe library is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n### The MIT License (MIT)\n\n*Copyright (c) 2016 ChartMogul Ltd.*\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","readmeFilename":"README.md"}
![](\"https://user-images.githubusercontent.com/5329361/42206299-021e4184-7ea7-11e8-8160-8ecd5d9948b8.png\")
\n![\"npm](\"https://badge.fury.io/js/chartmogul-node.svg\"){kind=icon}
\n