Skip to content
Merged
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
The table of contents is too big for display.
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
112 changes: 56 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,25 +32,25 @@ Install the SDK by adding the following dependency in your project's pom.xml fil
<dependency>
<groupId>com.maxio</groupId>
<artifactId>advanced-billing-sdk</artifactId>
<version>8.0.0</version>
<version>9.0.0</version>
</dependency>
```

You can also view the package at:
https://central.sonatype.com/artifact/com.maxio/advanced-billing-sdk/8.0.0
https://central.sonatype.com/artifact/com.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-java-sdk/tree/8.0.0/doc/client.md)
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-java-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`** |
| httpClientConfig | [`Consumer<HttpClientConfiguration.Builder>`](https://www.github.com/maxio-com/ab-java-sdk/tree/8.0.0/doc/http-client-configuration-builder.md) | Set up Http Client Configuration instance. |
| basicAuthCredentials | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-java-sdk/tree/8.0.0/doc/auth/basic-authentication.md) | The Credentials Setter for Basic Authentication |
| environment | [`Environment`](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/README.md#environments) | The API environment. <br> **Default: `Environment.US`** |
| httpClientConfig | [`Consumer<HttpClientConfiguration.Builder>`](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/doc/http-client-configuration-builder.md) | Set up Http Client Configuration instance. |
| basicAuthCredentials | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-java-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 All @@ -59,7 +59,6 @@ import com.maxio.advancedbilling.AdvancedBillingClient;
import com.maxio.advancedbilling.Environment;
import com.maxio.advancedbilling.authentication.BasicAuthModel;
import com.maxio.advancedbilling.exceptions.ApiException;
import java.io.IOException;

public class Program {
public static void main(String[] args) {
Expand Down Expand Up @@ -94,67 +93,68 @@ 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-java-sdk/tree/8.0.0/doc/auth/basic-authentication.md)
* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/doc/auth/basic-authentication.md)

## List of APIs

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

## SDK Infrastructure

### Configuration

* [Configuration Interface](https://www.github.com/maxio-com/ab-java-sdk/tree/8.0.0/doc/configuration-interface.md)
* [HttpClientConfiguration](https://www.github.com/maxio-com/ab-java-sdk/tree/8.0.0/doc/http-client-configuration.md)
* [HttpClientConfiguration.Builder](https://www.github.com/maxio-com/ab-java-sdk/tree/8.0.0/doc/http-client-configuration-builder.md)
* [HttpProxyConfiguration](https://www.github.com/maxio-com/ab-java-sdk/tree/8.0.0/doc/http-proxy-configuration.md)
* [HttpProxyConfiguration.Builder](https://www.github.com/maxio-com/ab-java-sdk/tree/8.0.0/doc/http-proxy-configuration-builder.md)
* [Configuration Interface](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/doc/configuration-interface.md)
* [HttpClientConfiguration](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/doc/http-client-configuration.md)
* [HttpClientConfiguration.Builder](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/doc/http-client-configuration-builder.md)
* [HttpProxyConfiguration](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/doc/http-proxy-configuration.md)
* [HttpProxyConfiguration.Builder](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/doc/http-proxy-configuration-builder.md)

### HTTP

* [Headers](https://www.github.com/maxio-com/ab-java-sdk/tree/8.0.0/doc/headers.md)
* [HttpCallback Interface](https://www.github.com/maxio-com/ab-java-sdk/tree/8.0.0/doc/http-callback-interface.md)
* [HttpContext](https://www.github.com/maxio-com/ab-java-sdk/tree/8.0.0/doc/http-context.md)
* [HttpBodyRequest](https://www.github.com/maxio-com/ab-java-sdk/tree/8.0.0/doc/http-body-request.md)
* [HttpRequest](https://www.github.com/maxio-com/ab-java-sdk/tree/8.0.0/doc/http-request.md)
* [HttpResponse](https://www.github.com/maxio-com/ab-java-sdk/tree/8.0.0/doc/http-response.md)
* [HttpStringResponse](https://www.github.com/maxio-com/ab-java-sdk/tree/8.0.0/doc/http-string-response.md)
* [Headers](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/doc/headers.md)
* [HttpCallback Interface](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/doc/http-callback-interface.md)
* [HttpContext](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/doc/http-context.md)
* [HttpBodyRequest](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/doc/http-body-request.md)
* [HttpRequest](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/doc/http-request.md)
* [HttpResponse](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/doc/http-response.md)
* [HttpStringResponse](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/doc/http-string-response.md)

### Utilities

* [ApiException](https://www.github.com/maxio-com/ab-java-sdk/tree/8.0.0/doc/api-exception.md)
* [ApiHelper](https://www.github.com/maxio-com/ab-java-sdk/tree/8.0.0/doc/api-helper.md)
* [FileWrapper](https://www.github.com/maxio-com/ab-java-sdk/tree/8.0.0/doc/file-wrapper.md)
* [DateTimeHelper](https://www.github.com/maxio-com/ab-java-sdk/tree/8.0.0/doc/date-time-helper.md)
* [ApiException](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/doc/api-exception.md)
* [ApiHelper](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/doc/api-helper.md)
* [FileWrapper](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/doc/file-wrapper.md)
* [DateTimeHelper](https://www.github.com/maxio-com/ab-java-sdk/tree/9.0.0/doc/date-time-helper.md)

4 changes: 2 additions & 2 deletions doc/api-exception.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ This is the base class for all exceptions that represent an error response from

| Name | Description | Return Type |
| --- | --- | --- |
| `getResponseCode()` | The HTTP response code from the API request | `int` |
| `getHeaders()` | The HTTP response body from the API request. | [`Headers`](../doc/headers.md) |
| `getResponseCode()` | The HTTP Response code from the API request | `int` |
| `getHttpContext()` | The HTTP Context from the API request. | [`HttpContext`](../doc/http-context.md) |

4 changes: 2 additions & 2 deletions 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`** |
| httpClientConfig | [`Consumer<HttpClientConfiguration.Builder>`](../doc/http-client-configuration-builder.md) | Set up Http Client Configuration instance. |
| basicAuthCredentials | [`BasicAuthCredentials`](auth/basic-authentication.md) | The Credentials Setter for Basic Authentication |

Expand All @@ -17,7 +17,6 @@ import com.maxio.advancedbilling.AdvancedBillingClient;
import com.maxio.advancedbilling.Environment;
import com.maxio.advancedbilling.authentication.BasicAuthModel;
import com.maxio.advancedbilling.exceptions.ApiException;
import java.io.IOException;

public class Program {
public static void main(String[] args) {
Expand Down Expand Up @@ -75,6 +74,7 @@ The gateway for the SDK. This class acts as a factory for the Controllers and al
| `getSubscriptionInvoiceAccountController()` | Provides access to SubscriptionInvoiceAccount controller. | `SubscriptionInvoiceAccountController` |
| `getSubscriptionNotesController()` | Provides access to SubscriptionNotes controller. | `SubscriptionNotesController` |
| `getSubscriptionProductsController()` | Provides access to SubscriptionProducts controller. | `SubscriptionProductsController` |
| `getSubscriptionRenewalsController()` | Provides access to SubscriptionRenewals controller. | `SubscriptionRenewalsController` |
| `getSubscriptionStatusController()` | Provides access to SubscriptionStatus controller. | `SubscriptionStatusController` |
| `getWebhooksController()` | Provides access to Webhooks controller. | `WebhooksController` |

Expand Down
14 changes: 5 additions & 9 deletions doc/controllers/advance-invoice.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Invoice issueAdvanceInvoice(

| 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 @@ -50,9 +50,9 @@ IssueAdvanceInvoiceRequest body = new IssueAdvanceInvoiceRequest.Builder()
try {
Invoice result = advanceInvoiceController.issueAdvanceInvoice(subscriptionId, body);
System.out.println(result);
} catch (ApiException e) {
} catch (ErrorListResponseException e) {
e.printStackTrace();
} catch (IOException e) {
} catch (ApiException e) {
e.printStackTrace();
}
```
Expand All @@ -78,7 +78,7 @@ Invoice readAdvanceInvoice(

| 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 @@ -94,8 +94,6 @@ try {
System.out.println(result);
} catch (ApiException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
```

Expand All @@ -121,7 +119,7 @@ Invoice voidAdvanceInvoice(

| 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 @@ -137,8 +135,6 @@ try {
System.out.println(result);
} catch (ApiException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
```

Expand Down
Loading
Loading