maxio-advanced-billing-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

Install the gem from the command line:

gem install maxio-advanced-billing-sdk -v 6.0.0

Or add the gem to your Gemfile and run bundle:

gem 'maxio-advanced-billing-sdk', '6.0.0'

For additional gem details, see the RubyGems page for the maxio-advanced-billing-sdk gem.

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
connection	Faraday::Connection	The Faraday connection object passed by the SDK user for making requests
adapter	Faraday::Adapter	The Faraday adapter object passed by the SDK user for performing http requests
timeout	Float	The value to use for connection timeout. Default: 120
max_retries	Integer	The number of times to retry an endpoint call if it fails. Default: 0
retry_interval	Float	Pause in seconds between retries. Default: 1
backoff_factor	Float	The amount to multiply each successive retry's interval amount by in order to provide backoff. Default: 2
retry_statuses	Array	A list of HTTP statuses to retry. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array	A list of HTTP methods to retry. Default: %i[get put]
http_callback	HttpCallBack	The Http CallBack allows defining callables for pre and post API calls.
basic_auth_credentials	BasicAuthCredentials	The credential object for Basic Authentication

The API client can be initialized as follows:

client = AdvancedBilling::Client.new(
  basic_auth_credentials: BasicAuthCredentials.new(
    username: 'BasicAuthUserName',
    password: 'BasicAuthPassword'
  ),
  environment: Environment::US,
  site: 'subdomain'
)

Environments

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

Fields

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

Classes Documentation

• Utility Classes
• HttpResponse
• HttpRequest