chartmogul-php
provides convenient PHP bindings for ChartMogul's API.
Installation | Configuration | Usage | Development | Contributing | License
This library requires php 5.5 or above.
Using Composer:
composer require chartmogul/chartmogul-php
or in composer.json
:
{
"require": {
"chartmogul/chartmogul-php": "~1.1"
}
}
Setup the default configuration with your ChartMogul account token and secret key:
require('./vendor/autoload.php');
ChartMogul\Configuration::getDefaultConfiguration()
->setAccountToken('<YOUR_ACCOUNT_TOKEN>')
->setSecretKey('<YOUR_SECRET_KEY>');
print_r(ChartMogul\Ping::ping()->data);
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
for ease of access. See Exceptions for a list of exceptions thrown by this library.
Available methods in Import API:
Create Datasources
$ds = ChartMogul\DataSource::create([
'name' => 'In-house Billing'
]);
Get a Datasource
ChartMogul\DataSource::retrieve($uuid);
List Datasources
ChartMogul\DataSource::all();
Delete a Datasource
$dataSources = ChartMogul\DataSource::all();
$ds = $dataSources->last();
$ds->destroy();
Import a Customer
ChartMogul\Customer::create([
"data_source_uuid" => $ds->uuid,
"external_id" => "cus_0003",
"name" => "Adam Smith",
"email" => "[email protected]",
"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('[email protected]');
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
]);
Update a Customer
$result = ChartMogul\Customer::update([
'customer_uuid' => $cus1->uuid
], [
'name' => 'New Name'
]);
Retrieve Customer's Attributes
$customer = ChartMogul\Customer::retrieve($cus->uuid);
$customer->attributes;
Add Tags to a Customer
$customer = ChartMogul\Customer::retrieve($cus->uuid);
$tags = $customer->addTags("important", "Prio1");
Add Tags to Customers with email
$customers = ChartMogul\Customer::search('[email protected]');
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");
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 to Customers with email
$customers = ChartMogul\Customer::search('[email protected]');
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(
['channel' => 'Twitter'],
['age' => 18]
);
Remove Custom Attributes from a Customer
$customer = ChartMogul\Customer::retrieve($cus->uuid);
$tags = $customer->removeCustomAttributes("age", "channel");
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"
]);
Import Invoices
$plan = ChartMogul\Plan::all()->first();
$cus = ChartMogul\Customer::all()->first();
$line_itme_1 = new ChartMogul\LineItems\Subscription([
'subscription_external_id' => "sub_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
]);
$line_itme_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 = 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_itme_1, $line_itme_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');
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.
List Customer Subscriptions
$subscriptions = $cus->subscriptions();
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)
Retrieve all key metrics
ChartMogul\Metrics::all([
'start-date' => '2015-01-01',
'end-date' => '2015-11-24',
'interval' => 'month',
'geo' => 'GB',
'plans' => $plan->name
]);
Retrieve MRR
ChartMogul\Metrics::mrr([
'start-date' => '2015-01-01',
'end-date' => '2015-11-24',
'interval' => 'month',
'geo' => 'GB',
'plans' => $plan->name
]);
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\Subscriptions::all(
["customer_uuid" => $cus->uuid]
);
List Customer Activities
ChartMogul\Metrics\Activities::all(
["customer_uuid" => $cus->uuid]
);
The library throws following Exceptions:
ChartMogul\Exceptions\ChartMogulException
ChartMogul\Exceptions\ConfigurationException
ChartMogul\Exceptions\ForbiddenException
ChartMogul\Exceptions\NotFoundException
ChartMogul\Exceptions\ResourceInvalidException
ChartMogul\Exceptions\SchemaInvalidException
The following table describes the public methods of the error object.
Methods | Type | Description |
---|---|---|
getMessage() |
string | The error message |
getStatusCode() |
number | When the error occurs during an HTTP request, the HTTP status code. |
getResponse() |
array or string | HTTP response as array, or raw response if not parsable to array |
The library uses php-http/guzzle6-adapter
as the HTTP client. But you can use any HTTP client that implements php-http/client-implementation
virtual package. For example:
$config = new ChartMogul\Configuration('accountToken','secretKey');
$httpClient = new My\HttpClient();
$client = new ChartMogul\Http\Client($config, $httpClient);
customers = $ChartMogul\Customer::all([
'page' => 1,
'data_source_uuid' => $ds->uuid
], $client);
Learn more about this virtual package at here.
Find the full public API documentation here.
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
. - Fix bugs or add features. Make sure the changes pass the coding guidelines by runing PHP CodeSniffer:
make cs
. You can also runmake cbf
to fix some errors automatically. - Write tests for your new features. Run tests and check test coverage with
make test
. - Generate API documentation by running
make doc
. - To run any composer commands or php scripts, use
make composer <commands>
ormake php <script>
. - If all tests are passed, push to the branch (
git push origin my-new-feature
). - Create a new Pull Request.
Bug reports and pull requests are welcome on GitHub at https://github.com/chartmogul/chartmogul-php.
The library is available as open source under the terms of the MIT License.
Copyright (c) 2016 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.