Chargebee PHP Client Library - API V2

This is the PHP Library for integrating with Chargebee. Sign up for a Chargebee account here.

Chargebee now supports two API versions - V1 and V2, of which V2 is the latest release and all future developments will happen in V2. This library is for API version V2. If you’re looking for V1, head to chargebee-v1 branch.

Requirements

PHP 5.6.0 or later

Installation

Composer

Chargebee is available on Packagist and can be installed using Composer

composer require chargebee/chargebee-php

To use the bindings,

require_once('vendor/autoload.php');

Manual Installation

Download the latest release and to use the bindings, include init.php file.

require_once('/path/to/chargebee-php/lib/init.php');

Documentation

• API Reference

Usage

To create a new subscription:

use ChargeBee\ChargeBee\Environment;
use ChargeBee\ChargeBee\Subscription;

Environment::configure("your_site", "{your_site_api_key}");
$result = Subscription::create([
    "id" => "__dev__KyVqH3NW3f42fD",
    "planId" => "starter",
    "customer" => [
        "email" => "john@user.com",
        "firstName" => "John",
        "lastName" => "Wayne"
    ]
]);
$subscription = $result->subscription();
$customer = $result->customer();
$card = $result->card();

Create an idempotent request

Idempotency keys are passed along with request headers to allow a safe retry of POST requests.

use ChargeBee\ChargeBee\Environment;
use ChargeBee\ChargeBee\Models\Customer;

Environment::configure("your_site", "{your_site_api_key}");
$result = Customer::create(array(
    "email" => "john@test.com",
    "first_name" => "john"
    ), 
    null, 
    array(
        "chargebee-idempotency-key" => "<<UUID>>"
        )
    ); // Replace <<UUID>> with a unique string
$customer = $result->customer();
print_r($customer);

$responseHeaders = $result->getResponseHeaders(); // Retrieves response headers
print_r($responseHeaders);
$idempotencyReplayedValue = $result->isIdempotencyReplayed(); // Retrieves Idempotency replayed header value
print_r($idempotencyReplayedValue);

isIdempotencyReplayed() method can be accessed to differentiate between original and replayed requests.

Legacy Support

If you are using PHP < 5.6.0 , you can download chargebee-php v2.8.3. This version will not support recently added features since the version was released. We recommend you to upgrade PHP inorder to use the latest features.

License

See the LICENSE file.