Maxio.AdvancedBillingSdk 9.1.0

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 . 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. .
4. Test the Advanced Billing integrations.

Next, you can explore , 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

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package Maxio.AdvancedBillingSdk --version 9.1.0

You can also view the package at: https://www.nuget.org/packages/Maxio.AdvancedBillingSdk/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:

Code-Based Initialization

using AdvancedBilling.Standard;
using AdvancedBilling.Standard.Authentication;

namespace ConsoleApp;

AdvancedBillingClient client = new AdvancedBillingClient.Builder()
 .BasicAuthCredentials(
 new BasicAuthModel.Builder(
 "BasicAuthUserName",
 "BasicAuthPassword"
 )
 .Build())
 .HttpClientConfig(httpClientConfig =>
 httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
 .Environment(AdvancedBilling.Standard.Environment.US)
 .Site("subdomain")
 .Build();

Configuration-Based Initialization

using AdvancedBilling.Standard;
using Microsoft.Extensions.Configuration;

namespace ConsoleApp;

// Build the IConfiguration using .NET conventions (JSON, environment, etc.)
var configuration = new ConfigurationBuilder()
 .AddJsonFile("config.json")
 .AddEnvironmentVariables() // [optional] read environment variables
 .Build();

// Instantiate your SDK and configure it from IConfiguration
var client = AdvancedBillingClient
 .FromConfiguration(configuration.GetSection("AdvancedBilling"));

See the Configuration-Based Initialization section for details.

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

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter