maxio-com/ab-php-sdk

Getting Started with Maxio Advanced Billing

Introduction

Maxio Advanced Billing (formerly Chargify) provides an HTTP-based API that conforms to the principles of REST. One of the many reasons to use Advanced Billing is the immense feature set and surrounding community client libraries. The Maxio API returns JSON responses as the primary and recommended format, but XML is also provided as a backwards compatible option for Merchants who require it.

Steps to make your first Maxio Advanced Billing API call

1. Sign-up or log-in to your test site account.
2. Setup and configure authentication credentials.
3. Submit your API request and try it out.
4. Verify results through response.
5. Test our integrations.

We strongly suggest exploring the developer portal, our integrations and the API guide, as well as the entire set of application-based documentation to aid in your discovery of the product.

Example

The following example uses the curl command-line tool to execute API requests.

Request

curl -u <api_key>:x -H Accept:application/json -H Content-Type:application/json https://acme.chargify.com/subscriptions.json

Install the Package

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "maxio/advanced-billing-sdk:5.0.0"

Or add it to the composer.json file manually as given below:

"require": {
    "maxio/advanced-billing-sdk": "5.0.0"
}

You can also view the package at: https://packagist.org/packages/maxio/advanced-billing-sdk#5.0.0

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
subdomain	string	The subdomain for your Advanced Billing site. Default: 'subdomain'
domain	string	The Advanced Billing server domain. Default: 'chargify.com'
environment	Environment	The API environment. Default: Environment.PRODUCTION
timeout	int	Timeout for API calls in seconds. Default: 120
enableRetries	bool	Whether to enable retries and backoff feature. Default: false
numberOfRetries	int	The number of retries to make. Default: 0
retryInterval	float	The retry time interval between the endpoint calls. Default: 1
backOffFactor	float	Exponential backoff factor to increase interval between retries. Default: 2
maximumRetryWaitTime	int	The maximum wait time in seconds for overall retrying requests. Default: 0
retryOnTimeout	bool	Whether to retry on request timeout. Default: true
httpStatusCodesToRetry	array	Http status codes to retry against. Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524
httpMethodsToRetry	array	Http methods to retry against. Default: 'GET', 'PUT'
basicAuthCredentials	BasicAuthCredentials	The Credentials Setter for Basic Authentication

The API client can be initialized as follows:

$client = AdvancedBillingClientBuilder::init()
    ->basicAuthCredentials(
        BasicAuthCredentialsBuilder::init(
            'BasicAuthUserName',
            'BasicAuthPassword'
        )
    )
    ->environment('production')
    ->subdomain('subdomain')
    ->domain('chargify.com')
    ->build();

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name	Description
production	Default Production server
environment2	Production server

Authorization

This API uses the following authentication schemes.

• BasicAuth (Basic Authentication)

List of APIs

• API Exports
• Advance Invoice
• Billing Portal
• Component Price Points
• Custom Fields
• Events-Based Billing Segments
• Payment Profiles
• Product Families
• Product Price Points
• Proforma Invoices
• Reason Codes
• Referral Codes
• Sales Commissions
• Subscription Components
• Subscription Groups
• Subscription Group Invoice Account
• Subscription Group Status
• Subscription Invoice Account
• Subscription Notes
• Subscription Products
• Subscription Status
• Coupons
• Components
• Customers
• Events
• Insights
• Invoices
• Offers
• Products
• Sites
• Subscriptions
• Webhooks

Classes Documentation

• ApiException
• HttpRequest
• HttpResponse