[FND-3] Release 7.0.0 #65

New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
lucassus merged 14 commits into main from publish
Jul 24, 2025
README.md
            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -4,22 +4,21 @@
  
    ## 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.

    One of the many reasons to use Advanced Billing is the immense feature set and [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.zendesk.com/hc/en-us/articles/24250712113165-Testing-Overview) account.

    2. [Setup and configure authentication](https://maxio.zendesk.com/hc/en-us/articles/24294819360525-API-Keys) credentials.

    3. Submit your API request and try it out.

    4. Verify results through response.

    5. Test our integrations.

    2. [Setup authentication](https://maxio.zendesk.com/hc/en-us/articles/24294819360525-API-Keys) credentials.

    3. [Submit an API request and verify the response](page:development-tools/client-libraries#make-your-first-maxio-advanced-billing-api-request).

    4. Test the Advanced Billing [integrations](https://www.maxio.com/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.

    Next, you can explore [authentication methods](page:introduction/authentication), [basic concepts](page:introduction/basic-concepts/connected-sites) for interacting with Advanced Billing via the API, and the entire set of [application-based documentation](https://docs.maxio.com/hc/en-us) to aid in your discovery of the product.

    #### Example

    #### Request Example

    The following example uses the curl command-line tool to execute API requests.

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

    **Request**

    @@ -30,44 +29,49 @@ curl -u <api_key>:x -H Accept:application/json -H Content-Type:application/json
  
    Run the following command to install the package and automatically add the dependency to your composer.json file:

    ```bash

    composer require "maxio/advanced-billing-sdk:6.1.0"

    composer require "maxio/advanced-billing-sdk:7.0.0"

    ```

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

    ```json

    "require": {

        "maxio/advanced-billing-sdk": "6.1.0"

        "maxio/advanced-billing-sdk": "7.0.0"

    }

    ```

    You can also view the package at:

    https://packagist.org/packages/maxio/advanced-billing-sdk#6.1.0

    https://packagist.org/packages/maxio/advanced-billing-sdk#7.0.0

    ## Initialize the API Client

    **_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/client.md)

    **_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/client.md)

    The following parameters are configurable for the API Client:

    | Parameter | Type | Description |

    |  --- | --- | --- |

    | `site` | `string` | The subdomain for your Advanced Billing site.<br>*Default*: `'subdomain'` |

    | `environment` | `Environment` | The API environment. <br> **Default: `Environment.US`** |

    | `timeout` | `int` | Timeout for API calls in seconds.<br>*Default*: `120` |

    | `enableRetries` | `bool` | Whether to enable retries and backoff feature.<br>*Default*: `false` |

    | `numberOfRetries` | `int` | The number of retries to make.<br>*Default*: `0` |

    | `retryInterval` | `float` | The retry time interval between the endpoint calls.<br>*Default*: `1` |

    | `backOffFactor` | `float` | Exponential backoff factor to increase interval between retries.<br>*Default*: `2` |

    | `maximumRetryWaitTime` | `int` | The maximum wait time in seconds for overall retrying requests.<br>*Default*: `0` |

    | `retryOnTimeout` | `bool` | Whether to retry on request timeout.<br>*Default*: `true` |

    | `httpStatusCodesToRetry` | `array` | Http status codes to retry against.<br>*Default*: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524` |

    | `httpMethodsToRetry` | `array` | Http methods to retry against.<br>*Default*: `'GET', 'PUT'` |

    | `basicAuthCredentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/auth/basic-authentication.md) | The Credentials Setter for Basic Authentication |

    | site | `string` | The subdomain for your Advanced Billing site.<br>*Default*: `'subdomain'` |

    | environment | `Environment` | The API environment. <br> **Default: `Environment.US`** |

    | timeout | `int` | Timeout for API calls in seconds.<br>*Default*: `120` |

    | enableRetries | `bool` | Whether to enable retries and backoff feature.<br>*Default*: `false` |

    | numberOfRetries | `int` | The number of retries to make.<br>*Default*: `0` |

    | retryInterval | `float` | The retry time interval between the endpoint calls.<br>*Default*: `1` |

    | backOffFactor | `float` | Exponential backoff factor to increase interval between retries.<br>*Default*: `2` |

    | maximumRetryWaitTime | `int` | The maximum wait time in seconds for overall retrying requests.<br>*Default*: `0` |

    | retryOnTimeout | `bool` | Whether to retry on request timeout.<br>*Default*: `true` |

    | httpStatusCodesToRetry | `array` | Http status codes to retry against.<br>*Default*: `408, 413, 429, 500, 502, 503, 504, 521, 522, 524` |

    | httpMethodsToRetry | `array` | Http methods to retry against.<br>*Default*: `'GET', 'PUT'` |

    | proxyConfiguration | [`ProxyConfigurationBuilder`](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/proxy-configuration-builder.md) | Represents the proxy configurations for API calls |

    | basicAuthCredentials | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/auth/basic-authentication.md) | The Credentials Setter for Basic Authentication |

    The API client can be initialized as follows:

    ```php

    use AdvancedBillingLib\Environment;

    use AdvancedBillingLib\Authentication\BasicAuthCredentialsBuilder;

    use AdvancedBillingLib\AdvancedBillingClientBuilder;

    $client = AdvancedBillingClientBuilder::init()

        ->basicAuthCredentials(

            BasicAuthCredentialsBuilder::init(

    @@ -95,46 +99,55 @@ The SDK can be configured to use a different environment for making API calls. A
  
    This API uses the following authentication schemes.

    * [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/auth/basic-authentication.md)

    * [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/auth/basic-authentication.md)

    ## List of APIs

    * [API Exports](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/api-exports.md)

    * [Advance Invoice](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/advance-invoice.md)

    * [Billing Portal](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/billing-portal.md)

    * [Component Price Points](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/component-price-points.md)

    * [Custom Fields](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/custom-fields.md)

    * [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/events-based-billing-segments.md)

    * [Payment Profiles](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/payment-profiles.md)

    * [Product Families](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/product-families.md)

    * [Product Price Points](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/product-price-points.md)

    * [Proforma Invoices](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/proforma-invoices.md)

    * [Reason Codes](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/reason-codes.md)

    * [Referral Codes](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/referral-codes.md)

    * [Sales Commissions](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/sales-commissions.md)

    * [Subscription Components](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/subscription-components.md)

    * [Subscription Groups](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/subscription-groups.md)

    * [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/subscription-group-invoice-account.md)

    * [Subscription Group Status](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/subscription-group-status.md)

    * [Subscription Invoice Account](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/subscription-invoice-account.md)

    * [Subscription Notes](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/subscription-notes.md)

    * [Subscription Products](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/subscription-products.md)

    * [Subscription Status](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/subscription-status.md)

    * [Coupons](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/coupons.md)

    * [Components](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/components.md)

    * [Customers](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/customers.md)

    * [Events](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/events.md)

    * [Insights](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/insights.md)

    * [Invoices](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/invoices.md)

    * [Offers](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/offers.md)

    * [Products](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/products.md)

    * [Sites](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/sites.md)

    * [Subscriptions](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/subscriptions.md)

    * [Webhooks](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/controllers/webhooks.md)

    ## Classes Documentation

    * [ApiException](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/api-exception.md)

    * [HttpRequest](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/http-request.md)

    * [HttpResponse](https://www.github.com/maxio-com/ab-php-sdk/tree/6.1.0/doc/http-response.md)

    * [API Exports](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/api-exports.md)

    * [Advance Invoice](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/advance-invoice.md)

    * [Billing Portal](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/billing-portal.md)

    * [Component Price Points](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/component-price-points.md)

    * [Custom Fields](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/custom-fields.md)

    * [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/events-based-billing-segments.md)

    * [Payment Profiles](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/payment-profiles.md)

    * [Product Families](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/product-families.md)

    * [Product Price Points](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/product-price-points.md)

    * [Proforma Invoices](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/proforma-invoices.md)

    * [Reason Codes](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/reason-codes.md)

    * [Referral Codes](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/referral-codes.md)

    * [Sales Commissions](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/sales-commissions.md)

    * [Subscription Components](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/subscription-components.md)

    * [Subscription Groups](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/subscription-groups.md)

    * [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/subscription-group-invoice-account.md)

    * [Subscription Group Status](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/subscription-group-status.md)

    * [Subscription Invoice Account](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/subscription-invoice-account.md)

    * [Subscription Notes](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/subscription-notes.md)

    * [Subscription Products](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/subscription-products.md)

    * [Subscription Status](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/subscription-status.md)

    * [Coupons](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/coupons.md)

    * [Components](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/components.md)

    * [Customers](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/customers.md)

    * [Events](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/events.md)

    * [Insights](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/insights.md)

    * [Invoices](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/invoices.md)

    * [Offers](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/offers.md)

    * [Products](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/products.md)

    * [Sites](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/sites.md)

    * [Subscriptions](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/subscriptions.md)

    * [Webhooks](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/controllers/webhooks.md)

    ## SDK Infrastructure

    ### Configuration

    * [ProxyConfigurationBuilder](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/proxy-configuration-builder.md)

    ### HTTP

    * [HttpRequest](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/http-request.md)

    * [HttpResponse](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/http-response.md)

    ### Utilities

    * [ApiException](https://www.github.com/maxio-com/ab-php-sdk/tree/7.0.0/doc/api-exception.md)
cleanupSite.sh
-Original file line number
+Diff line change
@@ -1,6 +1,11 @@
-    auth=$(echo "$BASIC_AUTH_USERNAME":"$BASIC_AUTH_PASSWORD" | base64)
+    #!/bin/bash
+    set -eo pipefail
+    auth=$(echo "${BASIC_AUTH_USERNAME}:${BASIC_AUTH_PASSWORD}" | base64)
     curl --request POST \
-      --url https://"$SUB_DOMAIN"."$DOMAIN"/sites/clear_data.json \
-      --header "Authorization: Basic $auth" \
-      --header 'Content-Type: application/json'
+      --url "https://${SUB_DOMAIN}.${DOMAIN}/sites/clear_data.json" \
+      --header "Authorization: Basic ${auth}" \
+      --header "Content-Type: application/json" \
+      --verbose
composer.json
-Original file line number
+Diff line change
@@ Expand Up / @@ -29,7 +29,8 @@ @@
         "require": {
             "php": "^7.2 || ^8.0",
             "ext-json": "*",
-            "apimatic/unirest-php": "^4.0.0",
+            "ext-curl": "*",
+            "apimatic/unirest-php": "^4.0.6",
             "apimatic/core-interfaces": "~0.1.5",
             "apimatic/core": "~0.3.13"
         },
@@ Expand Down @@
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FND-3] Release 7.0.0 #65

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!
