# 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](page:development-tools/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](https://app.chargify.com/signup/maxio-billing-sandbox) or [log-in](https://app.chargify.com/login.html) to your [test site](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405553861773-Testing-Intro) account.
2. [Setup and configure authentication](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405281550477-API-Keys#api) 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](https://www.maxio.com/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
The package is compatible with Python versions `3 >=3.7, <= 3.11`.
Install the package from PyPi using the following pip command:
```python
pip install maxio-advanced-billing-sdk==2.0.0
```
You can also view the package at:
https://pypi.python.org/pypi/maxio-advanced-billing-sdk/2.0.0
## Initialize the API Client
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/client.md)
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
| --- | --- | --- |
| `subdomain` | `str` | The subdomain for your Chargify site.<br>*Default*: `'subdomain'` |
| `domain` | `str` | The Chargify server domain.<br>*Default*: `'chargify.com'` |
| `environment` | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |
| `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |
| `override_http_client_configuration` | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |
| `http_call_back` | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |
| `timeout` | `float` | The value to use for connection timeout. <br> **Default: 30** |
| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
| `retry_methods` | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |
| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/$a/https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/basic-authentication.md) | The credential object for Basic Authentication |
The API client can be initialized as follows:
```python
client = AdvancedBillingClient(
basic_auth_credentials=BasicAuthCredentials(
username='BasicAuthUserName',
password='BasicAuthPassword'
)
)
```
## 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)`](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/$a/https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/basic-authentication.md)
## List of APIs
* [API Exports](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/api-exports.md)
* [Advance Invoice](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/advance-invoice.md)
* [Billing Portal](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/billing-portal.md)
* [Custom Fields](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/custom-fields.md)
* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/events-based-billing-segments.md)
* [Payment Profiles](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/payment-profiles.md)
* [Product Families](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/product-families.md)
* [Product Price Points](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/product-price-points.md)
* [Proforma Invoices](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/proforma-invoices.md)
* [Reason Codes](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/reason-codes.md)
* [Referral Codes](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/referral-codes.md)
* [Sales Commissions](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/sales-commissions.md)
* [Subscription Components](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/subscription-components.md)
* [Subscription Groups](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/subscription-groups.md)
* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/subscription-group-invoice-account.md)
* [Subscription Group Status](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/subscription-group-status.md)
* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/subscription-invoice-account.md)
* [Subscription Notes](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/subscription-notes.md)
* [Subscription Products](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/subscription-products.md)
* [Subscription Status](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/subscription-status.md)
* [Coupons](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/coupons.md)
* [Components](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/components.md)
* [Customers](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/customers.md)
* [Events](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/events.md)
* [Insights](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/insights.md)
* [Invoices](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/invoices.md)
* [Offers](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/offers.md)
* [Products](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/products.md)
* [Sites](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/sites.md)
* [Subscriptions](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/subscriptions.md)
* [Webhooks](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/webhooks.md)
## Classes Documentation
* [Utility Classes](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/utility-classes.md)
* [HttpResponse](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/http-response.md)
* [HttpRequest](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/http-request.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "maxio-advanced-billing-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "Maxio, Advaced Billing, Payments, Subscription",
"author": null,
"author_email": "Maxio SDK <maxio-sdk@maxio.com>",
"download_url": "https://files.pythonhosted.org/packages/d8/54/e4f2616cbf29c82f51f33d958e6dbafb200f4199d495808c43aaaef18b31/maxio-advanced-billing-sdk-2.0.0.tar.gz",
"platform": null,
"description": "\n# Getting Started with Maxio Advanced Billing\n\n## Introduction\n\nMaxio Advanced Billing (formerly Chargify) provides an HTTP-based API that conforms to the principles of REST.\nOne of the many reasons to use Advanced Billing is the immense feature set and surrounding community [client libraries](page:development-tools/client-libraries).\nThe 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.\n\n### Steps to make your first Maxio Advanced Billing API call\n\n1. [Sign-up](https://app.chargify.com/signup/maxio-billing-sandbox) or [log-in](https://app.chargify.com/login.html) to your [test site](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405553861773-Testing-Intro) account.\n2. [Setup and configure authentication](https://maxio-chargify.zendesk.com/hc/en-us/articles/5405281550477-API-Keys#api) credentials.\n3. Submit your API request and try it out.\n4. Verify results through response.\n5. Test our integrations.\n\nWe strongly suggest exploring the developer portal, our [integrations](https://www.maxio.com/integrations) and the API guide, as well as the entire set of application-based documentation to aid in your discovery of the product.\n\n#### Example\n\nThe following example uses the curl command-line tool to execute API requests.\n\n**Request**\n\ncurl -u <api_key>:x -H Accept:application/json -H Content-Type:application/json https://acme.chargify.com/subscriptions.json\n\n## Install the Package\n\nThe package is compatible with Python versions `3 >=3.7, <= 3.11`.\nInstall the package from PyPi using the following pip command:\n\n```python\npip install maxio-advanced-billing-sdk==2.0.0\n```\n\nYou can also view the package at:\nhttps://pypi.python.org/pypi/maxio-advanced-billing-sdk/2.0.0\n\n## Initialize the API Client\n\n**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/client.md)\n\nThe following parameters are configurable for the API Client:\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| `subdomain` | `str` | The subdomain for your Chargify site.<br>*Default*: `'subdomain'` |\n| `domain` | `str` | The Chargify server domain.<br>*Default*: `'chargify.com'` |\n| `environment` | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |\n| `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |\n| `override_http_client_configuration` | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |\n| `http_call_back` | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |\n| `timeout` | `float` | The value to use for connection timeout. <br> **Default: 30** |\n| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |\n| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |\n| `retry_statuses` | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |\n| `retry_methods` | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |\n| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/$a/https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/basic-authentication.md) | The credential object for Basic Authentication |\n\nThe API client can be initialized as follows:\n\n```python\nclient = AdvancedBillingClient(\n basic_auth_credentials=BasicAuthCredentials(\n username='BasicAuthUserName',\n password='BasicAuthPassword'\n )\n)\n```\n\n## Environments\n\nThe SDK can be configured to use a different environment for making API calls. Available environments are:\n\n### Fields\n\n| Name | Description |\n| --- | --- |\n| production | **Default** Production server |\n| environment2 | Production server |\n\n## Authorization\n\nThis API uses the following authentication schemes.\n\n* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/$a/https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/basic-authentication.md)\n\n## List of APIs\n\n* [API Exports](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/api-exports.md)\n* [Advance Invoice](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/advance-invoice.md)\n* [Billing Portal](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/billing-portal.md)\n* [Custom Fields](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/custom-fields.md)\n* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/events-based-billing-segments.md)\n* [Payment Profiles](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/payment-profiles.md)\n* [Product Families](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/product-families.md)\n* [Product Price Points](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/product-price-points.md)\n* [Proforma Invoices](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/proforma-invoices.md)\n* [Reason Codes](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/reason-codes.md)\n* [Referral Codes](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/referral-codes.md)\n* [Sales Commissions](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/sales-commissions.md)\n* [Subscription Components](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/subscription-components.md)\n* [Subscription Groups](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/subscription-groups.md)\n* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/subscription-group-invoice-account.md)\n* [Subscription Group Status](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/subscription-group-status.md)\n* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/subscription-invoice-account.md)\n* [Subscription Notes](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/subscription-notes.md)\n* [Subscription Products](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/subscription-products.md)\n* [Subscription Status](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/subscription-status.md)\n* [Coupons](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/coupons.md)\n* [Components](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/components.md)\n* [Customers](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/customers.md)\n* [Events](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/events.md)\n* [Insights](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/insights.md)\n* [Invoices](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/invoices.md)\n* [Offers](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/offers.md)\n* [Products](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/products.md)\n* [Sites](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/sites.md)\n* [Subscriptions](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/subscriptions.md)\n* [Webhooks](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/controllers/webhooks.md)\n\n## Classes Documentation\n\n* [Utility Classes](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/utility-classes.md)\n* [HttpResponse](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/http-response.md)\n* [HttpRequest](https://www.github.com/maxio-com/ab-python-sdk/tree/2.0.0/doc/http-request.md)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Ultimate billing and pricing flexibility for B2B SaaS.",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://www.maxio.com/product/advanced-billing"
},
"split_keywords": [
"maxio",
" advaced billing",
" payments",
" subscription"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "97b8684cc60a11aca6eaa1113b9bbae87a383c3500a82915957a157b4c45d95e",
"md5": "e51a3396c63cdb016da66ef0d5397f28",
"sha256": "835b63e9e1f5f101270ac52c1dc10f0ea114193432c21f5952229d40da746ab0"
},
"downloads": -1,
"filename": "maxio_advanced_billing_sdk-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e51a3396c63cdb016da66ef0d5397f28",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 913228,
"upload_time": "2024-03-21T09:41:26",
"upload_time_iso_8601": "2024-03-21T09:41:26.807260Z",
"url": "https://files.pythonhosted.org/packages/97/b8/684cc60a11aca6eaa1113b9bbae87a383c3500a82915957a157b4c45d95e/maxio_advanced_billing_sdk-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d854e4f2616cbf29c82f51f33d958e6dbafb200f4199d495808c43aaaef18b31",
"md5": "36082e6e84052ba79b6b83fc69891467",
"sha256": "17913f79324991cf706d5ba03c3db69f25a806d0429e42be3a4ad1cf1e943939"
},
"downloads": -1,
"filename": "maxio-advanced-billing-sdk-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "36082e6e84052ba79b6b83fc69891467",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 373866,
"upload_time": "2024-03-21T09:41:28",
"upload_time_iso_8601": "2024-03-21T09:41:28.895386Z",
"url": "https://files.pythonhosted.org/packages/d8/54/e4f2616cbf29c82f51f33d958e6dbafb200f4199d495808c43aaaef18b31/maxio-advanced-billing-sdk-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-21 09:41:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "maxio-advanced-billing-sdk"
}
JSON