Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ License:
The MIT License (MIT)
http://opensource.org/licenses/MIT

Copyright (c) 2014 - 2025 APIMATIC Limited
Copyright (c) 2014 - 2026 APIMATIC Limited

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
89 changes: 45 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,30 +29,30 @@ 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:8.0.0"
composer require "maxio/advanced-billing-sdk:9.0.0"
```

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

```json
"require": {
"maxio/advanced-billing-sdk": "8.0.0"
"maxio/advanced-billing-sdk": "9.0.0"
}
```

You can also view the package at:
https://packagist.org/packages/maxio/advanced-billing-sdk#8.0.0
https://packagist.org/packages/maxio/advanced-billing-sdk#9.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/8.0.0/doc/client.md)
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-php-sdk/tree/9.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`** |
| environment | [`Environment`](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/README.md#environments) | 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` |
Expand All @@ -62,8 +62,8 @@ The following parameters are configurable for the API Client:
| 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/8.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/8.0.0/doc/auth/basic-authentication.md) | The Credentials Setter for Basic Authentication |
| proxyConfiguration | [`ProxyConfigurationBuilder`](https://www.github.com/maxio-com/ab-php-sdk/tree/9.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/9.0.0/doc/auth/basic-authentication.md) | The Credentials Setter for Basic Authentication |

The API client can be initialized as follows:

Expand Down Expand Up @@ -99,55 +99,56 @@ 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/8.0.0/doc/auth/basic-authentication.md)
* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/auth/basic-authentication.md)

## List of APIs

