README

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 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 authentication credentials.
3. Submit an API request and verify the response.
4. Test the Advanced Billing integrations.

Next, you can explore authentication methods, basic concepts for interacting with Advanced Billing via the API, and the entire set of application-based documentation to aid in your discovery of the product.

Request Example

The following example uses the curl command-line tool to make an API request.

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:9.1.0"

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

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

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

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

use AdvancedBillingLib\Environment;
use AdvancedBillingLib\Authentication\BasicAuthCredentialsBuilder;
use AdvancedBillingLib\AdvancedBillingClientBuilder;

$client = AdvancedBillingClientBuilder::init()
    ->basicAuthCredentials(
        BasicAuthCredentialsBuilder::init(
            'BasicAuthUserName',
            'BasicAuthPassword'
        )
    )
    ->environment(Environment::US)
    ->site('subdomain')
    ->build();

Environments

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

Fields

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 Renewals
• Subscription Status
• Coupons
• Components
• Customers
• Events
• Insights
• Invoices
• Offers
• Products
• Sites
• Subscriptions
• Webhooks

SDK Infrastructure

Configuration

• ProxyConfigurationBuilder

HTTP

• HttpRequest
• HttpResponse

Utilities

• ApiException