petersuhm / chargify-sdk-php

Chargify SDK for PHP

Chargify SDK for PHP

This library helps you interact with the Chargify API using PHP. It has been used in production for many years by our flagship product, Chargley, a billing portal for Chargify.

• Abstracts away underlying HTTP requests to the Chargify API
• Supports Chargify API v1 and Chargify Direct (v2)
• Well documented
• Unit tested

Quick Example

Create a new customer.

<?php
require 'vendor/autoload.php';

use Crucial\Service\Chargify;

$chargify = new Chargify([
    'hostname'   => 'yoursubdomain.chargify.com',
    'api_key'    => '{{API_KEY}}',
    'shared_key' => '{{SHARED_KEY}}'
]);

// Crucial\Service\Chargify\Customer
$customer = $chargify->customer()
    // set customer properties
    ->setFirstName('Dan')
    ->setLastName('Bowen')
    ->setEmail('[e-mail]')
    // send the create request
    ->create();

// check for errors
if ($customer->isError()) {
    // array of errors loaded during the transfer
    $errors = $customer->getErrors();
 } else {
    // the transfer was successful
    $customerId = $customer['id']; // Chargify customer ID
    $firstName  = $customer['first_name'];
    $lastName   = $customer['last_name'];
    $email      = $customer['email'];
 }

Help and Documentation

• Documentation
• Issues

Installation

Using Composer is the recommended way to install the Chargify SDK for PHP. Composer is a dependency management tool for PHP that allows you to declare the dependencies your project needs and installs them into your project. In order to use the SDK with Composer, you must do the following:

Add "chargely/chargify-sdk-php" as a dependency in your project's composer.json file.

{
  "require": {
      "chargely/chargify-sdk-php": "0.1.1"
  }
}

Download and install Composer, if you don't already have it.

curl -sS https://getcomposer.org/installer | php

Install your dependencies, including your newly added Chargify SDK for PHP.

php composer.phar install

Require Composer's autoloader

<?php
require '/path/to/vendor/autoload.php';

Contributing

Please see CONTRIBUTING.md for more information.