* [API Exports](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/api-exports.md)
* [Advance Invoice](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/advance-invoice.md)
* [Billing Portal](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/billing-portal.md)
* [Component Price Points](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/component-price-points.md)
* [Custom Fields](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/custom-fields.md)
* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/events-based-billing-segments.md)
* [Payment Profiles](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/payment-profiles.md)
* [Product Families](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/product-families.md)
* [Product Price Points](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/product-price-points.md)
* [Proforma Invoices](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/proforma-invoices.md)
* [Reason Codes](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/reason-codes.md)
* [Referral Codes](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/referral-codes.md)
* [Sales Commissions](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/sales-commissions.md)
* [Subscription Components](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/subscription-components.md)
* [Subscription Groups](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/subscription-groups.md)
* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/subscription-group-invoice-account.md)
* [Subscription Group Status](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/subscription-group-status.md)
* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/subscription-invoice-account.md)
* [Subscription Notes](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/subscription-notes.md)
* [Subscription Products](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/subscription-products.md)
* [Subscription Status](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/subscription-status.md)
* [Coupons](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/coupons.md)
* [Components](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/components.md)
* [Customers](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/customers.md)
* [Events](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/events.md)
* [Insights](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/insights.md)
* [Invoices](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/invoices.md)
* [Offers](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/offers.md)
* [Products](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/products.md)
* [Sites](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/sites.md)
* [Subscriptions](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/subscriptions.md)
* [Webhooks](https://www.github.com/maxio-com/ab-php-sdk/tree/8.0.0/doc/controllers/webhooks.md)
* [API Exports](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/api-exports.md)
* [Advance Invoice](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/advance-invoice.md)
* [Billing Portal](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/billing-portal.md)
* [Component Price Points](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/component-price-points.md)
* [Custom Fields](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/custom-fields.md)
* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/events-based-billing-segments.md)
* [Payment Profiles](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/payment-profiles.md)
* [Product Families](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/product-families.md)
* [Product Price Points](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/product-price-points.md)
* [Proforma Invoices](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/proforma-invoices.md)
* [Reason Codes](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/reason-codes.md)
* [Referral Codes](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/referral-codes.md)
* [Sales Commissions](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/sales-commissions.md)
* [Subscription Components](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/subscription-components.md)
* [Subscription Groups](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/subscription-groups.md)
* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/subscription-group-invoice-account.md)
* [Subscription Group Status](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/subscription-group-status.md)
* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/subscription-invoice-account.md)
* [Subscription Notes](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/subscription-notes.md)
* [Subscription Products](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/subscription-products.md)
* [Subscription Renewals](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/subscription-renewals.md)
* [Subscription Status](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/subscription-status.md)
* [Coupons](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/coupons.md)
* [Components](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/components.md)
* [Customers](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/customers.md)
* [Events](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/events.md)
* [Insights](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/insights.md)
* [Invoices](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/invoices.md)
* [Offers](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/offers.md)
* [Products](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/products.md)
* [Sites](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/sites.md)
* [Subscriptions](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/subscriptions.md)
* [Webhooks](https://www.github.com/maxio-com/ab-php-sdk/tree/9.0.0/doc/controllers/webhooks.md)

## SDK Infrastructure

### Configuration

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

### HTTP

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

### Utilities

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

2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"ext-curl": "*",
"apimatic/unirest-php": "^4.0.6",
"apimatic/core-interfaces": "~0.1.5",
"apimatic/core": "~0.3.16"
"apimatic/core": "~0.3.17"
},
"require-dev": {
"squizlabs/php_codesniffer": "^3.5",
Expand Down
3 changes: 2 additions & 1 deletion doc/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ 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`** |
| environment | [`Environment`](../README.md#environments) | 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` |
Expand Down Expand Up @@ -76,6 +76,7 @@ The gateway for the SDK. This class acts as a factory for the Controllers and al
| getSubscriptionInvoiceAccountController() | Gets SubscriptionInvoiceAccountController |
| getSubscriptionNotesController() | Gets SubscriptionNotesController |
| getSubscriptionProductsController() | Gets SubscriptionProductsController |
| getSubscriptionRenewalsController() | Gets SubscriptionRenewalsController |
| getSubscriptionStatusController() | Gets SubscriptionStatusController |
| getWebhooksController() | Gets WebhooksController |

44 changes: 35 additions & 9 deletions doc/controllers/advance-invoice.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ function issueAdvanceInvoice(int $subscriptionId, ?IssueAdvanceInvoiceRequest $b

| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `subscriptionId` | `int` | Template, Required | The Chargify id of the subscription |
| `subscriptionId` | `int` | Template, Required | The Chargify id of the subscription. |
| `body` | [`?IssueAdvanceInvoiceRequest`](../../doc/models/issue-advance-invoice-request.md) | Body, Optional | - |

## Response Type
Expand All @@ -46,10 +46,20 @@ $body = IssueAdvanceInvoiceRequestBuilder::init()
->force(true)
->build();

$result = $advanceInvoiceController->issueAdvanceInvoice(
$subscriptionId,
$body
);
$advanceInvoiceController = $client->getAdvanceInvoiceController();

try {
$result = $advanceInvoiceController->issueAdvanceInvoice(
$subscriptionId,
$body
);
echo 'Invoice:';
var_dump($result);
} catch (ErrorListResponseException $exp) {
echo 'Caught ErrorListResponseException:', $exp;
} catch (ApiException $exp) {
echo 'Caught:', $exp;
}
```

## Errors
Expand All @@ -72,7 +82,7 @@ function readAdvanceInvoice(int $subscriptionId): Invoice

| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `subscriptionId` | `int` | Template, Required | The Chargify id of the subscription |
| `subscriptionId` | `int` | Template, Required | The Chargify id of the subscription. |

## Response Type

Expand All @@ -83,7 +93,15 @@ function readAdvanceInvoice(int $subscriptionId): Invoice
```php
$subscriptionId = 222;

$result = $advanceInvoiceController->readAdvanceInvoice($subscriptionId);
$advanceInvoiceController = $client->getAdvanceInvoiceController();

try {
$result = $advanceInvoiceController->readAdvanceInvoice($subscriptionId);
echo 'Invoice:';
var_dump($result);
} catch (ApiException $exp) {
echo 'Caught:', $exp;
}
```

## Errors
Expand All @@ -106,7 +124,7 @@ function voidAdvanceInvoice(int $subscriptionId, ?VoidInvoiceRequest $body = nul

| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `subscriptionId` | `int` | Template, Required | The Chargify id of the subscription |
| `subscriptionId` | `int` | Template, Required | The Chargify id of the subscription. |
| `body` | [`?VoidInvoiceRequest`](../../doc/models/void-invoice-request.md) | Body, Optional | - |

## Response Type
Expand All @@ -118,7 +136,15 @@ function voidAdvanceInvoice(int $subscriptionId, ?VoidInvoiceRequest $body = nul
```php
$subscriptionId = 222;

$result = $advanceInvoiceController->voidAdvanceInvoice($subscriptionId);
$advanceInvoiceController = $client->getAdvanceInvoiceController();

try {
$result = $advanceInvoiceController->voidAdvanceInvoice($subscriptionId);
echo 'Invoice:';
var_dump($result);
} catch (ApiException $exp) {
echo 'Caught:', $exp;
}
```

## Errors
Expand Down
Loading
Loading