killbill-client-php

PHP client library for Kill Bill.

Kill Bill compatibility

Requirements

PHP 8.1 and later

Installation & Usage

Composer

Require the library via composer:

composer require killbill/killbill-client

Manual Installation

Download the files and include autoload.php:

require_once('/path/to/./vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Killbill\Client\KillbillClient;
use Killbill\Client\Swagger\Model\Account;
use Killbill\Client\Swagger\Model\Tenant;

// Setup Killbill client
$client = new KillbillClient(null, 'http://localhost:8080', 'ADMIN_LOGIN', 'ADMIN_PASSWORD');

// Set these values for your particular tenant
$tenant = new Tenant();
$tenant->setApiKey('bob');
$tenant->setApiSecret('lazar');
$tenant = $this->client->getTenantApi()->createTenant($tenant, 'pierre', 'PHP_TEST', 'no comment');

// Point the client to work with this tenant
$client->setApiKey('bob');
$client->setApiSecret('lazar');

// Unique id for this account
$externalAccountId = uniqid();

$accountData = new Account();
$accountData->setName('Killbill php test');
$accountData->setExternalKey($externalAccountId);
$accountData->setEmail('test-' . $externalAccountId . '@kill-bill.org');
$accountData->setCurrency('USD');
$accountData->setPaymentMethodId(null);
$accountData->setAddress1('12 rue des ecoles');
$accountData->setAddress2('Poitier');
$accountData->setCompany('Renault');
$accountData->setState('Poitou');
$accountData->setCountry('France');
$accountData->setPhone('81 53 26 56');
$accountData->setFirstNameLength(4);
$accountData->setTimeZone('UTC');

$account = $client->getAccountApi()->createAccount($accountData, 'pierre', 'PHP_TEST', 'no comment');

// In case you need to make custom requests to Killbill plugins using guzzle:
use Killbill\Client\AddAuthHeadersMiddleware;

$guzzle = $client->getGuzzleClient();
// base_host is already configured
$response = $guzzle->request('POST', '/plugins/killbill-stripe/checkout', [
    'form_params' => [
        'kbAccountId' => $account->getAccountId(),
        'successUrl' => $successUrl,
        'cancelUrl' => $cancelUrl,
    ],
    //BASIC_AUTH adds admin/password credenditals;
    //TENANT_KEY adds key/secret header
    AddAuthHeadersMiddleware::OPTION => AddAuthHeadersMiddleware::BASIC_AUTH | AddAuthHeadersMiddleware::TENANT_KEY,
]);

See tests for more examples.

Using the client in a non-composer environment

If you want to use the client but are not using Composer (yet), follow these steps:

• Install composer locally: Instruction
• Run composer require killbill/killbill-client. This will download the library into the vendor/ folder and create a composer.json and a composer.lock file that define this dependency.
• Include the auto-generated autoload.php file from the vendor/ folder.
• You can now use the client like above described.
• If you don't want to have an additional build step, just check the vendor/ folder into your repository.

Testing

The Killbill PHP client uses phpunit as testing framework. Tests can either be run locally using composer test or against a live Killbill instance that is running on 127.0.0.1:8080 using composer test-integration.

Requirements

The PHP library requires PHP 5.5 or greater with libcurl compiled (e.g. you need the php-curl package on Ubuntu).

Support

Feel free to ask questions on the killbilling-users Google Group.

API Generation

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 0.24.0
• Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Download swagger-codegen:

wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.22/swagger-codegen-cli-3.0.22.jar -O swagger-codegen-cli.jar

and run the following:

./build.sh

see https://github.com/swagger-api/swagger-codegen/tree/3.0.0 for documentation of swagger-codegen

The generator here uses custom templates in the templates folder based on swagger's default ones (https://github.com/swagger-api/swagger-codegen-generators/tree/master/src/main/resources/handlebars/php)

Main differences in the generated client compared to swagger's:

• dates are formatted into an Y-m-d strings instead of ISO8601 strings
• booleans are formatted into true/false strings instead of 0/1 strings
• arrays in queries are formatted as a 'csv' format instead of 'multi' (ex: custom field id lists on account's delete custom fields method)
• arrays of objects in bodies are not failing at formatting (ex: custom field objects on account's add custom fields method)

Documentation for API Endpoints

All URIs are relative to /

Documentation For Models

• Account
• AccountEmail
• AccountTimeline
• AdminPayment
• AuditLog
• BlockPrice
• BlockingState
• BulkSubscriptionsBundle
• Bundle
• BundleTimeline
• Catalog
• ComboHostedPaymentPage
• ComboPaymentTransaction
• Credit
• CustomField
• Duration
• Entity
• EventSubscription
• HostedPaymentPageFields
• HostedPaymentPageFormDescriptor
• Invoice
• InvoiceDryRun
• InvoiceItem
• InvoicePayment
• InvoicePaymentTransaction
• Limit
• NodeCommand
• NodeCommandProperty
• Overdue
• OverdueCondition
• OverdueState
• OverdueStateConfig
• Payment
• PaymentAttempt
• PaymentMethod
• PaymentMethodPluginDetail
• PaymentTransaction
• Phase
• PhasePrice
• Plan
• PlanDetail
• PluginInfo
• PluginProperty
• PluginServiceInfo
• Price
• PriceList
• Product
• RoleDefinition
• RolledUpUnit
• RolledUpUsage
• Session
• SimplePlan
• Subject
• Subscription
• SubscriptionUsageRecord
• Tag
• TagDefinition
• Tenant
• TenantKeyValue
• Tier
• TierPrice
• TieredBlock
• Unit
• UnitUsageRecord
• Usage
• UsagePrice
• UsageRecord
• UserRoles

Documentation For Authorization

Killbill Api Key

• Type: API key
• API key parameter name: X-Killbill-ApiKey
• Location: HTTP header

Killbill Api Secret

• Type: API key
• API key parameter name: X-Killbill-ApiSecret
• Location: HTTP header

basicAuth

• Type: HTTP basic authentication

Author