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 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.

$3

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 :x -H Accept:application/json -H Content-Type:application/json https://acme.chargify.com/subscriptions.json

Install the Package

Run the following command from your project directory to install the package from npm:

``bash npm install @maxio-com/advanced-billing-sdk@8.0.0`

For additional package details, see the Npm page for the @maxio-com/advanced-billing-sdk@8.0.0 npm.

`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 | | --- | --- | --- | | site |string| The subdomain for your Advanced Billing site. Default:'subdomain'| | environment |Environment| The API environment. Default:Environment.US| | timeout |number| Timeout for API calls. Default:120000| | httpClientOptions |Partial| Stable configurable http client options. | | unstableHttpClientOptions |any| Unstable configurable http client options. | | basicAuthCredentials |BasicAuthCredentials | The credential object for basicAuth |

The API client can be initialized as follows:

`ts import { Client, Environment } from '@maxio-com/advanced-billing-sdk';

const client = new Client({ basicAuthCredentials: { username: 'BasicAuthUserName', password: 'BasicAuthPassword' }, timeout: 120000, environment: Environment.US, site: 'subdomain', });`

`Environments`

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

`$3`

| Name | Description | | --- | --- | | US | Default Default Advanced Billing environment hosted in US. Valid for the majority of our customers. | | EU | Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account. |

`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

SDK Infrastructure