PHPackages                             chartmogul/chartmogul-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. chartmogul/chartmogul-php

ActiveLibrary[API Development](/categories/api)

chartmogul/chartmogul-php
=========================

ChartMogul API PHP Client

v6.10.0(2mo ago)181.4M↑20.2%20[5 issues](https://github.com/chartmogul/chartmogul-php/issues)[2 PRs](https://github.com/chartmogul/chartmogul-php/pulls)MITPHPPHP >=7.1CI passing

Since Oct 26Pushed 1mo ago32 watchersCompare

[ Source](https://github.com/chartmogul/chartmogul-php)[ Packagist](https://packagist.org/packages/chartmogul/chartmogul-php)[ RSS](/packages/chartmogul-chartmogul-php/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (26)Versions (64)Used By (0)

[![](https://user-images.githubusercontent.com/5329361/42206299-021e4184-7ea7-11e8-8160-8ecd5d9948b8.png)](https://chartmogul.com)

### Official ChartMogul API PHP Client

[](#official-chartmogul-api-php-client)

`chartmogul-php` provides convenient PHP bindings for [ChartMogul's API](https://dev.chartmogul.com).

 [![](https://camo.githubusercontent.com/abe152337ee3073f90c3e0c6be70749a7b09a8f3ffef93030ae74d274ab69bf1/687474703a2f2f706f7365722e707567782e6f72672f63686172746d6f67756c2f63686172746d6f67756c2d7068702f76)](https://packagist.org/packages/chartmogul/chartmogul-php) [![Build Status](https://github.com/chartmogul/chartmogul-php/actions/workflows/test.yml/badge.svg)](#)

---

**[Installation](#installation)**| **[Configuration](#configuration)**| **[Usage](#usage)**| **[Development](#development)**| **[Contributing](#contributing)**| **[License](#license)**

---

Installation
------------

[](#installation)

This library requires php 5.5 or above.

For older php versions (`< 7.4`) use `1.x.x` releases of this library.

For php version `>=7.4` use the latest releases (`5.x.x`) of the library

The library doesn't depend on any concrete HTTP client libraries. Follow the instructions [here](http://docs.php-http.org/en/latest/httplug/users.html) to find out how to include a HTTP client.

Here's an example with `Guzzle HTTP client`:

```
composer require chartmogul/chartmogul-php:^5.0 php-http/guzzle7-adapter:^1.0 http-interop/http-factory-guzzle:^1.0
```

Configuration
-------------

[](#configuration)

Setup the default configuration with your ChartMogul api key:

```
require('./vendor/autoload.php');

ChartMogul\Configuration::getDefaultConfiguration()
    ->setApiKey('');
```

### Test your authentication

[](#test-your-authentication)

```
print_r(ChartMogul\Ping::ping()->data);
```

Usage
-----

[](#usage)

```
try {
  $dataSources = ChartMogul\DataSource::all();
} catch(\ChartMogul\Exceptions\ForbiddenException $e){
  // handle authentication exception
} catch(\ChartMogul\Exceptions\ChartMogulException $e){
    echo $e->getResponse();
    echo $e->getStatusCode();
}

$ds = $dataSources->first();
var_dump($ds->uuid); // access Datasource properties
$dsAsArray = $ds->toArray(); // convert to array
$ds->destroy();
```

All array results are wrapped with [`Doctrine\Common\Collections\ArrayCollection`](http://www.doctrine-project.org/api/common/2.3/class-Doctrine.Common.Collections.ArrayCollection.html) for ease of access. See [Exceptions](#exceptions) for a list of exceptions thrown by this library.

Available methods in Import API:

### [Data Sources](https://dev.chartmogul.com/reference/sources/)

[](#data-sources)

**Create Datasources**

```
$ds = ChartMogul\DataSource::create([
  'name' => 'In-house Billing'
]);
```

**Get a Datasource**

```
ChartMogul\DataSource::retrieve($uuid);
```

Include extra fields:

```
ChartMogul\DataSource::retrieve($uuid, [
    'with_processing_status' => true,
    'with_auto_churn_subscription_setting' => true,
    'with_invoice_handling_setting' => true
]);
```

**List Datasources**

```
ChartMogul\DataSource::all();
```

Include extra fields:

```
ChartMogul\DataSource::all([
    'with_processing_status' => true,
    'with_auto_churn_subscription_setting' => true,
    'with_invoice_handling_setting' => true
]);
```

**Delete a Datasource**

```
$dataSources = ChartMogul\DataSource::all();
$ds = $dataSources->last();
$ds->destroy();
```

### Customers

[](#customers)

**Import a Customer**

```
ChartMogul\Customer::create([
    "data_source_uuid" => $ds->uuid,
    "external_id" => "cus_0003",
    "name" => "Adam Smith",
    "email" => "adam@smith.com",
    "country" => "US",
    "city" => "New York",
    "lead_created_at" => "2016-10-01T00:00:00.000Z",
    "free_trial_started_at" => "2016-11-02T00:00:00.000Z"
]);
```

**List Customers**

```
ChartMogul\Customer::all([
  'page' => 1,
  'data_source_uuid' => $ds->uuid
]);
```

**Find Customer By External ID**

```
ChartMogul\Customer::findByExternalId([
    "data_source_uuid" => "ds_fef05d54-47b4-431b-aed2-eb6b9e545430",
    "external_id" => "cus_0001"
]);
```

**Delete A Customer**

```
$cus = ChartMogul\Customer::all()->last();
$cus->destroy();
```

**Get a Customer**

```
ChartMogul\Customer::retrieve($uuid);
```

**Search for Customers**

```
ChartMogul\Customer::search('adam@smith.com');
```

**Merge Customers**

```
ChartMogul\Customer::merge([
    'customer_uuid' => $cus1->uuid
], [
    'customer_uuid' => $cus2->uuid
]);

// alternatively:
ChartMogul\Customer::merge([
    'external_id' => $cus1->external_id,
    'data_source_uuid' => $ds->uuid
        ], [
    'external_id' => $cus2->external_id,
    'data_source_uuid' => $ds->uuid
]);
```

**Unmerge Customers**

```
ChartMogul\Customer::unmerge(
    $cus->uuid,
    $cus->external_id,
    $ds->uuid,
    ["tasks", "opportunities", "notes"]
);
```

**Update a Customer**

```
$result = ChartMogul\Customer::update([
    'customer_uuid' => $cus1->uuid
        ], [
    'name' => 'New Name'
]);
```

**Connect Subscriptions**

```
ChartMogul\Customer::connectSubscriptions("cus_5915ee5a-babd-406b-b8ce-d207133fb4cb", [
    "subscriptions" => [
        [
            "data_source_uuid" => "ds_ade45e52-47a4-231a-1ed2-eb6b9e541213",
            "external_id" => "d1c0c885-add0-48db-8fa9-0bdf5017d6b0",
        ],
        [
            "data_source_uuid" => "ds_ade45e52-47a4-231a-1ed2-eb6b9e541213",
            "external_id" => "9db5f4a1-1695-44c0-8bd4-de7ce4d0f1d4",
        ],
    ]
]);
```

OR (Recommended)

```
use ChartMogul\Metrics\Customers\Subscription;

// Fetch customer subscriptions
$subscriptions = $customer->subscriptions();

// Connect subscriptions
Subscription::connect(
    "ds_ade45e52-47a4-231a-1ed2-eb6b9e541213",  // data source UUID
    "cus_5915ee5a-babd-406b-b8ce-d207133fb4cb",  // customer UUID
    $subscriptions->entries  // array of Subscription objects
);
```

OR (Deprecated)

```
$subscription1->connect("cus_5915ee5a-babd-406b-b8ce-d207133fb4cb", $subscriptions);
```

**Disconnect Subscriptions**

```
ChartMogul\Customer::disconnectSubscriptions("cus_5915ee5a-babd-406b-b8ce-d207133fb4cb", [
    "subscriptions" => [
        [
            "data_source_uuid" => "ds_ade45e52-47a4-231a-1ed2-eb6b9e541213",
            "external_id" => "d1c0c885-add0-48db-8fa9-0bdf5017d6b0",
        ],
        [
            "data_source_uuid" => "ds_ade45e52-47a4-231a-1ed2-eb6b9e541213",
            "external_id" => "9db5f4a1-1695-44c0-8bd4-de7ce4d0f1d4",
        ],
    ]
]);
```

OR (Recommended)

```
use ChartMogul\Metrics\Customers\Subscription;

// Fetch customer subscriptions
$subscriptions = $customer->subscriptions();

// Disconnect subscriptions
Subscription::disconnect(
    "ds_ade45e52-47a4-231a-1ed2-eb6b9e541213",  // data source UUID
    "cus_5915ee5a-babd-406b-b8ce-d207133fb4cb",  // customer UUID
    $subscriptions->entries  // array of Subscription objects
);
```

OR (Deprecated)

```
$subscription1->disconnect("cus_5915ee5a-babd-406b-b8ce-d207133fb4cb", $subscriptions);
```

#### Customer Attributes

[](#customer-attributes)

**Retrieve Customer's Attributes**

```
$customer = ChartMogul\Customer::retrieve($cus->uuid);
$customer->attributes;
```

#### Tags

[](#tags)

**Add Tags to a Customer**

```
$customer = ChartMogul\Customer::retrieve($cus->uuid);
$tags = $customer->addTags("important", "Prio1");
```

**Add Tags Using Array (Alternative)**

```
$customer = ChartMogul\Customer::retrieve($cus->uuid);
$tagsArray = ["important", "Prio1", "enterprise"];
$tags = $customer->addTags($tagsArray);
```

**Add Tags to Customers with email**

```
$customers = ChartMogul\Customer::search('adam@smith.com');

foreach ($customers->entries as $customer) {
    $customer->addTags('foo', 'bar', 'baz');
}
```

**Remove Tags from a Customer**

```
$customer = ChartMogul\Customer::retrieve($cus->uuid);
$tags = $customer->removeTags("important", "Prio1");
```

**Remove Tags Using Array (Alternative)**

```
$customer = ChartMogul\Customer::retrieve($cus->uuid);
$tagsToRemove = ["important", "Prio1"];
$tags = $customer->removeTags($tagsToRemove);
```

#### Custom Attributes

[](#custom-attributes)

**Add Custom Attributes to a Customer**

```
$customer = ChartMogul\Customer::retrieve($cus->uuid);
$custom = $customer->addCustomAttributes(
    ['type' => 'String', 'key' => 'channel', 'value' => 'Facebook'],
    ['type' => 'Integer', 'key' => 'age', 'value' => 8 ]
);
```

**Add Custom Attributes Using Array (Alternative)**

```
$customer = ChartMogul\Customer::retrieve($cus->uuid);

// Build attributes array dynamically
$attributes = [];
if (!empty($channel)) {
    $attributes[] = ['type' => 'String', 'key' => 'channel', 'value' => $channel];
}
if (!empty($age)) {
    $attributes[] = ['type' => 'Integer', 'key' => 'age', 'value' => $age];
}

$custom = $customer->addCustomAttributes($attributes);
```

**Add Custom Attributes to Customers with email**

```
$customers = ChartMogul\Customer::search('adam@smith.com');

foreach ($customers->entries as $customer) {
    $customer->addCustomAttributes(
        ['type' => 'String', 'key' => 'channel', 'value' => 'Facebook'],
        ['type' => 'Integer', 'key' => 'age', 'value' => 8 ]
    );
}
```

**Update Custom Attributes of a Customer**

```
$customer = ChartMogul\Customer::retrieve($cus->uuid);
$custom = $customer->updateCustomAttributes(
    ['type' => 'String', 'key' => 'channel', 'value' => 'Twitter'],
    ['type' => 'Integer', 'key' => 'age', 'value' => 18]
);
```

**Update Custom Attributes Using Array (Alternative)**

```
$customer = ChartMogul\Customer::retrieve($cus->uuid);
$attributeUpdates = [
    ['type' => 'String', 'key' => 'channel', 'value' => 'Twitter'],
    ['type' => 'Integer', 'key' => 'age', 'value' => 18]
];
$custom = $customer->updateCustomAttributes($attributeUpdates);
```

**Remove Custom Attributes from a Customer**

```
$customer = ChartMogul\Customer::retrieve($cus->uuid);
$tags = $customer->removeCustomAttributes("age", "channel");
```

**Remove Custom Attributes Using Array (Alternative)**

```
$customer = ChartMogul\Customer::retrieve($cus->uuid);
$attributesToRemove = [
    ['key' => 'age'],
    ['key' => 'channel']
];
$tags = $customer->removeCustomAttributes($attributesToRemove);
```

**List Contacts from a customer**

```
$customer = ChartMogul\Customer::retrieve($uuid);
$contacts = $customer->contacts([
  'cursor' => 'aabbccdd...'
]);
```

**Create a Contact from a customer**

```
$customer = ChartMogul\Customer::retrieve($uuid);
$new_customer = $customer->createContact([
  "data_source_uuid" => "ds_00000000-0000-0000-0000-000000000000",
  "first_name" => "Adam",
  "last_name" => "Smith",
]);
```

**List Customer Notes from a customer**

```
$customer = ChartMogul\Customer::retrieve($uuid);
$customer_notes = $customer->notes([
  'cursor' => 'aabbccdd...'
]);
```

**Create a Customer Note from a customer**

```
$customer = ChartMogul\Customer::retrieve($uuid);
$new_customer_note = $customer->createNote([
  'type' => 'note',
  'text' => 'This is a note'
]);
```

**List Opportunities from a customer**

```
$customer = ChartMogul\Customer::retrieve($uuid);
$opportunities = $customer->opportunities([
  'cursor' => 'aabbccdd...'
]);
```

**Create an Opportunity from a customer**

```
$customer = ChartMogul\Customer::retrieve($uuid);
$new_opportunity = $customer->createOpportunity([
  'owner' => 'owner@example.com',
  'pipeline' => 'Sales',
  'pipeline_stage' => 'Qualified',
  'estimated_close_date' => '2022-03-30',
  'currency' => 'USD',
  'amount_in_cents' => 10000,
  'type' => 'one-time',
  'forecast_category' => 'Best Case',
  'win_likelihood' => 80,
  'custom' => [{key: 'custom_key', value: 'custom_value'}]
]);
```

**List Tasks for a customer**

```
$customer = ChartMogul\Customer::retrieve($customer_uuid);
$tasks = $customer->tasks([
  'cursor' => 'aabbccdd...'
]);
```

**Create a Task for a customer**

```
$customer = ChartMogul\Customer::retrieve($customer_uuid);
$new_task = $customer->createTask([
  'assignee' => 'customer@example.com',
  'task_details' => 'This is some task details text.',
  'due_date' => '2025-04-30T00:00:00Z',
  'completed_at' => '2025-04-20T00:00:00Z',
]);
```

### Customer Notes

[](#customer-notes)

**List Customer Notes**

```
$customer_notes = ChartMogul\CustomerNote::all([
    'customer_uuid' => $uuid,
    'cursor' => 'aabbccdd...'
])
```

**Create a Customer Note**

```
$customer_note = ChartMogul\CustomerNote::create([
    'customer_uuid': $uuid,
    'type' => 'note',
    'text' => 'This is a note'
])
```

**Get a Customer Note**

```
$customer_note = ChartMogul\CustomerNote::retrieve($note_uuid)
```

**Update a Customer Note**

```
$updated_customer_note = ChartMogul\CustomerNote::update($note_uuid, [
  'text' => 'This is a new note'
]);
```

**Delete a Customer Note**

```
$customer_note = ChartMogul\CustomerNote::retrieve($note_uuid)
$customer_note->destroy();
```

### Contacts

[](#contacts)

**List Contacts**

```
$contacts = ChartMogul\Contacts::all([
  'cursor' => 'aabbccdd...'
]);
```

**Create a Contact**

```
$new_contact = ChartMogul\Contact::create([
  "customer_uuid" => "cus_00000000-0000-0000-0000-000000000000",
  "data_source_uuid" => "ds_00000000-0000-0000-0000-000000000000",
  "first_name" => "Adam",
  "last_name" => "Smith",
]);
```

**Get a Contact**

```
$contact = ChartMogul\Contact::retrieve($uuid);
```

**Delete A Contact**

```
$contact = ChartMogul\Contact::retrieve($uuid);
$contact->destroy();
```

**Update a Contact**

```
$updated_contact = ChartMogul\Contact::update([
    'contact_uuid' => $uuid
        ], [
    'first_name' => 'New Name'
]);
```

**Merge Contacts**

```
$merged_contact = ChartMogul\Contact::merge($into_contact_uuid, $from_contact_uuid);
```

### Opportunities

[](#opportunities)

**List Opportunities**

```
$opportunities = ChartMogul\Opportunity::all([
    'cursor' => 'aabbccdd...'
])
```

**Create an Opportunity**

```
$opportunity = ChartMogul\Opportunity::create([
    'customer_uuid' => $uuid,
    'owner' => 'test1@example.org',
    'pipeline' => 'New business 1',
    'pipeline_stage' => 'Discovery',
    'estimated_close_date' => '2023-12-22',
    'currency' => 'USD',
    'amount_in_cents' => 100,
    'type' => 'recurring',
    'forecast_category' => 'pipeline',
    'win_likelihood' => 3,
    'custom' => [{ 'key': 'from_campaign', 'value': true }]
])
```

**Get an Opportunity**

```
$opportunity = ChartMogul\Opportunity::retrieve($opportunity_uuid)
```

**Update an Opportunity**

```
$updated_opportunity = ChartMogul\Opportunity::update($opportunity_uuid, [
  'estimated_close_date' => '2024-12-22',
]);
```

**Delete an Opportunity**

```
$opportunity = ChartMogul\Opportunity::retrieve($opportunity_uuid)
$opportunity->destroy();
```

### Tasks

[](#tasks)

**List Tasks**

```
$tasks = ChartMogul\Task::all([
    'customer_uuid' => $customer_uuid,
    'cursor' => 'aabbccdd...'
])
```

**Create a Task**

```
$task = ChartMogul\Task::create([
    'customer_uuid' => $customer_uuid,
    'task_details' => 'This is some task details text.',
    'assignee' => 'customer@example.com',
    'due_date' => '2025-04-30T00:00:00Z',
    'completed_at' => '2025-04-20T00:00:00Z',
])
```

**Get a Task**

```
$task = ChartMogul\Task::retrieve($task_uuid)
```

**Update a Task**

```
$updated_task = ChartMogul\Task::update($task_uuid, [
  'task_details' => 'This is some other task details text.'
]);
```

**Delete a Task**

```
$task = ChartMogul\Task::retrieve($task_uuid)
$task->destroy();
```

### Plans

[](#plans)

**Import a Plan**

```
ChartMogul\Plan::create([
    "data_source_uuid" => $ds->uuid,
    "name" => "Bronze Plan",
    "interval_count" => 1,
    "interval_unit" => "month",
    "external_id" => "plan_0001"
]);
```

**Get a Plan by UUID**

```
ChartMogul\Plan::retrieve($uuid);
```

**List Plans**

```
$plans = ChartMogul\Plan::all([
  'page' => 1
]);
```

**Delete A Plan**

```
$plan = ChartMogul\Plan::all()->last();
$plan->destroy();
```

**Update A Plan**

```
$plan = ChartMogul\Plan::update(["plan_uuid" => $plan->uuid], [
            "name" => "Bronze Monthly Plan",
            "interval_count" => 1,
            "interval_unit" => "month"
]);
```

### Subscription Events

[](#subscription-events)

**List Subscriptions Events**

```
$subscription_events = ChartMogul\SubscriptionEvent::all();
```

**Create Subscription Event**

```
ChartMogul\SubscriptionEvent::create(['subscription_event' => [
    "external_id" => "evnt_026",
    "customer_external_id" => "cus_0003",
    "data_source_uuid" => $ds->uuid,
    "event_type" => "subscription_start_scheduled",
    "event_date" => "2022-03-30",
    "effective_date" => "2022-04-01",
    "subscription_external_id" => "sub_0001",
    "plan_external_id" => "plan_0001",
    "currency" => "USD",
    "amount_in_cents" => 1000
    "quantity" => 1
]]);
```

**Delete Subscription Event**

```
ChartMogul\SubscriptionEvent::destroyWithParams(['subscription_event' => [
    "id" => "some_event_id"
]]);
```

**Update Subscription Event**

```
ChartMogul\SubscriptionEvent::updateWithParams(['subscription_event' => [
    "id" => "some_event_id",
    "currency" => "EUR",
    "amount_in_cents" => "100"
]]);
```

### Plan Groups

[](#plan-groups)

**Create a Plan Group**

```
ChartMogul\PlanGroup::create([
    "name" => "Bronze Plan",
    "plans" => [$plan_uuid_1, $plan_uuid_2],
]);
```

**Get a Plan Group by UUID**

```
ChartMogul\PlanGroup::retrieve($uuid);
```

**List Plan Groups**

```
$plan_groups = ChartMogul\PlanGroup::all([
  'page' => 1
]);
```

**Delete A Plan Group**

```
$plan_group = ChartMogul\PlanGroup::all()->last();
$plan_group->destroy();
```

**Update A Plan Group**

```
$plan_group = ChartMogul\PlanGroup::update(
  ["plan_group_uuid" => $plan_group->uuid],
  [
  "name" => "A new plan group name",
  "plans" => [$plan_uuid_1, $plan_uuid_2]
]);
```

**List Plans In A Plan Group**

```
$plan_group_plans = ChartMogul\PlanGroups\Plan::all(
  ["plan_group_uuid" => $plan_group->uuid]
);
```

### Invoices

[](#invoices)

**Import Invoices**

```
$plan = ChartMogul\Plan::all()->first();
$cus = ChartMogul\Customer::all()->first();

$line_item_1 = new ChartMogul\LineItems\Subscription([
    'subscription_external_id' => "sub_0001",
    'subscription_set_external_id' => 'set_0001',
    'plan_uuid' =>  $plan->uuid,
    'service_period_start' =>  "2015-11-01 00:00:00",
    'service_period_end' =>  "2015-12-01 00:00:00",
    'amount_in_cents' => 5000,
    'quantity' => 1,
    'discount_code' => "PSO86",
    'discount_amount_in_cents' => 1000,
    'tax_amount_in_cents' => 900,
    'transaction_fees_currency' => "EUR",
    'discount_description' => "5 EUR"
]);

$line_item_2 = new ChartMogul\LineItems\OneTime([
    "description" => "Setup Fees",
    "amount_in_cents" => 2500,
    "quantity" => 1,
    "discount_code" => "PSO86",
    "discount_amount_in_cents" => 500,
    "tax_amount_in_cents" => 450,
    "transaction_fees_currency" => "EUR",
    "discount_description" => "2 EUR"
]);

$transaction = new ChartMogul\Transactions\Payment([
    "date" => "2015-11-05T00:14:23.000Z",
    "result" => "successful"
]);

$invoice = new ChartMogul\Invoice([
    'external_id' => 'INV0001',
    'date' =>  "2015-11-01 00:00:00",
    'currency' => 'USD',
    'due_date' => "2015-11-15 00:00:00",
    'line_items' => [$line_item_1, $line_item_2],
    'transactions' => [$transaction]
]);

$ci = ChartMogul\CustomerInvoices::create([
    'customer_uuid' => $cus->uuid,
    'invoices' => [$invoice]
]);
```

**List Customer Invoices**

```
$ci = ChartMogul\CustomerInvoices::all([
    'customer_uuid' => $cus->uuid,
    'page' => 1,
    'per_page' => 200
]);
```

**List Invoices**

```
$invoices = ChartMogul\Invoice::all([
    'external_id' => 'my_invoice',
    'page' => 1,
    'per_page' => 200
]);
```

**Retrieve an Invoice**

```
$invoice = ChartMogul\Invoice::retrieve('inv_uuid');
```

### Transactions

[](#transactions)

**Create a Transaction**

```
ChartMogul\Transactions\Refund::create([
    "invoice_uuid" => $ci->invoices[0]->uuid,
    "date" => "2015-12-25 18:10:00",
    "result" => "successful"
]);
```

The same can be done with Payment class.

### Subscriptions

[](#subscriptions)

**List Customer Subscriptions**

```
$subscriptions = $cus->subscriptions();
```

**Note:** The following methods are deprecated. Use `ChartMogul\Metrics\Customers\Subscription::connect()` and `ChartMogul\Metrics\Customers\Subscription::disconnect()` instead. See the Connect/Disconnect Subscriptions section above for recommended usage.

**Cancel Customer Subscriptions**

```
$subscription = new ChartMogul\Subscription(["uuid" => $subsUUID])
// or use some existing instance of subsctiption, eg. fetched from Customer->subscriptions
$canceldate = '2016-01-01T10:00:00.000Z';
$subscription->cancel($canceldate);
```

Or set the cancellation dates:

```
$subscription = new ChartMogul\Subscription(["uuid" => $subsUUID])
$cancellationDates = ['2016-01-01T10:00:00.000Z', '2017-01-01T10:00:00.000Z']
$subscription->setCancellationDates($cancellationDates)
```

### Metrics API

[](#metrics-api)

**Retrieve all key metrics**

```
ChartMogul\Metrics::all([
    'start-date' => '2015-01-01',
    'end-date' => '2015-11-24',
    'interval' => 'month',
    'geo' => 'GB',
    'plans' => $plan->name,
    'filters' => "currency~ANY~'USD'"
]);
```

**Retrieve MRR**

```
ChartMogul\Metrics::mrr([
    'start-date' => '2015-01-01',
    'end-date' => '2015-11-24',
    'interval' => 'month',
    'geo' => 'GB',
    'plans' => $plan->name,
    'filters' => "currency~ANY~'USD'"
]);
```

**Retrieve ARR**

```
ChartMogul\Metrics::arr([
    'start-date' => '2015-01-01',
    'end-date' => '2015-11-24',
    'interval' => 'month'
]);
```

**Retrieve Average Revenue Per Account (ARPA)**

```
ChartMogul\Metrics::arpa([
    'start-date' => '2015-01-01',
    'end-date' => '2015-11-24',
    'interval' => 'month'
]);
```

**Retrieve Average Sale Price (ASP)**

```
ChartMogul\Metrics::asp([
    'start-date' => '2015-01-01',
    'end-date' => '2015-11-24',
    'interval' => 'month',
]);
```

**Retrieve Customer Count**

```
ChartMogul\Metrics::customerCount([
    'start-date' => '2015-01-01',
    'end-date' => '2015-11-24',
    'interval' => 'month',
]);
```

**Retrieve Customer Churn Rate**

```
ChartMogul\Metrics::customerChurnRate([
    'start-date' => '2015-01-01',
    'end-date' => '2015-11-24',
]);
```

**Retrieve MRR Churn Rate**

```
ChartMogul\Metrics::mrrChurnRate([
    'start-date' => '2015-01-01',
    'end-date' => '2015-11-24',
]);
```

**Retrieve LTV**

```
ChartMogul\Metrics::ltv([
    'start-date' => '2015-01-01',
    'end-date' => '2015-11-24',
]);
```

**List Customer Subscriptions**

```
ChartMogul\Metrics\Customers\Subscriptions::all([
    "customer_uuid" => $cus->uuid
]);
```

**List Customer Activities**

```
ChartMogul\Metrics\Customers\Activities::all([
    "customer_uuid" => $cus->uuid
]);
```

**List Activities**

```
ChartMogul\Metrics\Activities::all([
    'start-date' => '2020-06-02T00:00:00Z',
    'per-page' => 100
]);

**Create an Activities Export**

```php
ChartMogul\Metrics\ActivitiesExport::create([
    'start-date' => '2020-06-02T00:00:00Z',
    'end-date' =>  '2021-06-02T00:00:00Z'
    'type' => 'churn'
]);
```

**Retrieve an Activities Export**

```
$id = '7f554dba-4a41-4cb2-9790-2045e4c3a5b1';
ChartMogul\Metrics\ActivitiesExport::retrieve($id);
```

### Account

[](#account)

**Retrieve Account Details**

```
ChartMogul\Account::retrieve();
```

### Exceptions

[](#exceptions)

The library throws following Exceptions:

- `ChartMogul\Exceptions\ChartMogulException`
- `ChartMogul\Exceptions\ConfigurationException`
- `ChartMogul\Exceptions\ForbiddenException`
- `ChartMogul\Exceptions\NetworkException`
- `ChartMogul\Exceptions\NotFoundException`
- `ChartMogul\Exceptions\ResourceInvalidException`
- `ChartMogul\Exceptions\SchemaInvalidException`

The following table describes the public methods of the error object.

MethodsTypeDescription`getMessage()`stringThe error message`getStatusCode()`numberWhen the error occurs during an HTTP request, the HTTP status code.`getResponse()`array or stringHTTP response as array, or raw response if not parsable to array### Rate Limits &amp; Exponential Backoff

[](#rate-limits--exponential-backoff)

The library will keep retrying if the request exceeds the rate limit or if there's any network related error. By default, the request will be retried for 20 times (approximated 15 minutes) before finally giving up.

You can change the retry count using `Configuration` object:

```
ChartMogul\Configuration::getDefaultConfiguration()
    ->setApiKey('')
    ->setRetries(15); //0 disables retrying
```

Development
-----------

[](#development)

You need `Docker` installed locally to use our `Makefile` workflow.

- Fork it.
- Create your feature branch (`git checkout -b my-new-feature`).
- Install dependencies: `make build`.
- Install Composer vendor dependencies with `make composer install`
- Write tests for your new features. Run tests and check test coverage with `make test`.
- To run any composer commands or php scripts, use `make composer ` or `make php `.
- If all tests are passed, push to the branch (`git push origin my-new-feature`).
- Create a new Pull Request.

Contributing
------------

[](#contributing)

Bug reports and pull requests are welcome on GitHub at .

License
-------

[](#license)

The library is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

### The MIT License (MIT)

[](#the-mit-license-mit)

*Copyright (c) 2019 ChartMogul Ltd.*

Permission 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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE 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.

###  Health Score

63

—

FairBetter than 99% of packages

Maintenance83

Actively maintained with recent releases

Popularity51

Moderate usage in the ecosystem

Community34

Small or concentrated contributor base

Maturity72

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~59 days

Recently: every ~80 days

Total

59

Last Release

63d ago

Major Versions

1.x-dev → 2.2.02020-02-26

2.2.4 → 3.0.02021-01-08

3.1.0 → 4.0.02021-06-30

v4.9.0 → v5.0.02021-11-09

v5.1.3 → v6.0.02023-10-31

PHP version history (5 changes)1.0.0PHP &gt;=5.4

1.0.1PHP &gt;=5.5

2.0.0PHP ^7.1

4.1.0PHP ^7.1 | ^8.0

v5.0.2PHP &gt;=7.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/3ac163a2dd17e122788d8ea5cdb621e9ddfa55657ff306b69bac1a36df52b427?d=identicon)[chartmogul](/maintainers/chartmogul)

![](https://www.gravatar.com/avatar/901e1c7fe325b12270f339d2d0d0bd6fb6e18dd4ad6137340a4bdf9a7e7ded5f?d=identicon)[srikala](/maintainers/srikala)

![](https://www.gravatar.com/avatar/12e83b47585984c9119890e265e815850e0c54ab3f4b96c8383ab2244d7f90a8?d=identicon)[jhearn](/maintainers/jhearn)

![](https://www.gravatar.com/avatar/21afc0714fe9cf8917c469854a297ad703e2a4425c48d4accfd198b5ce6459c4?d=identicon)[keith-chartmogul](/maintainers/keith-chartmogul)

![](https://www.gravatar.com/avatar/9bddf1ce989cc43421545764b654443be2898d8394d4537f934c482a713cd607?d=identicon)[wiktor\_plaga\_chartmogul](/maintainers/wiktor_plaga_chartmogul)

---

Top Contributors

[![pkopac](https://avatars.githubusercontent.com/u/5329361?v=4)](https://github.com/pkopac "pkopac (55 commits)")[![hassansin](https://avatars.githubusercontent.com/u/4618044?v=4)](https://github.com/hassansin "hassansin (15 commits)")[![SrikalaB](https://avatars.githubusercontent.com/u/8254253?v=4)](https://github.com/SrikalaB "SrikalaB (6 commits)")[![swember](https://avatars.githubusercontent.com/u/4442395?v=4)](https://github.com/swember "swember (5 commits)")[![VincentLanglet](https://avatars.githubusercontent.com/u/9052536?v=4)](https://github.com/VincentLanglet "VincentLanglet (5 commits)")[![wscourge](https://avatars.githubusercontent.com/u/16985871?v=4)](https://github.com/wscourge "wscourge (4 commits)")[![gjuric](https://avatars.githubusercontent.com/u/223015?v=4)](https://github.com/gjuric "gjuric (4 commits)")[![bilbof](https://avatars.githubusercontent.com/u/8124374?v=4)](https://github.com/bilbof "bilbof (3 commits)")[![jessicahearn](https://avatars.githubusercontent.com/u/3497171?v=4)](https://github.com/jessicahearn "jessicahearn (3 commits)")[![briwa](https://avatars.githubusercontent.com/u/8046636?v=4)](https://github.com/briwa "briwa (3 commits)")[![twoleds](https://avatars.githubusercontent.com/u/614302?v=4)](https://github.com/twoleds "twoleds (3 commits)")[![ytvinay](https://avatars.githubusercontent.com/u/53569?v=4)](https://github.com/ytvinay "ytvinay (2 commits)")[![dina920](https://avatars.githubusercontent.com/u/74310850?v=4)](https://github.com/dina920 "dina920 (2 commits)")[![keith-chartmogul](https://avatars.githubusercontent.com/u/112698605?v=4)](https://github.com/keith-chartmogul "keith-chartmogul (2 commits)")[![sbrych](https://avatars.githubusercontent.com/u/2489575?v=4)](https://github.com/sbrych "sbrych (2 commits)")[![slepic](https://avatars.githubusercontent.com/u/8199404?v=4)](https://github.com/slepic "slepic (2 commits)")[![SoeunSona](https://avatars.githubusercontent.com/u/78331453?v=4)](https://github.com/SoeunSona "SoeunSona (2 commits)")[![ya-petrov-evgeniy](https://avatars.githubusercontent.com/u/7044774?v=4)](https://github.com/ya-petrov-evgeniy "ya-petrov-evgeniy (2 commits)")[![ftipalek](https://avatars.githubusercontent.com/u/847951?v=4)](https://github.com/ftipalek "ftipalek (1 commits)")[![spyrbri](https://avatars.githubusercontent.com/u/3419713?v=4)](https://github.com/spyrbri "spyrbri (1 commits)")

###  Code Quality

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/chartmogul-chartmogul-php/health.svg)

```
[![Health](https://phpackages.com/badges/chartmogul-chartmogul-php/health.svg)](https://phpackages.com/packages/chartmogul-chartmogul-php)
```

###  Alternatives

[openai-php/client

OpenAI PHP is a supercharged PHP API client that allows you to interact with the Open AI API

5.8k22.6M232](/packages/openai-php-client)[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M651](/packages/sylius-sylius)[getbrevo/brevo-php

Official Brevo provided RESTFul API V3 php library

963.1M35](/packages/getbrevo-brevo-php)[swisnl/json-api-client

A PHP package for mapping remote JSON:API resources to Eloquent like models and collections.

211473.2k12](/packages/swisnl-json-api-client)[wordpress/php-ai-client

A provider agnostic PHP AI client SDK to communicate with any generative AI models of various capabilities using a uniform API.

26236.6k14](/packages/wordpress-php-ai-client)[telnyx/telnyx-php

Official Telnyx PHP SDK — APIs for Voice, SMS, MMS, WhatsApp, Fax, SIP Trunking, Wireless IoT, Call Control, and more. Build global communications on Telnyx's private carrier-grade network.

35636.1k2](/packages/telnyx-telnyx-php)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)