diff --git a/README.md b/README.md
index 80eb7d75..e0e863ff 100644
--- a/README.md
+++ b/README.md
@@ -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**
@@ -33,29 +32,35 @@ Install the SDK by adding the following dependency in your project's pom.xml fil
com.maxio
advanced-billing-sdk
- 6.1.0
+ 7.0.0
```
You can also view the package at:
-https://central.sonatype.com/artifact/com.maxio/advanced-billing-sdk/6.1.0
+https://central.sonatype.com/artifact/com.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-java-sdk/tree/6.1.0/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-java-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.
*Default*: `"subdomain"` |
-| `environment` | `Environment` | The API environment.
**Default: `Environment.US`** |
-| `httpClientConfig` | [`Consumer`](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.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/6.1.0/doc/auth/basic-authentication.md) | The Credentials Setter for Basic Authentication |
+| site | `String` | The subdomain for your Advanced Billing site.
*Default*: `"subdomain"` |
+| environment | `Environment` | The API environment.
**Default: `Environment.US`** |
+| httpClientConfig | [`Consumer`](https://www.github.com/maxio-com/ab-java-sdk/tree/7.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/7.0.0/doc/auth/basic-authentication.md) | The Credentials Setter for Basic Authentication |
The API client can be initialized as follows:
```java
+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;
+
AdvancedBillingClient client = new AdvancedBillingClient.Builder()
.httpClientConfig(configBuilder -> configBuilder
.timeout(0))
@@ -84,55 +89,65 @@ 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/6.1.0/doc/auth/basic-authentication.md)
+* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/auth/basic-authentication.md)
## List of APIs
-* [API Exports](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/api-exports.md)
-* [Advance Invoice](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/advance-invoice.md)
-* [Billing Portal](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/billing-portal.md)
-* [Component Price Points](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/component-price-points.md)
-* [Custom Fields](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/custom-fields.md)
-* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/events-based-billing-segments.md)
-* [Payment Profiles](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/payment-profiles.md)
-* [Product Families](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/product-families.md)
-* [Product Price Points](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/product-price-points.md)
-* [Proforma Invoices](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/proforma-invoices.md)
-* [Reason Codes](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/reason-codes.md)
-* [Referral Codes](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/referral-codes.md)
-* [Sales Commissions](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/sales-commissions.md)
-* [Subscription Components](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/subscription-components.md)
-* [Subscription Groups](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/subscription-groups.md)
-* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/subscription-group-invoice-account.md)
-* [Subscription Group Status](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/subscription-group-status.md)
-* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/subscription-invoice-account.md)
-* [Subscription Notes](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/subscription-notes.md)
-* [Subscription Products](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/subscription-products.md)
-* [Subscription Status](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/subscription-status.md)
-* [Coupons](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/coupons.md)
-* [Components](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/components.md)
-* [Customers](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/customers.md)
-* [Events](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/events.md)
-* [Insights](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/insights.md)
-* [Invoices](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/invoices.md)
-* [Offers](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/offers.md)
-* [Products](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/products.md)
-* [Sites](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/sites.md)
-* [Subscriptions](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/subscriptions.md)
-* [Webhooks](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/controllers/webhooks.md)
-
-## Classes Documentation
-
-* [Utility Classes](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/utility-classes.md)
-* [HttpRequest](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/http-request.md)
-* [HttpResponse](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/http-response.md)
-* [HttpStringResponse](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/http-string-response.md)
-* [HttpContext](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/http-context.md)
-* [HttpBodyRequest](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/http-body-request.md)
-* [HttpCallback Interface](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/http-callback-interface.md)
-* [Headers](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/headers.md)
-* [ApiException](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/api-exception.md)
-* [Configuration Interface](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/configuration-interface.md)
-* [HttpClientConfiguration](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/http-client-configuration.md)
-* [HttpClientConfiguration.Builder](https://www.github.com/maxio-com/ab-java-sdk/tree/6.1.0/doc/http-client-configuration-builder.md)
+* [API Exports](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/api-exports.md)
+* [Advance Invoice](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/advance-invoice.md)
+* [Billing Portal](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/billing-portal.md)
+* [Component Price Points](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/component-price-points.md)
+* [Custom Fields](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/custom-fields.md)
+* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/events-based-billing-segments.md)
+* [Payment Profiles](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/payment-profiles.md)
+* [Product Families](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/product-families.md)
+* [Product Price Points](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/product-price-points.md)
+* [Proforma Invoices](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/proforma-invoices.md)
+* [Reason Codes](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/reason-codes.md)
+* [Referral Codes](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/referral-codes.md)
+* [Sales Commissions](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/sales-commissions.md)
+* [Subscription Components](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/subscription-components.md)
+* [Subscription Groups](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/subscription-groups.md)
+* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/subscription-group-invoice-account.md)
+* [Subscription Group Status](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/subscription-group-status.md)
+* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/subscription-invoice-account.md)
+* [Subscription Notes](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/subscription-notes.md)
+* [Subscription Products](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/subscription-products.md)
+* [Subscription Status](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/subscription-status.md)
+* [Coupons](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/coupons.md)
+* [Components](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/components.md)
+* [Customers](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/customers.md)
+* [Events](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/events.md)
+* [Insights](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/insights.md)
+* [Invoices](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/invoices.md)
+* [Offers](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/offers.md)
+* [Products](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/products.md)
+* [Sites](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/sites.md)
+* [Subscriptions](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/subscriptions.md)
+* [Webhooks](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/controllers/webhooks.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [Configuration Interface](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/configuration-interface.md)
+* [HttpClientConfiguration](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/http-client-configuration.md)
+* [HttpClientConfiguration.Builder](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/http-client-configuration-builder.md)
+
+### HTTP
+
+* [Headers](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/headers.md)
+* [HttpCallback Interface](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/http-callback-interface.md)
+* [HttpContext](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/http-context.md)
+* [HttpBodyRequest](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/http-body-request.md)
+* [HttpRequest](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/http-request.md)
+* [HttpResponse](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/http-response.md)
+* [HttpStringResponse](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/http-string-response.md)
+
+### Utilities
+
+* [ApiException](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/api-exception.md)
+* [ApiHelper](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/api-helper.md)
+* [FileWrapper](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/file-wrapper.md)
+* [DateTimeHelper](https://www.github.com/maxio-com/ab-java-sdk/tree/7.0.0/doc/date-time-helper.md)
diff --git a/doc/api-exception.md b/doc/api-exception.md
index 593ee783..a57e999b 100644
--- a/doc/api-exception.md
+++ b/doc/api-exception.md
@@ -1,5 +1,5 @@
-# ApiException Class
+# ApiException
This is the base class for all exceptions that represent an error response from the server.
@@ -8,12 +8,12 @@ This is the base class for all exceptions that represent an error response from
| Name | Description |
| --- | --- |
| `ApiException(String reason)` | Initialization constructor. |
-| `ApiException(String reason,` [`HttpContext`](http-context.md) `context)` | Initialization constructor. |
+| ApiException(String reason, [`HttpContext`](../doc/http-context.md) context) | Initialization constructor. |
## Methods
| Name | Description | Return Type |
| --- | --- | --- |
| `getResponseCode()` | The HTTP response code from the API request | `int` |
-| `getHeaders()` | The HTTP response body from the API request. | [`Headers`](headers.md) |
+| `getHeaders()` | The HTTP response body from the API request. | [`Headers`](../doc/headers.md) |
diff --git a/doc/api-helper.md b/doc/api-helper.md
new file mode 100644
index 00000000..b24a9666
--- /dev/null
+++ b/doc/api-helper.md
@@ -0,0 +1,21 @@
+
+# ApiHelper
+
+This is a Helper class with commonly used utilities for the SDK.
+
+## Fields
+
+| Name | Description | Type |
+| --- | --- | --- |
+| mapper | Deserialization of Json data. | `ObjectMapper` |
+
+## Methods
+
+| Name | Description | Return Type |
+| --- | --- | --- |
+| `serialize(Object obj)` | Json Serialization of a given object. | `String` |
+| `deserialize(String json)` | Json deserialization of the given Json string. | `LinkedHashMap` |
+| `deserialize(String json, Class clazz)` | Json deserialization of the given Json string. | ` T` |
+| `deserialize(String json, TypeReference typeReference)` | JSON Deserialization of the given json string. | ` T` |
+| `deserializeArray(String json, Class classArray)` | JSON Deserialization of the given json string. | ` List` |
+
diff --git a/doc/auth/basic-authentication.md b/doc/auth/basic-authentication.md
index 0dc3d4a0..bb18ddbd 100644
--- a/doc/auth/basic-authentication.md
+++ b/doc/auth/basic-authentication.md
@@ -23,6 +23,9 @@ Documentation for accessing and setting credentials for BasicAuth.
You must provide credentials in the client as shown in the following code snippet.
```java
+import com.maxio.advancedbilling.AdvancedBillingClient;
+import com.maxio.advancedbilling.authentication.BasicAuthModel;
+
AdvancedBillingClient client = new AdvancedBillingClient.Builder()
.basicAuthCredentials(new BasicAuthModel.Builder(
"BasicAuthUserName",
diff --git a/doc/client.md b/doc/client.md
index 4cfa7feb..95473ddb 100644
--- a/doc/client.md
+++ b/doc/client.md
@@ -5,14 +5,20 @@ The following parameters are configurable for the API Client:
| Parameter | Type | Description |
| --- | --- | --- |
-| `site` | `String` | The subdomain for your Advanced Billing site.
*Default*: `"subdomain"` |
-| `environment` | `Environment` | The API environment.
**Default: `Environment.US`** |
-| `httpClientConfig` | [`Consumer`](http-client-configuration-builder.md) | Set up Http Client Configuration instance. |
-| `basicAuthCredentials` | [`BasicAuthCredentials`](auth/basic-authentication.md) | The Credentials Setter for Basic Authentication |
+| site | `String` | The subdomain for your Advanced Billing site.
*Default*: `"subdomain"` |
+| environment | `Environment` | The API environment.
**Default: `Environment.US`** |
+| httpClientConfig | [`Consumer`](../doc/http-client-configuration-builder.md) | Set up Http Client Configuration instance. |
+| basicAuthCredentials | [`BasicAuthCredentials`](auth/basic-authentication.md) | The Credentials Setter for Basic Authentication |
The API client can be initialized as follows:
```java
+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;
+
AdvancedBillingClient client = new AdvancedBillingClient.Builder()
.httpClientConfig(configBuilder -> configBuilder
.timeout(0))
@@ -75,7 +81,7 @@ The gateway for the SDK. This class acts as a factory for the Controllers and al
| `getEnvironment()` | Current API environment. | `Environment` |
| `getSite()` | The subdomain for your Advanced Billing site. | `String` |
| `getHttpClient()` | The HTTP Client instance to use for making HTTP requests. | `HttpClient` |
-| `getHttpClientConfig()` | Http Client Configuration instance. | [`ReadonlyHttpClientConfiguration`](http-client-configuration.md) |
+| `getHttpClientConfig()` | Http Client Configuration instance. | [`ReadonlyHttpClientConfiguration`](../doc/http-client-configuration.md) |
| `getBasicAuthCredentials()` | The credentials to use with BasicAuth. | [`BasicAuthCredentials`](auth/basic-authentication.md) |
| `getBaseUri(Server server)` | Get base URI by current environment | `String` |
| `getBaseUri()` | Get base URI by current environment | `String` |
diff --git a/doc/configuration-interface.md b/doc/configuration-interface.md
index 59568589..4ea2e5a6 100644
--- a/doc/configuration-interface.md
+++ b/doc/configuration-interface.md
@@ -9,7 +9,7 @@ This is the interface for client class that holds the configuration getters.
| --- | --- | --- |
| `getEnvironment()` | Current API environment. | `Environment` |
| `getSite()` | The subdomain for your Advanced Billing site. | `String` |
-| `getHttpClientConfig()` | Http Client Configuration instance. | [`ReadonlyHttpClientConfiguration`](http-client-configuration.md) |
+| `getHttpClientConfig()` | Http Client Configuration instance. | [`ReadonlyHttpClientConfiguration`](../doc/http-client-configuration.md) |
| `getBaseUri(Server server)` | Get base URI by current environment. | `String` |
| `getBaseUri()` | Get base URI by current environment. | `String` |
diff --git a/doc/controllers/api-exports.md b/doc/controllers/api-exports.md
index 51942c16..53c40dec 100644
--- a/doc/controllers/api-exports.md
+++ b/doc/controllers/api-exports.md
@@ -37,8 +37,8 @@ List listExportedProformaInvoices(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `batchId` | `String` | Template, Required | Id of a Batch Job. |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request.
Default value is 100.
The maximum allowed values is 10000; any per_page value over 10000 will be changed to 10000.
**Default**: `100`
**Constraints**: `>= 1`, `<= 10000` |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request.
Default value is 100.
The maximum allowed values is 10000; any per_page value over 10000 will be changed to 10000.
**Default**: `100`
**Constraints**: `>= 1`, `<= 10000` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
## Response Type
@@ -87,8 +87,8 @@ List listExportedInvoices(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `batchId` | `String` | Template, Required | Id of a Batch Job. |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request.
Default value is 100.
The maximum allowed values is 10000; any per_page value over 10000 will be changed to 10000.
**Default**: `100`
**Constraints**: `>= 1`, `<= 10000` |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request.
Default value is 100.
The maximum allowed values is 10000; any per_page value over 10000 will be changed to 10000.
**Default**: `100`
**Constraints**: `>= 1`, `<= 10000` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
## Response Type
@@ -137,8 +137,8 @@ List listExportedSubscriptions(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `batchId` | `String` | Template, Required | Id of a Batch Job. |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request.
Default value is 100.
The maximum allowed values is 10000; any per_page value over 10000 will be changed to 10000.
**Default**: `100`
**Constraints**: `>= 1`, `<= 10000` |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request.
Default value is 100.
The maximum allowed values is 10000; any per_page value over 10000 will be changed to 10000.
**Default**: `100`
**Constraints**: `>= 1`, `<= 10000` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
## Response Type
diff --git a/doc/controllers/component-price-points.md b/doc/controllers/component-price-points.md
index 47b2364f..85e056ae 100644
--- a/doc/controllers/component-price-points.md
+++ b/doc/controllers/component-price-points.md
@@ -149,6 +149,7 @@ CreateComponentPricePointRequest body = new CreateComponentPricePointRequest.Bui
"4.00"
)
)
+ .endingQuantity(null)
.build()
)
)
@@ -197,8 +198,8 @@ ComponentPricePointsResponse listComponentPricePoints(
| --- | --- | --- | --- |
| `componentId` | `int` | Template, Required | The Advanced Billing id of the component |
| `currencyPrices` | `Boolean` | Query, Optional | Include an array of currency price data |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `filterType` | [`List`](../../doc/models/price-point-type.md) | Query, Optional | Use in query: `filter[type]=catalog,default`. |
## Response Type
@@ -213,7 +214,8 @@ ListComponentPricePointsInput listComponentPricePointsInput = new ListComponentP
)
.page(2)
.perPage(50)
-Liquid error: Value cannot be null. (Parameter 'key').build();
+.filterType(Liquid error: Value cannot be null. (Parameter 'key'))
+.build();
try {
ComponentPricePointsResponse result = componentPricePointsController.listComponentPricePoints(listComponentPricePointsInput);
@@ -881,8 +883,8 @@ ListComponentsPricePointsResponse listAllComponentPricePoints(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `include` | [`ListComponentsPricePointsInclude`](../../doc/models/list-components-price-points-include.md) | Query, Optional | Allows including additional data in the response. Use in query: `include=currency_prices`. |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `direction` | [`SortingDirection`](../../doc/models/sorting-direction.md) | Query, Optional | Controls the order in which results are returned.
Use in query `direction=asc`. |
| `filter` | [`ListPricePointsFilter`](../../doc/models/list-price-points-filter.md) | Query, Optional | Filter to use for List PricePoints operations |
diff --git a/doc/controllers/components.md b/doc/controllers/components.md
index 867ead59..111082de 100644
--- a/doc/controllers/components.md
+++ b/doc/controllers/components.md
@@ -722,7 +722,7 @@ ComponentResponse readComponent(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `productFamilyId` | `int` | Template, Required | The Advanced Billing id of the product family to which the component belongs |
-| `componentId` | `String` | Template, Required | Either the Advanced Billing id of the component or the handle for the component prefixed with `handle:`
**Constraints**: *Pattern*: `/\A(?:\d+\|handle:(?:uuid:\|[a-z])(?:\w\|-)+)\z/` |
+| `componentId` | `String` | Template, Required | Either the Advanced Billing id of the component or the handle for the component prefixed with `handle:`
**Constraints**: *Pattern*: `/\A(?:\d+\|handle:(?:uuid:\|[a-z])(?:\w\|-)+)\z/` |
## Response Type
@@ -769,7 +769,8 @@ try {
"downgrade_credit": null,
"created_at": "2019-08-02T05:54:53-04:00",
"default_price_point_name": "Original",
- "product_family_name": "Chargify"
+ "product_family_name": "Chargify",
+ "product_family_handle": "chargify"
}
}
```
@@ -793,7 +794,7 @@ ComponentResponse updateProductFamilyComponent(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `productFamilyId` | `int` | Template, Required | The Advanced Billing id of the product family to which the component belongs |
-| `componentId` | `String` | Template, Required | Either the Advanced Billing id of the component or the handle for the component prefixed with `handle:`
**Constraints**: *Pattern*: `/\A(?:\d+\|handle:(?:uuid:\|[a-z])(?:\w\|-)+)\z/` |
+| `componentId` | `String` | Template, Required | Either the Advanced Billing id of the component or the handle for the component prefixed with `handle:`
**Constraints**: *Pattern*: `/\A(?:\d+\|handle:(?:uuid:\|[a-z])(?:\w\|-)+)\z/` |
| `body` | [`UpdateComponentRequest`](../../doc/models/update-component-request.md) | Body, Optional | - |
## Response Type
@@ -874,7 +875,7 @@ Component archiveComponent(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `productFamilyId` | `int` | Template, Required | The Advanced Billing id of the product family to which the component belongs |
-| `componentId` | `String` | Template, Required | Either the Advanced Billing id of the component or the handle for the component prefixed with `handle:`
**Constraints**: *Pattern*: `/\A(?:\d+\|handle:(?:uuid:\|[a-z])(?:\w\|-)+)\z/` |
+| `componentId` | `String` | Template, Required | Either the Advanced Billing id of the component or the handle for the component prefixed with `handle:`
**Constraints**: *Pattern*: `/\A(?:\d+\|handle:(?:uuid:\|[a-z])(?:\w\|-)+)\z/` |
## Response Type
@@ -948,8 +949,8 @@ List listComponents(
| `startDatetime` | `String` | Query, Optional | The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns components with a timestamp at or after exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of start_date. |
| `endDatetime` | `String` | Query, Optional | The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns components with a timestamp at or before exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of end_date. optional |
| `includeArchived` | `Boolean` | Query, Optional | Include archived items |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `filter` | [`ListComponentsFilter`](../../doc/models/list-components-filter.md) | Query, Optional | Filter to use for List Components operations |
## Response Type
@@ -1020,6 +1021,7 @@ try {
"created_at": "2019-08-01T09:35:38-04:00",
"default_price_point_name": "Original",
"product_family_name": "Chargify",
+ "product_family_handle": "chargify",
"use_site_exchange_rate": true
}
},
@@ -1046,6 +1048,7 @@ try {
"created_at": "2019-08-01T09:35:37-04:00",
"default_price_point_name": "Original",
"product_family_name": "Chargify",
+ "product_family_handle": "chargify",
"use_site_exchange_rate": true
}
},
@@ -1072,6 +1075,7 @@ try {
"created_at": "2019-08-01T09:35:38-04:00",
"default_price_point_name": "Original",
"product_family_name": "Chargify",
+ "product_family_handle": "chargify",
"use_site_exchange_rate": true
}
}
@@ -1175,8 +1179,8 @@ List listComponentsForProductFamily(
| --- | --- | --- | --- |
| `productFamilyId` | `int` | Template, Required | The Advanced Billing id of the product family |
| `includeArchived` | `Boolean` | Query, Optional | Include archived items. |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `filter` | [`ListComponentsFilter`](../../doc/models/list-components-filter.md) | Query, Optional | Filter to use for List Components operations |
| `dateField` | [`BasicDateField`](../../doc/models/basic-date-field.md) | Query, Optional | The type of filter you would like to apply to your search. Use in query `date_field=created_at`. |
| `endDate` | `String` | Query, Optional | The end date (format YYYY-MM-DD) with which to filter the date_field. Returns components with a timestamp up to and including 11:59:59PM in your site’s time zone on the date specified. |
diff --git a/doc/controllers/coupons.md b/doc/controllers/coupons.md
index e89204b4..23fe333d 100644
--- a/doc/controllers/coupons.md
+++ b/doc/controllers/coupons.md
@@ -123,8 +123,8 @@ List listCouponsForProductFamily(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `productFamilyId` | `int` | Template, Required | The Advanced Billing id of the product family to which the coupon belongs |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 30. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `30`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 30. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `30`
**Constraints**: `<= 200` |
| `filter` | [`ListCouponsFilter`](../../doc/models/list-coupons-filter.md) | Query, Optional | Filter to use for List Coupons operations |
| `currencyPrices` | `Boolean` | Query, Optional | When fetching coupons, if you have defined multiple currencies at the site level, you can optionally pass the `?currency_prices=true` query param to include an array of currency price data in the response. Use in query `currency_prices=true`. |
@@ -563,8 +563,8 @@ List listCoupons(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 30. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `30`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 30. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `30`
**Constraints**: `<= 200` |
| `filter` | [`ListCouponsFilter`](../../doc/models/list-coupons-filter.md) | Query, Optional | Filter to use for List Coupons operations |
| `currencyPrices` | `Boolean` | Query, Optional | When fetching coupons, if you have defined multiple currencies at the site level, you can optionally pass the `?currency_prices=true` query param to include an array of currency price data in the response. Use in query `currency_prices=true`. |
@@ -988,8 +988,8 @@ CouponSubcodes listCouponSubcodes(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `couponId` | `int` | Template, Required | The Advanced Billing id of the coupon |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
## Response Type
diff --git a/doc/controllers/custom-fields.md b/doc/controllers/custom-fields.md
index 85171b26..f33d00e7 100644
--- a/doc/controllers/custom-fields.md
+++ b/doc/controllers/custom-fields.md
@@ -42,7 +42,7 @@ Each site is limited to 100 unique Metafields (i.e. keys, or names) per resource
### Metafields "On-the-Fly"
-It is possible to create Metafields “on the fly” when you create your Metadata – if a non-existant name is passed when creating Metadata, a Metafield for that key will be automatically created. The Metafield API, however, gives you more control over your “keys”.
+It is possible to create Metafields “on the fly” when you create your Metadata – if a non-existent name is passed when creating Metadata, a Metafield for that key will be automatically created. The Metafield API, however, gives you more control over your “keys”.
### Metafield Scope Warning
@@ -150,8 +150,8 @@ ListMetafieldsResponse listMetafields(
| --- | --- | --- | --- |
| `resourceType` | [`ResourceType`](../../doc/models/resource-type.md) | Template, Required | the resource type to which the metafields belong |
| `name` | `String` | Query, Optional | filter by the name of the metafield |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `direction` | [`SortingDirection`](../../doc/models/sorting-direction.md) | Query, Optional | Controls the order in which results are returned.
Use in query `direction=asc`. |
## Response Type
@@ -392,8 +392,8 @@ PaginatedMetadata listMetadata(
| --- | --- | --- | --- |
| `resourceType` | [`ResourceType`](../../doc/models/resource-type.md) | Template, Required | the resource type to which the metafields belong |
| `resourceId` | `int` | Template, Required | The Advanced Billing id of the customer or the subscription for which the metadata applies |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
## Response Type
@@ -560,15 +560,15 @@ PaginatedMetadata listMetadataForResourceType(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `resourceType` | [`ResourceType`](../../doc/models/resource-type.md) | Template, Required | the resource type to which the metafields belong |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `dateField` | [`BasicDateField`](../../doc/models/basic-date-field.md) | Query, Optional | The type of filter you would like to apply to your search. |
| `startDate` | `LocalDate` | Query, Optional | The start date (format YYYY-MM-DD) with which to filter the date_field. Returns metadata with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified. |
| `endDate` | `LocalDate` | Query, Optional | The end date (format YYYY-MM-DD) with which to filter the date_field. Returns metadata with a timestamp up to and including 11:59:59PM in your site’s time zone on the date specified. |
| `startDatetime` | `ZonedDateTime` | Query, Optional | The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns metadata with a timestamp at or after exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of start_date. |
| `endDatetime` | `ZonedDateTime` | Query, Optional | The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns metadata with a timestamp at or before exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of end_date. |
| `withDeleted` | `Boolean` | Query, Optional | Allow to fetch deleted metadata. |
-| `resourceIds` | `List` | Query, Optional | Allow to fetch metadata for multiple records based on provided ids. Use in query: `resource_ids[]=122&resource_ids[]=123&resource_ids[]=124`.
**Constraints**: *Maximum Items*: `50` |
+| `resourceIds` | `List` | Query, Optional | Allow to fetch metadata for multiple records based on provided ids. Use in query: `resource_ids[]=122&resource_ids[]=123&resource_ids[]=124`.
**Constraints**: *Maximum Items*: `50` |
| `direction` | [`SortingDirection`](../../doc/models/sorting-direction.md) | Query, Optional | Controls the order in which results are returned.
Use in query `direction=asc`. |
## Response Type
diff --git a/doc/controllers/customers.md b/doc/controllers/customers.md
index a2a13f7e..2b7c4ae5 100644
--- a/doc/controllers/customers.md
+++ b/doc/controllers/customers.md
@@ -165,8 +165,8 @@ List listCustomers(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `direction` | [`SortingDirection`](../../doc/models/sorting-direction.md) | Query, Optional | Direction to sort customers by time of creation |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 50. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `50`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 50. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `50`
**Constraints**: `<= 200` |
| `dateField` | [`BasicDateField`](../../doc/models/basic-date-field.md) | Query, Optional | The type of filter you would like to apply to your search.
Use in query: `date_field=created_at`. |
| `startDate` | `String` | Query, Optional | The start date (format YYYY-MM-DD) with which to filter the date_field. Returns subscriptions with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified. |
| `endDate` | `String` | Query, Optional | The end date (format YYYY-MM-DD) with which to filter the date_field. Returns subscriptions with a timestamp up to and including 11:59:59PM in your site’s time zone on the date specified. |
diff --git a/doc/controllers/events-based-billing-segments.md b/doc/controllers/events-based-billing-segments.md
index a0450ade..17b841f8 100644
--- a/doc/controllers/events-based-billing-segments.md
+++ b/doc/controllers/events-based-billing-segments.md
@@ -116,8 +116,8 @@ ListSegmentsResponse listSegmentsForPricePoint(
| --- | --- | --- | --- |
| `componentId` | `String` | Template, Required | ID or Handle for the Component |
| `pricePointId` | `String` | Template, Required | ID or Handle for the Price Point belonging to the Component |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 30. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `30`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 30. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `30`
**Constraints**: `<= 200` |
| `filter` | [`ListSegmentsFilter`](../../doc/models/list-segments-filter.md) | Query, Optional | Filter to use for List Segments for a Price Point operation |
## Response Type
diff --git a/doc/controllers/events.md b/doc/controllers/events.md
index 43fab79b..d9431561 100644
--- a/doc/controllers/events.md
+++ b/doc/controllers/events.md
@@ -95,11 +95,11 @@ List listEvents(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `sinceId` | `Long` | Query, Optional | Returns events with an id greater than or equal to the one specified |
| `maxId` | `Long` | Query, Optional | Returns events with an id less than or equal to the one specified |
-| `direction` | [`Direction`](../../doc/models/direction.md) | Query, Optional | The sort direction of the returned events.
**Default**: `Direction.DESC` |
+| `direction` | [`Direction`](../../doc/models/direction.md) | Query, Optional | The sort direction of the returned events.
**Default**: `Direction.DESC` |
| `filter` | [`List`](../../doc/models/event-key.md) | Query, Optional | You can pass multiple event keys after comma.
Use in query `filter=signup_success,payment_success`. |
| `dateField` | [`ListEventsDateField`](../../doc/models/list-events-date-field.md) | Query, Optional | The type of filter you would like to apply to your search. |
| `startDate` | `String` | Query, Optional | The start date (format YYYY-MM-DD) with which to filter the date_field. Returns components with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified. |
@@ -222,11 +222,11 @@ List listSubscriptionEvents(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `subscriptionId` | `int` | Template, Required | The Chargify id of the subscription |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `sinceId` | `Long` | Query, Optional | Returns events with an id greater than or equal to the one specified |
| `maxId` | `Long` | Query, Optional | Returns events with an id less than or equal to the one specified |
-| `direction` | [`Direction`](../../doc/models/direction.md) | Query, Optional | The sort direction of the returned events.
**Default**: `Direction.DESC` |
+| `direction` | [`Direction`](../../doc/models/direction.md) | Query, Optional | The sort direction of the returned events.
**Default**: `Direction.DESC` |
| `filter` | [`List`](../../doc/models/event-key.md) | Query, Optional | You can pass multiple event keys after comma.
Use in query `filter=signup_success,payment_success`. |
## Response Type
@@ -315,11 +315,11 @@ CountResponse readEventsCount(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `sinceId` | `Long` | Query, Optional | Returns events with an id greater than or equal to the one specified |
| `maxId` | `Long` | Query, Optional | Returns events with an id less than or equal to the one specified |
-| `direction` | [`Direction`](../../doc/models/direction.md) | Query, Optional | The sort direction of the returned events.
**Default**: `Direction.DESC` |
+| `direction` | [`Direction`](../../doc/models/direction.md) | Query, Optional | The sort direction of the returned events.
**Default**: `Direction.DESC` |
| `filter` | [`List`](../../doc/models/event-key.md) | Query, Optional | You can pass multiple event keys after comma.
Use in query `filter=signup_success,payment_success`. |
## Response Type
diff --git a/doc/controllers/insights.md b/doc/controllers/insights.md
index 0864228c..4d7b96d2 100644
--- a/doc/controllers/insights.md
+++ b/doc/controllers/insights.md
@@ -22,7 +22,7 @@ The Stats API is a very basic view of some Site-level stats. This API call only
## Stats Documentation
-There currently is not a complimentary matching set of documentation that compliments this endpoint. However, each Site's dashboard will reflect the summary of information provided in the Stats reposnse.
+There currently is not a complimentary matching set of documentation that compliments this endpoint. However, each Site's dashboard will reflect the summary of information provided in the Stats response.
```
https://subdomain.chargify.com/dashboard
@@ -165,8 +165,8 @@ ListMRRResponse listMrrMovements(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `subscriptionId` | `Integer` | Query, Optional | optionally filter results by subscription |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 10. The maximum allowed values is 50; any per_page value over 50 will be changed to 50.
Use in query `per_page=20`.
**Default**: `10`
**Constraints**: `<= 50` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 10. The maximum allowed values is 50; any per_page value over 50 will be changed to 50.
Use in query `per_page=20`.
**Default**: `10`
**Constraints**: `<= 50` |
| `direction` | [`SortingDirection`](../../doc/models/sorting-direction.md) | Query, Optional | Controls the order in which results are returned.
Use in query `direction=asc`. |
## Response Type
@@ -261,8 +261,8 @@ SubscriptionMRRResponse listMrrPerSubscription(
| --- | --- | --- | --- |
| `filter` | [`ListMrrFilter`](../../doc/models/list-mrr-filter.md) | Query, Optional | Filter to use for List MRR per subscription operation |
| `atTime` | `String` | Query, Optional | Submit a timestamp in ISO8601 format to request MRR for a historic time. Use in query: `at_time=2022-01-10T10:00:00-05:00`. |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `direction` | [`Direction`](../../doc/models/direction.md) | Query, Optional | Controls the order in which results are returned. Records are ordered by subscription_id in ascending order by default. Use in query `direction=desc`. |
## Response Type
diff --git a/doc/controllers/invoices.md b/doc/controllers/invoices.md
index d1a7b438..619ce854 100644
--- a/doc/controllers/invoices.md
+++ b/doc/controllers/invoices.md
@@ -110,23 +110,24 @@ ListInvoicesResponse listInvoices(
| `status` | [`InvoiceStatus`](../../doc/models/invoice-status.md) | Query, Optional | The current status of the invoice. Allowed Values: draft, open, paid, pending, voided |
| `subscriptionId` | `Integer` | Query, Optional | The subscription's ID. |
| `subscriptionGroupUid` | `String` | Query, Optional | The UID of the subscription group you want to fetch consolidated invoices for. This will return a paginated list of consolidated invoices for the specified group. |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
-| `direction` | [`Direction`](../../doc/models/direction.md) | Query, Optional | The sort direction of the returned invoices.
**Default**: `Direction.DESC` |
-| `lineItems` | `Boolean` | Query, Optional | Include line items data
**Default**: `false` |
-| `discounts` | `Boolean` | Query, Optional | Include discounts data
**Default**: `false` |
-| `taxes` | `Boolean` | Query, Optional | Include taxes data
**Default**: `false` |
-| `credits` | `Boolean` | Query, Optional | Include credits data
**Default**: `false` |
-| `payments` | `Boolean` | Query, Optional | Include payments data
**Default**: `false` |
-| `customFields` | `Boolean` | Query, Optional | Include custom fields data
**Default**: `false` |
-| `refunds` | `Boolean` | Query, Optional | Include refunds data
**Default**: `false` |
-| `dateField` | [`InvoiceDateField`](../../doc/models/invoice-date-field.md) | Query, Optional | The type of filter you would like to apply to your search. Use in query `date_field=issue_date`.
**Default**: `InvoiceDateField.DUE_DATE` |
+| `consolidationLevel` | `String` | Query, Optional | The consolidation level of the invoice. Allowed Values: none, parent, child or comma-separated lists of thereof, e.g. none,parent. |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `direction` | [`Direction`](../../doc/models/direction.md) | Query, Optional | The sort direction of the returned invoices.
**Default**: `Direction.DESC` |
+| `lineItems` | `Boolean` | Query, Optional | Include line items data
**Default**: `false` |
+| `discounts` | `Boolean` | Query, Optional | Include discounts data
**Default**: `false` |
+| `taxes` | `Boolean` | Query, Optional | Include taxes data
**Default**: `false` |
+| `credits` | `Boolean` | Query, Optional | Include credits data
**Default**: `false` |
+| `payments` | `Boolean` | Query, Optional | Include payments data
**Default**: `false` |
+| `customFields` | `Boolean` | Query, Optional | Include custom fields data
**Default**: `false` |
+| `refunds` | `Boolean` | Query, Optional | Include refunds data
**Default**: `false` |
+| `dateField` | [`InvoiceDateField`](../../doc/models/invoice-date-field.md) | Query, Optional | The type of filter you would like to apply to your search. Use in query `date_field=issue_date`.
**Default**: `InvoiceDateField.DUE_DATE` |
| `startDatetime` | `String` | Query, Optional | The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns invoices with a timestamp at or after exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of start_date. Allowed to be used only along with date_field set to created_at or updated_at. |
| `endDatetime` | `String` | Query, Optional | The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns invoices with a timestamp at or before exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of end_date. Allowed to be used only along with date_field set to created_at or updated_at. |
| `customerIds` | `List` | Query, Optional | Allows fetching invoices with matching customer id based on provided values. Use in query `customer_ids=1,2,3`. |
| `number` | `List` | Query, Optional | Allows fetching invoices with matching invoice number based on provided values. Use in query `number=1234,1235`. |
| `productIds` | `List` | Query, Optional | Allows fetching invoices with matching line items product ids based on provided values. Use in query `product_ids=23,34`. |
-| `sort` | [`InvoiceSortField`](../../doc/models/invoice-sort-field.md) | Query, Optional | Allows specification of the order of the returned list. Use in query `sort=total_amount`.
**Default**: `InvoiceSortField.NUMBER` |
+| `sort` | [`InvoiceSortField`](../../doc/models/invoice-sort-field.md) | Query, Optional | Allows specification of the order of the returned list. Use in query `sort=total_amount`.
**Default**: `InvoiceSortField.NUMBER` |
## Response Type
@@ -595,7 +596,8 @@ try {
"type": "credit_card"
},
"transaction_id": 253028955,
- "prepayment": false
+ "prepayment": false,
+ "received_on": "2018-07-26"
}
],
"public_url": "https://www.chargifypay.com/invoice/inv_8jzrw74xq8kxr?token=fb6kpjz5rcr2vttyjs4rcv6y"
@@ -641,8 +643,8 @@ ListInvoiceEventsResponse listInvoiceEvents(
| --- | --- | --- | --- |
| `sinceDate` | `String` | Query, Optional | The timestamp in a format `YYYY-MM-DD T HH:MM:SS Z`, or `YYYY-MM-DD`(in this case, it returns data from the beginning of the day). of the event from which you want to start the search. All the events before the `since_date` timestamp are not returned in the response. |
| `sinceId` | `Long` | Query, Optional | The ID of the event from which you want to start the search(ID is not included. e.g. if ID is set to 2, then all events with ID 3 and more will be shown) This parameter is not used if since_date is defined. |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 100. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
**Default**: `100` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 100. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
**Default**: `100` |
| `invoiceUid` | `String` | Query, Optional | Providing an invoice_uid allows for scoping of the invoice events to a single invoice or credit note. |
| `withChangeInvoiceStatus` | `String` | Query, Optional | Use this parameter if you want to fetch also invoice events with change_invoice_status type. |
| `eventTypes` | [`List`](../../doc/models/invoice-event-type.md) | Query, Optional | Filter results by event_type. Supply a comma separated list of event types (listed above). Use in query: `event_types=void_invoice,void_remainder`. |
@@ -1055,51 +1057,7 @@ try {
# Record Payment for Invoice
-This API call should be used when you want to record a payment of a given type against a specific invoice. If you would like to apply a payment across multiple invoices, you can use the Bulk Payment endpoint.
-
-## Create a Payment from the existing payment profile
-
-In order to apply a payment to an invoice using an existing payment profile, specify `type` as `payment`, the amount less than the invoice total, and the customer's `payment_profile_id`. The ID of a payment profile might be retrieved via the Payment Profiles API endpoint.
-
-```
-{
- "type": "payment",
- "payment": {
- "amount": 10.00,
- "payment_profile_id": 123
- }
-}
-```
-
-## Create a Payment from the Subscription's Prepayment Account
-
-In order apply a prepayment to an invoice, specify the `type` as `prepayment`, and also the `amount`.
-
-```
-{
- "type": "prepayment",
- "payment": {
- "amount": 10.00
- }
-}
-```
-
-Note that the `amount` must be less than or equal to the Subscription's Prepayment account balance.
-
-## Create a Payment from the Subscription's Service Credit Account
-
-In order to apply a service credit to an invoice, specify the `type` as `service_credit`, and also the `amount`:
-
-```
-{
- "type": "service_credit",
- "payment": {
- "amount": 10.00
- }
-}
-```
-
-Note that Advanced Billing will attempt to fully pay the invoice's `due_amount` from the Subscription's Service Credit account. At this time, partial payments from a Service Credit Account are only allowed for consolidated invoices (subscription groups). Therefore, for normal invoices the Service Credit account balance must be greater than or equal to the invoice's `due_amount`.
+Applies a payment of a given type against a specific invoice. If you would like to apply a payment across multiple invoices, you can use the Bulk Payment endpoint.
```java
Invoice recordPaymentForInvoice(
@@ -1280,13 +1238,13 @@ ListCreditNotesResponse listCreditNotes(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `subscriptionId` | `Integer` | Query, Optional | The subscription's Advanced Billing id |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
-| `lineItems` | `Boolean` | Query, Optional | Include line items data
**Default**: `false` |
-| `discounts` | `Boolean` | Query, Optional | Include discounts data
**Default**: `false` |
-| `taxes` | `Boolean` | Query, Optional | Include taxes data
**Default**: `false` |
-| `refunds` | `Boolean` | Query, Optional | Include refunds data
**Default**: `false` |
-| `applications` | `Boolean` | Query, Optional | Include applications data
**Default**: `false` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `lineItems` | `Boolean` | Query, Optional | Include line items data
**Default**: `false` |
+| `discounts` | `Boolean` | Query, Optional | Include discounts data
**Default**: `false` |
+| `taxes` | `Boolean` | Query, Optional | Include taxes data
**Default**: `false` |
+| `refunds` | `Boolean` | Query, Optional | Include refunds data
**Default**: `false` |
+| `applications` | `Boolean` | Query, Optional | Include applications data
**Default**: `false` |
## Response Type
@@ -2160,9 +2118,9 @@ ConsolidatedInvoice listConsolidatedInvoiceSegments(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `invoiceUid` | `String` | Template, Required | The unique identifier of the consolidated invoice |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
-| `direction` | [`Direction`](../../doc/models/direction.md) | Query, Optional | Sort direction of the returned segments.
**Default**: `Direction.ASC` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `direction` | [`Direction`](../../doc/models/direction.md) | Query, Optional | Sort direction of the returned segments.
**Default**: `Direction.ASC` |
## Response Type
diff --git a/doc/controllers/offers.md b/doc/controllers/offers.md
index 6c7da68d..9c7cf3bc 100644
--- a/doc/controllers/offers.md
+++ b/doc/controllers/offers.md
@@ -144,8 +144,8 @@ ListOffersResponse listOffers(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `includeArchived` | `Boolean` | Query, Optional | Include archived products. Use in query: `include_archived=true`. |
## Response Type
diff --git a/doc/controllers/payment-profiles.md b/doc/controllers/payment-profiles.md
index d340e685..e9a860fe 100644
--- a/doc/controllers/payment-profiles.md
+++ b/doc/controllers/payment-profiles.md
@@ -390,8 +390,8 @@ List listPaymentProfiles(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `customerId` | `Integer` | Query, Optional | The ID of the customer for which you wish to list payment profiles |
## Response Type
@@ -425,6 +425,8 @@ try {
"id": 10089892,
"first_name": "Chester",
"last_name": "Tester",
+ "created_at": "2025-01-01T00:00:00-05:00",
+ "updated_at": "2025-01-01T00:00:00-05:00",
"customer_id": 14543792,
"current_vault": "bogus",
"vault_token": "0011223344",
@@ -451,6 +453,8 @@ try {
"id": 10188522,
"first_name": "Frankie",
"last_name": "Tester",
+ "created_at": "2025-01-01T00:00:00-05:00",
+ "updated_at": "2025-01-01T00:00:00-05:00",
"customer_id": 14543712,
"current_vault": "bogus",
"vault_token": "123456789",
@@ -492,6 +496,8 @@ Example response for Bank Account:
"id": 10089892,
"first_name": "Chester",
"last_name": "Tester",
+ "created_at": "2025-01-01T00:00:00-05:00",
+ "updated_at": "2025-01-01T00:00:00-05:00",
"customer_id": 14543792,
"current_vault": "bogus",
"vault_token": "0011223344",
@@ -556,6 +562,8 @@ try {
"card_type": "bogus",
"expiration_month": 1,
"expiration_year": 2022,
+ "created_at": "2025-01-01T00:00:00-05:00",
+ "updated_at": "2025-01-01T00:00:00-05:00",
"customer_id": 14543792,
"current_vault": "bogus",
"vault_token": "1",
diff --git a/doc/controllers/product-families.md b/doc/controllers/product-families.md
index 1beac8e1..14414516 100644
--- a/doc/controllers/product-families.md
+++ b/doc/controllers/product-families.md
@@ -30,8 +30,8 @@ List listProductsForProductFamily(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `productFamilyId` | `String` | Template, Required | Either the product family's id or its handle prefixed with `handle:` |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `dateField` | [`BasicDateField`](../../doc/models/basic-date-field.md) | Query, Optional | The type of filter you would like to apply to your search.
Use in query: `date_field=created_at`. |
| `filter` | [`ListProductsFilter`](../../doc/models/list-products-filter.md) | Query, Optional | Filter to use for List Products operations |
| `startDate` | `LocalDate` | Query, Optional | The start date (format YYYY-MM-DD) with which to filter the date_field. Returns products with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified. |
diff --git a/doc/controllers/product-price-points.md b/doc/controllers/product-price-points.md
index 1dbaf060..24761332 100644
--- a/doc/controllers/product-price-points.md
+++ b/doc/controllers/product-price-points.md
@@ -128,8 +128,8 @@ ListProductPricePointsResponse listProductPricePoints(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `productId` | [`ListProductPricePointsInputProductId`](../../doc/models/containers/list-product-price-points-input-product-id.md) | Template, Required | This is a container for one-of cases. |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 10. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
**Default**: `10`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 10. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
**Default**: `10`
**Constraints**: `<= 200` |
| `currencyPrices` | `Boolean` | Query, Optional | When fetching a product's price points, if you have defined multiple currencies at the site level, you can optionally pass the ?currency_prices=true query param to include an array of currency price data in the response. If the product price point is set to use_site_exchange_rate: true, it will return pricing based on the current exchange rate. If the flag is set to false, it will return all of the defined prices for each currency. |
| `filterType` | [`List`](../../doc/models/price-point-type.md) | Query, Optional | Use in query: `filter[type]=catalog,default`. |
| `archived` | `Boolean` | Query, Optional | Set to include archived price points in the response. |
@@ -148,7 +148,8 @@ ListProductPricePointsInput listProductPricePointsInput = new ListProductPricePo
)
.page(2)
.perPage(10)
-Liquid error: Value cannot be null. (Parameter 'key').build();
+.filterType(Liquid error: Value cannot be null. (Parameter 'key'))
+.build();
try {
ListProductPricePointsResponse result = productPricePointsController.listProductPricePoints(listProductPricePointsInput);
@@ -865,8 +866,8 @@ ListProductPricePointsResponse listAllProductPricePoints(
| `direction` | [`SortingDirection`](../../doc/models/sorting-direction.md) | Query, Optional | Controls the order in which results are returned.
Use in query `direction=asc`. |
| `filter` | [`ListPricePointsFilter`](../../doc/models/list-price-points-filter.md) | Query, Optional | Filter to use for List PricePoints operations |
| `include` | [`ListProductsPricePointsInclude`](../../doc/models/list-products-price-points-include.md) | Query, Optional | Allows including additional data in the response. Use in query: `include=currency_prices`. |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
## Response Type
diff --git a/doc/controllers/products.md b/doc/controllers/products.md
index 6d645f5e..78141bb6 100644
--- a/doc/controllers/products.md
+++ b/doc/controllers/products.md
@@ -513,8 +513,8 @@ List listProducts(
| `endDatetime` | `ZonedDateTime` | Query, Optional | The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns products with a timestamp at or before exact time provided in query. You can specify timezone in query - otherwise your site''s time zone will be used. If provided, this parameter will be used instead of end_date. |
| `startDate` | `LocalDate` | Query, Optional | The start date (format YYYY-MM-DD) with which to filter the date_field. Returns products with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified. |
| `startDatetime` | `ZonedDateTime` | Query, Optional | The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns products with a timestamp at or after exact time provided in query. You can specify timezone in query - otherwise your site''s time zone will be used. If provided, this parameter will be used instead of start_date. |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `includeArchived` | `Boolean` | Query, Optional | Include archived products. Use in query: `include_archived=true`. |
| `include` | [`ListProductsInclude`](../../doc/models/list-products-include.md) | Query, Optional | Allows including additional data in the response. Use in query `include=prepaid_product_price_point`. |
diff --git a/doc/controllers/proforma-invoices.md b/doc/controllers/proforma-invoices.md
index 90458b31..23397633 100644
--- a/doc/controllers/proforma-invoices.md
+++ b/doc/controllers/proforma-invoices.md
@@ -83,12 +83,12 @@ ListProformaInvoicesResponse listSubscriptionGroupProformaInvoices(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `uid` | `String` | Template, Required | The uid of the subscription group |
-| `lineItems` | `Boolean` | Query, Optional | Include line items data
**Default**: `false` |
-| `discounts` | `Boolean` | Query, Optional | Include discounts data
**Default**: `false` |
-| `taxes` | `Boolean` | Query, Optional | Include taxes data
**Default**: `false` |
-| `credits` | `Boolean` | Query, Optional | Include credits data
**Default**: `false` |
-| `payments` | `Boolean` | Query, Optional | Include payments data
**Default**: `false` |
-| `customFields` | `Boolean` | Query, Optional | Include custom fields data
**Default**: `false` |
+| `lineItems` | `Boolean` | Query, Optional | Include line items data
**Default**: `false` |
+| `discounts` | `Boolean` | Query, Optional | Include discounts data
**Default**: `false` |
+| `taxes` | `Boolean` | Query, Optional | Include taxes data
**Default**: `false` |
+| `credits` | `Boolean` | Query, Optional | Include credits data
**Default**: `false` |
+| `payments` | `Boolean` | Query, Optional | Include payments data
**Default**: `false` |
+| `customFields` | `Boolean` | Query, Optional | Include custom fields data
**Default**: `false` |
## Response Type
@@ -234,15 +234,15 @@ ListProformaInvoicesResponse listProformaInvoices(
| `startDate` | `String` | Query, Optional | The beginning date range for the invoice's Due Date, in the YYYY-MM-DD format. |
| `endDate` | `String` | Query, Optional | The ending date range for the invoice's Due Date, in the YYYY-MM-DD format. |
| `status` | [`ProformaInvoiceStatus`](../../doc/models/proforma-invoice-status.md) | Query, Optional | The current status of the invoice. Allowed Values: draft, open, paid, pending, voided |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
-| `direction` | [`Direction`](../../doc/models/direction.md) | Query, Optional | The sort direction of the returned invoices.
**Default**: `Direction.DESC` |
-| `lineItems` | `Boolean` | Query, Optional | Include line items data
**Default**: `false` |
-| `discounts` | `Boolean` | Query, Optional | Include discounts data
**Default**: `false` |
-| `taxes` | `Boolean` | Query, Optional | Include taxes data
**Default**: `false` |
-| `credits` | `Boolean` | Query, Optional | Include credits data
**Default**: `false` |
-| `payments` | `Boolean` | Query, Optional | Include payments data
**Default**: `false` |
-| `customFields` | `Boolean` | Query, Optional | Include custom fields data
**Default**: `false` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `direction` | [`Direction`](../../doc/models/direction.md) | Query, Optional | The sort direction of the returned invoices.
**Default**: `Direction.DESC` |
+| `lineItems` | `Boolean` | Query, Optional | Include line items data
**Default**: `false` |
+| `discounts` | `Boolean` | Query, Optional | Include discounts data
**Default**: `false` |
+| `taxes` | `Boolean` | Query, Optional | Include taxes data
**Default**: `false` |
+| `credits` | `Boolean` | Query, Optional | Include credits data
**Default**: `false` |
+| `payments` | `Boolean` | Query, Optional | Include payments data
**Default**: `false` |
+| `customFields` | `Boolean` | Query, Optional | Include custom fields data
**Default**: `false` |
## Response Type
diff --git a/doc/controllers/reason-codes.md b/doc/controllers/reason-codes.md
index 053e8bea..d4f7830b 100644
--- a/doc/controllers/reason-codes.md
+++ b/doc/controllers/reason-codes.md
@@ -21,7 +21,7 @@ ReasonCodesController reasonCodesController = client.getReasonCodesController();
# Reason Codes Intro
-ReasonCodes are a way to gain a high level view of why your customers are cancelling the subcription to your product or service.
+ReasonCodes are a way to gain a high level view of why your customers are cancelling the subscription to your product or service.
Add a set of churn reason codes to be displayed in-app and/or the Maxio Billing Portal. As your subscribers decide to cancel their subscription, learn why they decided to cancel.
@@ -93,8 +93,8 @@ List listReasonCodes(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
## Response Type
@@ -138,7 +138,7 @@ try {
"id": 1,
"site_id": 2,
"code": "CH1",
- "description": "This doesnt meet my needs",
+ "description": "This does not meet my needs",
"position": 2,
"created_at": "2017-02-16T16:48:45-05:00",
"updated_at": "2017-02-17T16:29:59-05:00"
@@ -251,7 +251,7 @@ try {
# Delete Reason Code
-This method gives a merchant the option to delete one reason code from the Churn Reason Codes. This code will be immediately removed. This action is not reversable.
+This method gives a merchant the option to delete one reason code from the Churn Reason Codes. This code will be immediately removed. This action is not reversible.
```java
OkResponse deleteReasonCode(
diff --git a/doc/controllers/sales-commissions.md b/doc/controllers/sales-commissions.md
index 1d6dc6d4..41bd3465 100644
--- a/doc/controllers/sales-commissions.md
+++ b/doc/controllers/sales-commissions.md
@@ -37,10 +37,10 @@ List listSalesCommissionSettings(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `sellerId` | `String` | Template, Required | The Chargify id of your seller account |
-| `authorization` | `String` | Header, Optional | For authorization use user API key. See details [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication).
**Default**: `"Bearer <>"` |
+| `authorization` | `String` | Header, Optional | For authorization use user API key. See details [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication).
**Default**: `"Bearer <>"` |
| `liveMode` | `Boolean` | Query, Optional | This parameter indicates if records should be fetched from live mode sites. Default value is true. |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 100.
**Default**: `100` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 100.
**Default**: `100` |
## Response Type
@@ -124,10 +124,10 @@ List listSalesReps(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `sellerId` | `String` | Template, Required | The Chargify id of your seller account |
-| `authorization` | `String` | Header, Optional | For authorization use user API key. See details [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication).
**Default**: `"Bearer <>"` |
+| `authorization` | `String` | Header, Optional | For authorization use user API key. See details [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication).
**Default**: `"Bearer <>"` |
| `liveMode` | `Boolean` | Query, Optional | This parameter indicates if records should be fetched from live mode sites. Default value is true. |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 100.
**Default**: `100` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 100.
**Default**: `100` |
## Response Type
@@ -266,10 +266,10 @@ SaleRep readSalesRep(
| --- | --- | --- | --- |
| `sellerId` | `String` | Template, Required | The Chargify id of your seller account |
| `salesRepId` | `String` | Template, Required | The Advanced Billing id of sales rep. |
-| `authorization` | `String` | Header, Optional | For authorization use user API key. See details [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication).
**Default**: `"Bearer <>"` |
+| `authorization` | `String` | Header, Optional | For authorization use user API key. See details [here](https://developers.chargify.com/docs/developer-docs/ZG9jOjMyNzk5NTg0-2020-04-20-new-api-authentication).
**Default**: `"Bearer <>"` |
| `liveMode` | `Boolean` | Query, Optional | This parameter indicates if records should be fetched from live mode sites. Default value is true. |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 100.
**Default**: `100` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 100.
**Default**: `100` |
## Response Type
diff --git a/doc/controllers/sites.md b/doc/controllers/sites.md
index 204b44c8..4186fd40 100644
--- a/doc/controllers/sites.md
+++ b/doc/controllers/sites.md
@@ -122,7 +122,7 @@ Void clearSite(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
-| `cleanupScope` | [`CleanupScope`](../../doc/models/cleanup-scope.md) | Query, Optional | `all`: Will clear all products, customers, and related subscriptions from the site.
`customers`: Will clear only customers and related subscriptions (leaving the products untouched) for the site.
Revenue will also be reset to 0.
Use in query `cleanup_scope=all`.
**Default**: `CleanupScope.ALL` |
+| `cleanupScope` | [`CleanupScope`](../../doc/models/cleanup-scope.md) | Query, Optional | `all`: Will clear all products, customers, and related subscriptions from the site.
`customers`: Will clear only customers and related subscriptions (leaving the products untouched) for the site.
Revenue will also be reset to 0.
Use in query `cleanup_scope=all`.
**Default**: `CleanupScope.ALL` |
## Response Type
@@ -156,8 +156,8 @@ ListPublicKeysResponse listChargifyJsPublicKeys(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
## Response Type
diff --git a/doc/controllers/subscription-components.md b/doc/controllers/subscription-components.md
index 798a9c26..35411a14 100644
--- a/doc/controllers/subscription-components.md
+++ b/doc/controllers/subscription-components.md
@@ -585,7 +585,7 @@ List listAllocations(
| --- | --- | --- | --- |
| `subscriptionId` | `int` | Template, Required | The Chargify id of the subscription |
| `componentId` | `int` | Template, Required | The Advanced Billing id of the component |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
## Response Type
@@ -1225,8 +1225,8 @@ List listUsages(
| `maxId` | `Long` | Query, Optional | Returns usages with an id less than or equal to the one specified |
| `sinceDate` | `LocalDate` | Query, Optional | Returns usages with a created_at date greater than or equal to midnight (12:00 AM) on the date specified. |
| `untilDate` | `LocalDate` | Query, Optional | Returns usages with a created_at date less than or equal to midnight (12:00 AM) on the date specified. |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
## Response Type
@@ -1336,6 +1336,7 @@ ActivateEventBasedComponent body = new ActivateEventBasedComponent.Builder()
"5.0"
)
)
+ .endingQuantity(null)
.build()
)
)
@@ -1526,8 +1527,8 @@ ListSubscriptionComponentsResponse listSubscriptionComponentsForSite(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `sort` | [`ListSubscriptionComponentsSort`](../../doc/models/list-subscription-components-sort.md) | Query, Optional | The attribute by which to sort. Use in query: `sort=updated_at`. |
| `direction` | [`SortingDirection`](../../doc/models/sorting-direction.md) | Query, Optional | Controls the order in which results are returned.
Use in query `direction=asc`. |
| `filter` | [`ListSubscriptionComponentsForSiteFilter`](../../doc/models/list-subscription-components-for-site-filter.md) | Query, Optional | Filter to use for List Subscription Components For Site operation |
@@ -1536,7 +1537,7 @@ ListSubscriptionComponentsResponse listSubscriptionComponentsForSite(
| `startDatetime` | `String` | Query, Optional | The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns components with a timestamp at or after exact time provided in query. You can specify timezone in query - otherwise your site''s time zone will be used. If provided, this parameter will be used instead of start_date. Use in query `start_datetime=2022-07-01 09:00:05`. |
| `endDate` | `String` | Query, Optional | The end date (format YYYY-MM-DD) with which to filter the date_field. Returns components with a timestamp up to and including 11:59:59PM in your site’s time zone on the date specified. Use in query `end_date=2011-12-16`. |
| `endDatetime` | `String` | Query, Optional | The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns components with a timestamp at or before exact time provided in query. You can specify timezone in query - otherwise your site''s time zone will be used. If provided, this parameter will be used instead of end_date. Use in query `end_datetime=2022-07-01 09:00:05`. |
-| `subscriptionIds` | `List` | Query, Optional | Allows fetching components allocation with matching subscription id based on provided ids. Use in query `subscription_ids=1,2,3`.
**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `200` |
+| `subscriptionIds` | `List` | Query, Optional | Allows fetching components allocation with matching subscription id based on provided ids. Use in query `subscription_ids=1,2,3`.
**Constraints**: *Minimum Items*: `1`, *Maximum Items*: `200` |
| `pricePointIds` | [`IncludeNotNull`](../../doc/models/include-not-null.md) | Query, Optional | Allows fetching components allocation only if price point id is present. Use in query `price_point_ids=not_null`. |
| `productFamilyIds` | `List` | Query, Optional | Allows fetching components allocation with matching product family id based on provided ids. Use in query `product_family_ids=1,2,3`. |
| `include` | [`ListSubscriptionComponentsInclude`](../../doc/models/list-subscription-components-include.md) | Query, Optional | Allows including additional data in the response. Use in query `include=subscription,historic_usages`. |
diff --git a/doc/controllers/subscription-group-invoice-account.md b/doc/controllers/subscription-group-invoice-account.md
index d34470a6..3965fd47 100644
--- a/doc/controllers/subscription-group-invoice-account.md
+++ b/doc/controllers/subscription-group-invoice-account.md
@@ -84,8 +84,8 @@ ListSubscriptionGroupPrepaymentResponse listPrepaymentsForSubscriptionGroup(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `uid` | `String` | Template, Required | The uid of the subscription group |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `filter` | [`ListPrepaymentsFilter`](../../doc/models/list-prepayments-filter.md) | Query, Optional | Filter to use for List Prepayments operations |
## Response Type
diff --git a/doc/controllers/subscription-groups.md b/doc/controllers/subscription-groups.md
index 217d33d4..f42eeec3 100644
--- a/doc/controllers/subscription-groups.md
+++ b/doc/controllers/subscription-groups.md
@@ -180,8 +180,8 @@ ListSubscriptionGroupsResponse listSubscriptionGroups(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `include` | [`List`](../../doc/models/subscription-groups-list-include.md) | Query, Optional | A list of additional information to include in the response. The following values are supported:
- `account_balances`: Account balance information for the subscription groups. Use in query: `include[]=account_balances` |
## Response Type
diff --git a/doc/controllers/subscription-invoice-account.md b/doc/controllers/subscription-invoice-account.md
index f7906c37..1d7a220b 100644
--- a/doc/controllers/subscription-invoice-account.md
+++ b/doc/controllers/subscription-invoice-account.md
@@ -15,6 +15,7 @@ SubscriptionInvoiceAccountController subscriptionInvoiceAccountController = clie
* [List Prepayments](../../doc/controllers/subscription-invoice-account.md#list-prepayments)
* [Issue Service Credit](../../doc/controllers/subscription-invoice-account.md#issue-service-credit)
* [Deduct Service Credit](../../doc/controllers/subscription-invoice-account.md#deduct-service-credit)
+* [List Service Credits](../../doc/controllers/subscription-invoice-account.md#list-service-credits)
* [Refund Prepayment](../../doc/controllers/subscription-invoice-account.md#refund-prepayment)
@@ -142,8 +143,8 @@ PrepaymentsResponse listPrepayments(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `subscriptionId` | `int` | Template, Required | The Chargify id of the subscription |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `filter` | [`ListPrepaymentsFilter`](../../doc/models/list-prepayments-filter.md) | Query, Optional | Filter to use for List Prepayments operations |
## Response Type
@@ -319,6 +320,85 @@ try {
| 422 | Unprocessable Entity (WebDAV) | `ApiException` |
+# List Service Credits
+
+This request will list a subscription's service credits.
+
+```java
+ListServiceCreditsResponse listServiceCredits(
+ final int subscriptionId,
+ final Integer page,
+ final Integer perPage,
+ final SortingDirection direction)
+```
+
+## Parameters
+
+| Parameter | Type | Tags | Description |
+| --- | --- | --- | --- |
+| `subscriptionId` | `int` | Template, Required | The Chargify id of the subscription |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `direction` | [`SortingDirection`](../../doc/models/sorting-direction.md) | Query, Optional | Controls the order in which results are returned.
Use in query `direction=asc`. |
+
+## Response Type
+
+[`ListServiceCreditsResponse`](../../doc/models/list-service-credits-response.md)
+
+## Example Usage
+
+```java
+int subscriptionId = 222;
+Integer page = 2;
+Integer perPage = 50;
+
+try {
+ ListServiceCreditsResponse result = subscriptionInvoiceAccountController.listServiceCredits(subscriptionId, page, perPage, null);
+ System.out.println(result);
+} catch (ApiException e) {
+ e.printStackTrace();
+} catch (IOException e) {
+ e.printStackTrace();
+}
+```
+
+## Example Response *(as JSON)*
+
+```json
+{
+ "service_credits": [
+ {
+ "id": 68,
+ "amount_in_cents": 2200,
+ "ending_balance_in_cents": 1100,
+ "entry_type": "Debit",
+ "memo": "Service credit memo",
+ "invoice_uid": "inv_brntdvmmqxc3j",
+ "remaining_balance_in_cents": 1100,
+ "created_at": "2025-04-01T09:54:49-04:00"
+ },
+ {
+ "id": 67,
+ "amount_in_cents": 3300,
+ "ending_balance_in_cents": 3300,
+ "entry_type": "Credit",
+ "memo": "Service credit memo",
+ "invoice_uid": null,
+ "remaining_balance_in_cents": 1100,
+ "created_at": "2025-03-05T16:06:08-05:00"
+ }
+ ]
+}
+```
+
+## Errors
+
+| HTTP Status Code | Error Description | Exception Class |
+| --- | --- | --- |
+| 404 | Not Found | `ApiException` |
+| 422 | Unprocessable Entity | [`ErrorListResponseException`](../../doc/models/error-list-response-exception.md) |
+
+
# Refund Prepayment
This endpoint will refund, completely or partially, a particular prepayment applied to a subscription. The `prepayment_id` will be the account transaction ID of the original payment. The prepayment must have some amount remaining in order to be refunded.
diff --git a/doc/controllers/subscription-notes.md b/doc/controllers/subscription-notes.md
index f8c036c1..2e84b5e5 100644
--- a/doc/controllers/subscription-notes.md
+++ b/doc/controllers/subscription-notes.md
@@ -90,8 +90,8 @@ List listSubscriptionNotes(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `subscriptionId` | `int` | Template, Required | The Chargify id of the subscription |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
## Response Type
diff --git a/doc/controllers/subscription-status.md b/doc/controllers/subscription-status.md
index f7fd66f2..2ade2c38 100644
--- a/doc/controllers/subscription-status.md
+++ b/doc/controllers/subscription-status.md
@@ -401,7 +401,7 @@ SubscriptionResponse resumeSubscription(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
| `subscriptionId` | `int` | Template, Required | The Chargify id of the subscription |
-| `calendarBillingResumptionCharge` | [`ResumptionCharge`](../../doc/models/resumption-charge.md) | Query, Optional | (For calendar billing subscriptions only) The way that the resumed subscription's charge should be handled
**Default**: `ResumptionCharge.PRORATED` |
+| `calendarBillingResumptionCharge` | [`ResumptionCharge`](../../doc/models/resumption-charge.md) | Query, Optional | (For calendar billing subscriptions only) The way that the resumed subscription's charge should be handled
**Default**: `ResumptionCharge.PRORATED` |
## Response Type
@@ -411,9 +411,9 @@ SubscriptionResponse resumeSubscription(
```java
int subscriptionId = 222;
-Liquid error: Value cannot be null. (Parameter 'key')
+
try {
- SubscriptionResponse result = subscriptionStatusController.resumeSubscription(subscriptionId, Liquid error: Value cannot be null. (Parameter 'key'));
+ SubscriptionResponse result = subscriptionStatusController.resumeSubscription(subscriptionId, null);
System.out.println(result);
} catch (ApiException e) {
e.printStackTrace();
diff --git a/doc/controllers/subscriptions.md b/doc/controllers/subscriptions.md
index 9745c627..278b9386 100644
--- a/doc/controllers/subscriptions.md
+++ b/doc/controllers/subscriptions.md
@@ -164,42 +164,6 @@ If you already have a customer and card stored in your payment gateway, you may
}
```
-## Subscription with Credit Card
-
-```json
-"subscription": {
- "product_handle": "basic",
- "customer_attributes": {
- "first_name": "Joe",
- "last_name": "Blow",
- "email": "joe@example.com",
- "zip": "02120",
- "state": "MA",
- "reference": "XYZ",
- "phone": "(617) 111 - 0000",
- "organization": "Acme",
- "country": "US",
- "city": "Boston",
- "address_2": null,
- "address": "123 Mass Ave."
- },
- "credit_card_attributes": {
- "last_name": "Smith",
- "first_name": "Joe",
- "full_number": "4111111111111111",
- "expiration_year": "2021",
- "expiration_month": "1",
- "card_type": "visa",
- "billing_zip": "02120",
- "billing_state": "MA",
- "billing_country": "US",
- "billing_city": "Boston",
- "billing_address_2": null,
- "billing_address": "123 Mass Ave."
- }
-}
-```
-
## Subscription with ACH as Payment Profile
```json
@@ -898,12 +862,13 @@ List listSubscriptions(
| Parameter | Type | Tags | Description |
| --- | --- | --- | --- |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `state` | [`SubscriptionStateFilter`](../../doc/models/subscription-state-filter.md) | Query, Optional | The current state of the subscription |
| `product` | `Integer` | Query, Optional | The product id of the subscription. (Note that the product handle cannot be used.) |
| `productPricePointId` | `Integer` | Query, Optional | The ID of the product price point. If supplied, product is required |
| `coupon` | `Integer` | Query, Optional | The numeric id of the coupon currently applied to the subscription. (This can be found in the URL when editing a coupon. Note that the coupon code cannot be used.) |
+| `couponCode` | `String` | Query, Optional | The coupon code currently applied to the subscription |
| `dateField` | [`SubscriptionDateField`](../../doc/models/subscription-date-field.md) | Query, Optional | The type of filter you'd like to apply to your search. Allowed Values: , current_period_ends_at, current_period_starts_at, created_at, activated_at, canceled_at, expires_at, trial_started_at, trial_ended_at, updated_at |
| `startDate` | `LocalDate` | Query, Optional | The start date (format YYYY-MM-DD) with which to filter the date_field. Returns subscriptions with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified. Use in query `start_date=2022-07-01`. |
| `endDate` | `LocalDate` | Query, Optional | The end date (format YYYY-MM-DD) with which to filter the date_field. Returns subscriptions with a timestamp up to and including 11:59:59PM in your site’s time zone on the date specified. Use in query `end_date=2022-08-01`. |
@@ -911,7 +876,7 @@ List listSubscriptions(
| `endDatetime` | `ZonedDateTime` | Query, Optional | The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns subscriptions with a timestamp at or before exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of end_date. Use in query `end_datetime=2022-08-01 10:00:05`. |
| `metadata` | `Map` | Query, Optional | The value of the metadata field specified in the parameter. Use in query `metadata[my-field]=value&metadata[other-field]=another_value`. |
| `direction` | [`SortingDirection`](../../doc/models/sorting-direction.md) | Query, Optional | Controls the order in which results are returned.
Use in query `direction=asc`. |
-| `sort` | [`SubscriptionSort`](../../doc/models/subscription-sort.md) | Query, Optional | The attribute by which to sort
**Default**: `SubscriptionSort.SIGNUP_DATE` |
+| `sort` | [`SubscriptionSort`](../../doc/models/subscription-sort.md) | Query, Optional | The attribute by which to sort
**Default**: `SubscriptionSort.SIGNUP_DATE` |
| `include` | [`List`](../../doc/models/subscription-list-include.md) | Query, Optional | Allows including additional data in the response. Use in query: `include[]=self_service_page_token`. |
## Response Type
@@ -1012,12 +977,8 @@ SubscriptionResponse updateSubscription(
int subscriptionId = 222;
UpdateSubscriptionRequest body = new UpdateSubscriptionRequest.Builder(
new UpdateSubscription.Builder()
- .creditCardAttributes(new CreditCardAttributes.Builder()
- .fullNumber("4111111111111111")
- .expirationMonth("10")
- .expirationYear("2030")
- .build())
.nextBillingAt(DateTimeHelper.fromRfc8601DateTime("2010-08-06T15:34:00Z"))
+ .paymentCollectionMethod("remittance")
.build()
)
.build();
@@ -1569,11 +1530,11 @@ try {
The Chargify API allows you to preview a subscription by POSTing the same JSON or XML as for a subscription creation.
-The "Next Billing" amount and "Next Billing" date are represented in each Subscriber's Summary. For more information, please see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24252493695757-Subscriber-Interface-Overview).
+The "Next Billing" amount and "Next Billing" date are represented in each Subscriber's Summary.
-## Side effects
+A subscription will not be created by utilizing this endpoint; it is meant to serve as a prediction.
-A subscription will not be created by sending a POST to this endpoint. It is meant to serve as a prediction.
+For more information, please see our documentation [here](https://maxio.zendesk.com/hc/en-us/articles/24252493695757-Subscriber-Interface-Overview).
## Taxable Subscriptions
diff --git a/doc/controllers/webhooks.md b/doc/controllers/webhooks.md
index 9f6f2f36..30aa1bf8 100644
--- a/doc/controllers/webhooks.md
+++ b/doc/controllers/webhooks.md
@@ -47,8 +47,8 @@ List listWebhooks(
| `status` | [`WebhookStatus`](../../doc/models/webhook-status.md) | Query, Optional | Webhooks with matching status would be returned. |
| `sinceDate` | `String` | Query, Optional | Format YYYY-MM-DD. Returns Webhooks with the created_at date greater than or equal to the one specified. |
| `untilDate` | `String` | Query, Optional | Format YYYY-MM-DD. Returns Webhooks with the created_at date less than or equal to the one specified. |
-| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
-| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
+| `page` | `Integer` | Query, Optional | Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
Use in query `page=1`.
**Default**: `1`
**Constraints**: `>= 1` |
+| `perPage` | `Integer` | Query, Optional | This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
Use in query `per_page=200`.
**Default**: `20`
**Constraints**: `<= 200` |
| `order` | [`WebhookOrder`](../../doc/models/webhook-order.md) | Query, Optional | The order in which the Webhooks are returned. |
| `subscription` | `Integer` | Query, Optional | The Advanced Billing id of a subscription you'd like to filter for |
diff --git a/doc/date-time-helper.md b/doc/date-time-helper.md
new file mode 100644
index 00000000..474765f5
--- /dev/null
+++ b/doc/date-time-helper.md
@@ -0,0 +1,54 @@
+
+# DateTimeHelper
+
+This is a utility class for DateTime operations.
+
+## Local Date Methods
+
+| Name | Description | Return Type |
+| --- | --- | --- |
+| `fromSimpleDate(String date)` | Parse a simple date string to a LocalDate object. | `LocalDate` |
+| `toSimpleDate(LocalDate value)` | Convert a LocalDate object to a string. | `String` |
+| `toSimpleDate(List values)` | Convert a List of LocalDate objects to strings. | `List` |
+| `toSimpleDate(Map values)` | Convert a Map of LocalDate objects to strings. | `Map` |
+| `toArrayOfMapOfSimpleDate(List> values)` | Convert a List of Map of LocalDate objects to strings. | `List>` |
+
+## Rfc1123 Methods
+
+| Name | Description | Return Type |
+| --- | --- | --- |
+| `fromRfc1123DateTime(String date)` | Parse a datetime string in Rfc1123 format to a DateTime object. | `ZonedDateTime` |
+| `toRfc1123DateTime(ZonedDateTime value)` | Convert a DateTime object to a Rfc1123 formatted string. | `String` |
+| `toRfc1123DateTime(List values)` | Convert a List of DateTime objects to Rfc1123 formatted strings. | `List` |
+| `toRfc1123DateTime(Map values)` | Convert a Map of DateTime objects to Rfc1123 formatted strings. | `Map` |
+| `toArrayOfMapOfRfc1123DateTime(List values)` | Convert a List of Map of DateTime objects to Rfc1123 formatted strings. | `List>` |
+
+## Rfc8601(Rfc3339) Methods
+
+| Name | Description | Return Type |
+| --- | --- | --- |
+| `fromRfc8601DateTime(String date)` | Parse a datetime string in Rfc8601(Rfc3339) format to a DateTime object. | `ZonedDateTime` |
+| `toRfc8601DateTime(ZonedDateTime value)` | Convert a DateTime object to a Rfc8601(Rfc3339) formatted string. | `String` |
+| `toRfc8601DateTime(List values)` | Convert a List of DateTime objects to Rfc8601(Rfc3339) formatted strings. | `List` |
+| `toRfc8601DateTime(Map values)` | Convert a Map of DateTime objects to Rfc8601(Rfc3339) formatted strings. | `Map` |
+| `toArrayOfMapOfRfc8601DateTime(List values)` | Convert a List of Map of DateTime objects to Rfc8601(Rfc3339) formatted strings. | `List>` |
+
+## Unix Timestamp Methods
+
+| Name | Description | Return Type |
+| --- | --- | --- |
+| `fromUnixTimestamp(String date)` | Parse a Unix Timestamp string to a DateTime object. | `ZonedDateTime` |
+| `toUnixTimestamp(ZonedDateTime value)` | Convert a DateTime object to a Unix Timestamp string. | `String` |
+| `toUnixTimestamp(List values)` | Convert a List of DateTime objects to Unix Timestamp strings. | `List` |
+| `toUnixTimestamp(Map values)` | Convert a Map of DateTime objects to Unix Timestamp strings. | `Map` |
+
+## Unix Timestamp(Long) Methods
+
+| Name | Description | Return Type |
+| --- | --- | --- |
+| `fromUnixTimestamp(Long date)` | Parse a Unix Timestamp to a DateTime object. | `ZonedDateTime` |
+| `toUnixTimestampLong(ZonedDateTime value)` | Convert a DateTime object to a Unix Timestamp. | `Long` |
+| `toUnixTimestampLong(List values)` | Convert a List of DateTime objects to Unix Timestamp. | `List` |
+| `toUnixTimestampLong(Map values)` | Convert a Map of DateTime objects to Unix Timestamp. | `Map` |
+| `toArrayOfMapOfUnixTimestampLong(List values)` | Convert a List of Map DateTime objects to Unix Timestamp. | `List>` |
+
diff --git a/doc/file-wrapper.md b/doc/file-wrapper.md
new file mode 100644
index 00000000..e174e177
--- /dev/null
+++ b/doc/file-wrapper.md
@@ -0,0 +1,19 @@
+
+# FileWrapper
+
+Class to wrap file and contentType to be sent as part of a HTTP request.
+
+## Constructors
+
+| Name | Description |
+| --- | --- |
+| `FileWrapper(File file)` | Initialization constructor. |
+| `FileWrapper(File file, String contentType)` | Initialization constructor. |
+
+## Methods
+
+| Name | Description | Return Type |
+| --- | --- | --- |
+| `getFile()` | File instance. | `File` |
+| `getContentType()` | Content type of the file. | `String` |
+
diff --git a/doc/headers.md b/doc/headers.md
index 4ea4cdf5..4ef94c76 100644
--- a/doc/headers.md
+++ b/doc/headers.md
@@ -1,5 +1,5 @@
-# Headers Class
+# Headers
Class for creating and managing HTTP Headers.
diff --git a/doc/http-body-request.md b/doc/http-body-request.md
index a0184238..6dbef8ee 100644
--- a/doc/http-body-request.md
+++ b/doc/http-body-request.md
@@ -1,14 +1,8 @@
-# HttpBodyRequest Class
+# HttpBodyRequest
HTTP Request with an explicit body.
-## Constructors
-
-| Name | Description |
-| --- | --- |
-| `HttpBodyRequest(HttpMethod method, StringBuilder queryUrlBuilder,` [`Headers`](headers.md) `headers, Map queryParams, Object body)` | Create a request with explicit body. |
-
## Methods
| Name | Description | Return Type |
diff --git a/doc/http-callback-interface.md b/doc/http-callback-interface.md
index 525329e9..1698fa15 100644
--- a/doc/http-callback-interface.md
+++ b/doc/http-callback-interface.md
@@ -7,6 +7,6 @@ Callback to be called before and after the HTTP call for an endpoint is made.
| Name | Description | Return Type |
| --- | --- | --- |
-| `onBeforeRequest(`[`HttpRequest`](http-request.md) `request)` | Callback called just before the HTTP request is sent. | `void` |
-| `onAfterResponse(`[`HttpContext`](http-context.md) `context)` | Callback called just after the HTTP response is received. | `void` |
+| onBeforeRequest([`HttpRequest`](../doc/http-request.md) request) | Callback called just before the HTTP request is sent. | `void` |
+| onAfterResponse([`HttpContext`](../doc/http-context.md) context) | Callback called just after the HTTP response is received. | `void` |
diff --git a/doc/http-client-configuration-builder.md b/doc/http-client-configuration-builder.md
index 3eb84de3..27777c38 100644
--- a/doc/http-client-configuration-builder.md
+++ b/doc/http-client-configuration-builder.md
@@ -1,7 +1,7 @@
-# HttpClientConfiguration.Builder Class
+# HttpClientConfiguration.Builder
-Class to build instances of {@link HttpClientConfiguration}.
+Class to build instances of [HttpClientConfiguration](../doc/http-client-configuration.md).
## Constructors
@@ -13,15 +13,15 @@ Class to build instances of {@link HttpClientConfiguration}.
| Name | Description | Return Type |
| --- | --- | --- |
-| `timeout(long timeout)` | Sets the timeout in seconds to use for making http requests. | [`Builder`](http-client-configuration-builder.md) |
-| `numberOfRetries(int numberOfRetries)` | Sets the number of retries to make. | [`Builder`](http-client-configuration-builder.md) |
-| `backOffFactor(int backOffFactor)` | Sets to use in calculation of wait time for next request in case of failure. | [`Builder`](http-client-configuration-builder.md) |
-| `retryInterval(long retryInterval)` | Sets to use in calculation of wait time for next request in case of failure. | [`Builder`](http-client-configuration-builder.md) |
-| `httpStatusCodesToRetry(Set httpStatusCodesToRetry)` | Sets http status codes to retry against. | [`Builder`](http-client-configuration-builder.md) |
-| `httpMethodsToRetry(Set httpMethodsToRetry)` | Sets http methods to retry against. | [`Builder`](http-client-configuration-builder.md) |
-| `maximumRetryWaitTime(long maximumRetryWaitTime)` | Sets the maximum wait time for overall retrying requests. | [`Builder`](http-client-configuration-builder.md) |
-| `shouldRetryOnTimeout(boolean shouldRetryOnTimeout)` | Sets whether to retry on request timeout. | [`Builder`](http-client-configuration-builder.md) |
-| `httpClientInstance(okhttp3.OkHttpClient httpClientInstance)` | Sets the okhttpclient instance used to make the http calls. | [`Builder`](http-client-configuration-builder.md) |
-| `httpClientInstance(okhttp3.OkHttpClient httpClientInstance, boolean overrideHttpClientConfigurations)` | Sets the okhttpclient instance used to make the http calls and an option to Allow the SDK to override HTTP client instance's settings used for features like retries, timeouts etc. | [`Builder`](http-client-configuration-builder.md) |
-| `build()` | Builds a new HttpClientConfiguration object using the set fields. | [`HttpClientConfiguration`](http-client-configuration.md) |
+| `timeout(long timeout)` | Sets the timeout in seconds to use for making http requests. | `HttpClientConfiguration.Builder` |
+| `numberOfRetries(int numberOfRetries)` | Sets the number of retries to make. | `HttpClientConfiguration.Builder` |
+| `backOffFactor(int backOffFactor)` | Sets to use in calculation of wait time for next request in case of failure. | `HttpClientConfiguration.Builder` |
+| `retryInterval(long retryInterval)` | Sets to use in calculation of wait time for next request in case of failure. | `HttpClientConfiguration.Builder` |
+| `httpStatusCodesToRetry(Set httpStatusCodesToRetry)` | Sets http status codes to retry against. | `HttpClientConfiguration.Builder` |
+| `httpMethodsToRetry(Set httpMethodsToRetry)` | Sets http methods to retry against. | `HttpClientConfiguration.Builder` |
+| `maximumRetryWaitTime(long maximumRetryWaitTime)` | Sets the maximum wait time for overall retrying requests. | `HttpClientConfiguration.Builder` |
+| `shouldRetryOnTimeout(boolean shouldRetryOnTimeout)` | Sets whether to retry on request timeout. | `HttpClientConfiguration.Builder` |
+| `httpClientInstance(okhttp3.OkHttpClient httpClientInstance)` | Sets the okhttpclient instance used to make the http calls. | `HttpClientConfiguration.Builder` |
+| `httpClientInstance(okhttp3.OkHttpClient httpClientInstance, boolean overrideHttpClientConfigurations)` | Sets the okhttpclient instance used to make the http calls and an option to Allow the SDK to override HTTP client instance's settings used for features like retries, timeouts etc. | `HttpClientConfiguration.Builder` |
+| `build()` | Builds a new HttpClientConfiguration object using the set fields. | [`HttpClientConfiguration`](../doc/http-client-configuration.md) |
diff --git a/doc/http-client-configuration.md b/doc/http-client-configuration.md
index b976c602..eabd480e 100644
--- a/doc/http-client-configuration.md
+++ b/doc/http-client-configuration.md
@@ -1,5 +1,5 @@
-# HttpClientConfiguration Class
+# HttpClientConfiguration
Class for holding http client configuration.
@@ -18,5 +18,5 @@ Class for holding http client configuration.
| `getHttpClientInstance()` | The OkHttpClient instance used to make the HTTP calls. | `okhttp3.OkHttpClient` |
| `shouldOverrideHttpClientConfigurations()` | Allow the SDK to override HTTP client instance's settings used for features like retries, timeouts etc. | `boolean` |
| `toString()` | Converts this HttpClientConfiguration into string format. | `String` |
-| `newBuilder()` | Builds a new {@link HttpClientConfiguration.Builder} object. Creates the instance with the current state. | [`HttpClientConfiguration.Builder`](http-client-configuration-builder.md) |
+| `newBuilder()` | Builds a new {@link HttpClientConfiguration.Builder} object. Creates the instance with the current state. | [`HttpClientConfiguration.Builder`](../doc/http-client-configuration-builder.md) |
diff --git a/doc/http-context.md b/doc/http-context.md
index 9c6cc803..82661472 100644
--- a/doc/http-context.md
+++ b/doc/http-context.md
@@ -1,18 +1,12 @@
-# HttpContext Class
+# HttpContext
Class to wrap the request sent to the server and the response received from the server.
-## Constructors
-
-| Name | Description |
-| --- | --- |
-| `HttpContext(HttpRequest request, HttpResponse response)` | Constructor for HttpContext. |
-
## Methods
| Name | Description | Return Type |
| --- | --- | --- |
-| `getRequest()` | Getter for the Http Request. | [`HttpRequest`](http-request.md) |
-| `getResponse()` | Getter for the Http Response. | [`HttpResponse`](http-response.md) |
+| `getRequest()` | Getter for the Http Request. | [`HttpRequest`](../doc/http-request.md) |
+| `getResponse()` | Getter for the Http Response. | [`HttpResponse`](../doc/http-response.md) |
diff --git a/doc/http-request.md b/doc/http-request.md
index 69aeffb3..47eaf4e7 100644
--- a/doc/http-request.md
+++ b/doc/http-request.md
@@ -1,20 +1,14 @@
-# HttpRequest Class
+# HttpRequest
Class for creating and managing HTTP Requests.
-## Constructors
-
-| Name | Description |
-| --- | --- |
-| `HttpRequest(HttpMethod method, StringBuilder queryUrlBuilder, Headers headers, Map queryParameters, List< SimpleEntry < String, Object >> parameters)` | Initializes a simple http request. |
-
## Methods
| Name | Description | Return Type |
| --- | --- | --- |
| `getHttpMethod()` | HttpMethod for the http request. | `HttpMethod` |
-| `getHeaders()` | Headers for the http request. | [`Headers`](headers.md) |
+| `getHeaders()` | Headers for the http request. | [`Headers`](../doc/headers.md) |
| `getQueryUrl()` | Query url for the http request. | `String` |
| `getParameters()` | Parameters for the http request. | `List>` |
| `getQueryParameters()` | Query parameters for the http request. | `Map` |
diff --git a/doc/http-response.md b/doc/http-response.md
index c49ba9cc..8edaf028 100644
--- a/doc/http-response.md
+++ b/doc/http-response.md
@@ -1,19 +1,13 @@
-# HttpResponse Class
+# HttpResponse
Class to hold HTTP Response.
-## Constructors
-
-| Name | Description |
-| --- | --- |
-| `HttpResponse(int code, Headers headers, InputStream rawBody)` | Constructor for HttpResponse. |
-
## Methods
| Name | Description | Return Type |
| --- | --- | --- |
| `getStatusCode()` | HTTP Status code of the http response.. | `int` |
-| `getHeaders()` | Headers of the http response. | [`Headers`](headers.md) |
+| `getHeaders()` | Headers of the http response. | [`Headers`](../doc/headers.md) |
| `getRawBody()` | Raw body of the http response. | `InputStream` |
diff --git a/doc/http-string-response.md b/doc/http-string-response.md
index 33f59f88..36aca979 100644
--- a/doc/http-string-response.md
+++ b/doc/http-string-response.md
@@ -1,19 +1,13 @@
-# HttpStringResponse Class
+# HttpStringResponse
Class to hold response body as string.
-## Constructors
-
-| Name | Description |
-| --- | --- |
-| `HttpStringResponse(int code, Headers headers, InputStream rawBody, String body)` | Constructor for HttpStringResponse. |
-
## Methods
| Name | Description | Return Type |
| --- | --- | --- |
| `getStatusCode()` | HTTP Status code of the http response. | `int` |
-| `getHeaders()` | Headers of the http response. | [`Headers`](headers.md) |
+| `getHeaders()` | Headers of the http response. | [`Headers`](../doc/headers.md) |
| `getBody()` | String body of the http response. | `String` |
diff --git a/doc/models/apple-pay-payment-profile.md b/doc/models/apple-pay-payment-profile.md
index f6fb1642..29bb4079 100644
--- a/doc/models/apple-pay-payment-profile.md
+++ b/doc/models/apple-pay-payment-profile.md
@@ -25,6 +25,8 @@
| `PaymentType` | [`PaymentType`](../../doc/models/payment-type.md) | Required | **Default**: `PaymentType.APPLE_PAY` | PaymentType getPaymentType() | setPaymentType(PaymentType paymentType) |
| `SiteGatewaySettingId` | `Integer` | Optional | - | Integer getSiteGatewaySettingId() | setSiteGatewaySettingId(Integer siteGatewaySettingId) |
| `GatewayHandle` | `String` | Optional | - | String getGatewayHandle() | setGatewayHandle(String gatewayHandle) |
+| `CreatedAt` | `ZonedDateTime` | Optional | A timestamp indicating when this payment profile was created | ZonedDateTime getCreatedAt() | setCreatedAt(ZonedDateTime createdAt) |
+| `UpdatedAt` | `ZonedDateTime` | Optional | A timestamp indicating when this payment profile was last updated | ZonedDateTime getUpdatedAt() | setUpdatedAt(ZonedDateTime updatedAt) |
## Example (as JSON)
diff --git a/doc/models/bank-account-payment-profile.md b/doc/models/bank-account-payment-profile.md
index 08725d50..a6b9fb73 100644
--- a/doc/models/bank-account-payment-profile.md
+++ b/doc/models/bank-account-payment-profile.md
@@ -28,9 +28,11 @@
| `BankAccountType` | [`BankAccountType`](../../doc/models/bank-account-type.md) | Optional | Defaults to checking | BankAccountType getBankAccountType() | setBankAccountType(BankAccountType bankAccountType) |
| `BankAccountHolderType` | [`BankAccountHolderType`](../../doc/models/bank-account-holder-type.md) | Optional | Defaults to personal | BankAccountHolderType getBankAccountHolderType() | setBankAccountHolderType(BankAccountHolderType bankAccountHolderType) |
| `PaymentType` | [`PaymentType`](../../doc/models/payment-type.md) | Required | **Default**: `PaymentType.BANK_ACCOUNT` | PaymentType getPaymentType() | setPaymentType(PaymentType paymentType) |
-| `Verified` | `Boolean` | Optional | denotes whether a bank account has been verified by providing the amounts of two small deposits made into the account
**Default**: `false` | Boolean getVerified() | setVerified(Boolean verified) |
+| `Verified` | `Boolean` | Optional | denotes whether a bank account has been verified by providing the amounts of two small deposits made into the account
**Default**: `false` | Boolean getVerified() | setVerified(Boolean verified) |
| `SiteGatewaySettingId` | `Integer` | Optional | - | Integer getSiteGatewaySettingId() | setSiteGatewaySettingId(Integer siteGatewaySettingId) |
| `GatewayHandle` | `String` | Optional | - | String getGatewayHandle() | setGatewayHandle(String gatewayHandle) |
+| `CreatedAt` | `ZonedDateTime` | Optional | A timestamp indicating when this payment profile was created | ZonedDateTime getCreatedAt() | setCreatedAt(ZonedDateTime createdAt) |
+| `UpdatedAt` | `ZonedDateTime` | Optional | A timestamp indicating when this payment profile was last updated | ZonedDateTime getUpdatedAt() | setUpdatedAt(ZonedDateTime updatedAt) |
## Example (as JSON)
diff --git a/doc/models/chargify-ebb.md b/doc/models/chargify-ebb.md
index 0c6fee1d..2e8cc348 100644
--- a/doc/models/chargify-ebb.md
+++ b/doc/models/chargify-ebb.md
@@ -12,7 +12,7 @@
| `Timestamp` | `ZonedDateTime` | Optional | This timestamp determines what billing period the event will be billed in. If your request payload does not include it, Chargify will add `chargify.timestamp` to the event payload and set the value to `now`. | ZonedDateTime getTimestamp() | setTimestamp(ZonedDateTime timestamp) |
| `Id` | `String` | Optional | A unique ID set by Chargify. Please note that this field is reserved. If `chargify.id` is present in the request payload, it will be overwritten. | String getId() | setId(String id) |
| `CreatedAt` | `ZonedDateTime` | Optional | An ISO-8601 timestamp, set by Chargify at the time each event is recorded. Please note that this field is reserved. If `chargify.created_at` is present in the request payload, it will be overwritten. | ZonedDateTime getCreatedAt() | setCreatedAt(ZonedDateTime createdAt) |
-| `UniquenessToken` | `String` | Optional | User-defined string scoped per-stream. Duplicate events within a stream will be silently ignored. Tokens expire after 31 days.
**Constraints**: *Maximum Length*: `64` | String getUniquenessToken() | setUniquenessToken(String uniquenessToken) |
+| `UniquenessToken` | `String` | Optional | User-defined string scoped per-stream. Duplicate events within a stream will be silently ignored. Tokens expire after 31 days.
**Constraints**: *Maximum Length*: `64` | String getUniquenessToken() | setUniquenessToken(String uniquenessToken) |
| `SubscriptionId` | `Integer` | Optional | Id of Maxio Advanced Billing Subscription which is connected to this event.
Provide `subscription_id` if you configured `chargify.subscription_id` as Subscription Identifier in your Event Stream. | Integer getSubscriptionId() | setSubscriptionId(Integer subscriptionId) |
| `SubscriptionReference` | `String` | Optional | Reference of Maxio Advanced Billing Subscription which is connected to this event.
Provide `subscription_reference` if you configured `chargify.subscription_reference` as Subscription Identifier in your Event Stream. | String getSubscriptionReference() | setSubscriptionReference(String subscriptionReference) |
diff --git a/doc/models/component.md b/doc/models/component.md
index 683eb420..2aa3d366 100644
--- a/doc/models/component.md
+++ b/doc/models/component.md
@@ -17,6 +17,7 @@
| `UnitPrice` | `String` | Optional | The amount the customer will be charged per unit. This field is only populated for ‘per_unit’ pricing schemes, otherwise it may be null. | String getUnitPrice() | setUnitPrice(String unitPrice) |
| `ProductFamilyId` | `Integer` | Optional | The id of the Product Family to which the Component belongs | Integer getProductFamilyId() | setProductFamilyId(Integer productFamilyId) |
| `ProductFamilyName` | `String` | Optional | The name of the Product Family to which the Component belongs | String getProductFamilyName() | setProductFamilyName(String productFamilyName) |
+| `ProductFamilyHandle` | `String` | Optional | The handle of the Product Family to which the Component belongs | String getProductFamilyHandle() | setProductFamilyHandle(String productFamilyHandle) |
| `PricePerUnitInCents` | `Long` | Optional | deprecated - use unit_price instead | Long getPricePerUnitInCents() | setPricePerUnitInCents(Long pricePerUnitInCents) |
| `Kind` | [`ComponentKind`](../../doc/models/component-kind.md) | Optional | A handle for the component type | ComponentKind getKind() | setKind(ComponentKind kind) |
| `Archived` | `Boolean` | Optional | Boolean flag describing whether a component is archived or not. | Boolean getArchived() | setArchived(Boolean archived) |
diff --git a/doc/models/coupon-request.md b/doc/models/coupon-request.md
index 6d003697..921e4931 100644
--- a/doc/models/coupon-request.md
+++ b/doc/models/coupon-request.md
@@ -10,8 +10,8 @@
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `Coupon` | [`CouponPayload`](../../doc/models/coupon-payload.md) | Optional | - | CouponPayload getCoupon() | setCoupon(CouponPayload coupon) |
-| `RestrictedProducts` | `Map` | Optional | An object where the keys are product_ids and the values are booleans indicating if the coupon should be applicable to the product | Map getRestrictedProducts() | setRestrictedProducts(Map restrictedProducts) |
-| `RestrictedComponents` | `Map` | Optional | An object where the keys are component_ids and the values are booleans indicating if the coupon should be applicable to the component | Map getRestrictedComponents() | setRestrictedComponents(Map restrictedComponents) |
+| `RestrictedProducts` | `Map` | Optional | An object where the keys are product IDs or handles (prefixed with 'handle:'), and the values are booleans indicating if the coupon should be applicable to the product | Map getRestrictedProducts() | setRestrictedProducts(Map restrictedProducts) |
+| `RestrictedComponents` | `Map` | Optional | An object where the keys are component IDs or handles (prefixed with 'handle:'), and the values are booleans indicating if the coupon should be applicable to the component | Map getRestrictedComponents() | setRestrictedComponents(Map restrictedComponents) |
## Example (as JSON)
diff --git a/doc/models/create-component-price-point.md b/doc/models/create-component-price-point.md
index 7263a1a7..b0906f8e 100644
--- a/doc/models/create-component-price-point.md
+++ b/doc/models/create-component-price-point.md
@@ -13,7 +13,7 @@
| `Handle` | `String` | Optional | - | String getHandle() | setHandle(String handle) |
| `PricingScheme` | [`PricingScheme`](../../doc/models/pricing-scheme.md) | Required | The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.html) for an overview of pricing schemes. | PricingScheme getPricingScheme() | setPricingScheme(PricingScheme pricingScheme) |
| `Prices` | [`List`](../../doc/models/price.md) | Required | - | List getPrices() | setPrices(List prices) |
-| `UseSiteExchangeRate` | `Boolean` | Optional | Whether to use the site level exchange rate or define your own prices for each currency if you have multiple currencies defined on the site. Setting not supported when creating price points in bulk.
**Default**: `true` | Boolean getUseSiteExchangeRate() | setUseSiteExchangeRate(Boolean useSiteExchangeRate) |
+| `UseSiteExchangeRate` | `Boolean` | Optional | Whether to use the site level exchange rate or define your own prices for each currency if you have multiple currencies defined on the site. Setting not supported when creating price points in bulk.
**Default**: `true` | Boolean getUseSiteExchangeRate() | setUseSiteExchangeRate(Boolean useSiteExchangeRate) |
| `TaxIncluded` | `Boolean` | Optional | Whether or not the price point includes tax. Setting not supported when creating price points in bulk. | Boolean getTaxIncluded() | setTaxIncluded(Boolean taxIncluded) |
| `Interval` | `Integer` | Optional | The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. | Integer getInterval() | setInterval(Integer interval) |
| `IntervalUnit` | [`IntervalUnit`](../../doc/models/interval-unit.md) | Optional | A string representing the interval unit for this price point, either month or day. This property is only available for sites with Multifrequency enabled. | IntervalUnit getIntervalUnit() | setIntervalUnit(IntervalUnit intervalUnit) |
diff --git a/doc/models/create-or-update-product.md b/doc/models/create-or-update-product.md
index d4066567..20c2219b 100644
--- a/doc/models/create-or-update-product.md
+++ b/doc/models/create-or-update-product.md
@@ -24,7 +24,7 @@
| `ExpirationInterval` | `Integer` | Optional | The numerical expiration interval. i.e. an expiration_interval of ‘30’ coupled with an expiration_interval_unit of day would mean this product would expire after 30 days. | Integer getExpirationInterval() | setExpirationInterval(Integer expirationInterval) |
| `ExpirationIntervalUnit` | [`ExpirationIntervalUnit`](../../doc/models/expiration-interval-unit.md) | Optional | A string representing the expiration interval unit for this product, either month, day or never | ExpirationIntervalUnit getExpirationIntervalUnit() | setExpirationIntervalUnit(ExpirationIntervalUnit expirationIntervalUnit) |
| `AutoCreateSignupPage` | `Boolean` | Optional | - | Boolean getAutoCreateSignupPage() | setAutoCreateSignupPage(Boolean autoCreateSignupPage) |
-| `TaxCode` | `String` | Optional | A string representing the tax code related to the product type. This is especially important when using the Avalara service to tax based on locale. This attribute has a max length of 10 characters.
**Constraints**: *Maximum Length*: `10` | String getTaxCode() | setTaxCode(String taxCode) |
+| `TaxCode` | `String` | Optional | A string representing the tax code related to the product type. This is especially important when using the Avalara service to tax based on locale. This attribute has a max length of 10 characters.
**Constraints**: *Maximum Length*: `10` | String getTaxCode() | setTaxCode(String taxCode) |
## Example (as JSON)
diff --git a/doc/models/create-prepaid-usage-component-price-point.md b/doc/models/create-prepaid-usage-component-price-point.md
index 21cb182f..fa2629a9 100644
--- a/doc/models/create-prepaid-usage-component-price-point.md
+++ b/doc/models/create-prepaid-usage-component-price-point.md
@@ -14,7 +14,7 @@
| `PricingScheme` | [`PricingScheme`](../../doc/models/pricing-scheme.md) | Required | The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.html) for an overview of pricing schemes. | PricingScheme getPricingScheme() | setPricingScheme(PricingScheme pricingScheme) |
| `Prices` | [`List`](../../doc/models/price.md) | Required | - | List getPrices() | setPrices(List prices) |
| `OveragePricing` | [`OveragePricing`](../../doc/models/overage-pricing.md) | Required | - | OveragePricing getOveragePricing() | setOveragePricing(OveragePricing overagePricing) |
-| `UseSiteExchangeRate` | `Boolean` | Optional | Whether to use the site level exchange rate or define your own prices for each currency if you have multiple currencies defined on the site.
**Default**: `true` | Boolean getUseSiteExchangeRate() | setUseSiteExchangeRate(Boolean useSiteExchangeRate) |
+| `UseSiteExchangeRate` | `Boolean` | Optional | Whether to use the site level exchange rate or define your own prices for each currency if you have multiple currencies defined on the site.
**Default**: `true` | Boolean getUseSiteExchangeRate() | setUseSiteExchangeRate(Boolean useSiteExchangeRate) |
| `RolloverPrepaidRemainder` | `Boolean` | Optional | (only for prepaid usage components) Boolean which controls whether or not remaining units should be rolled over to the next period | Boolean getRolloverPrepaidRemainder() | setRolloverPrepaidRemainder(Boolean rolloverPrepaidRemainder) |
| `RenewPrepaidAllocation` | `Boolean` | Optional | (only for prepaid usage components) Boolean which controls whether or not the allocated quantity should be renewed at the beginning of each period | Boolean getRenewPrepaidAllocation() | setRenewPrepaidAllocation(Boolean renewPrepaidAllocation) |
| `ExpirationInterval` | `Double` | Optional | (only for prepaid usage components where rollover_prepaid_remainder is true) The number of `expiration_interval_unit`s after which rollover amounts should expire | Double getExpirationInterval() | setExpirationInterval(Double expirationInterval) |
diff --git a/doc/models/create-product-price-point.md b/doc/models/create-product-price-point.md
index a25db0b6..4ba908ac 100644
--- a/doc/models/create-product-price-point.md
+++ b/doc/models/create-product-price-point.md
@@ -22,7 +22,7 @@
| `InitialChargeAfterTrial` | `Boolean` | Optional | - | Boolean getInitialChargeAfterTrial() | setInitialChargeAfterTrial(Boolean initialChargeAfterTrial) |
| `ExpirationInterval` | `Integer` | Optional | The numerical expiration interval. i.e. an expiration_interval of ‘30’ coupled with an expiration_interval_unit of day would mean this product price point would expire after 30 days. | Integer getExpirationInterval() | setExpirationInterval(Integer expirationInterval) |
| `ExpirationIntervalUnit` | [`ExpirationIntervalUnit`](../../doc/models/expiration-interval-unit.md) | Optional | A string representing the expiration interval unit for this product price point, either month, day or never | ExpirationIntervalUnit getExpirationIntervalUnit() | setExpirationIntervalUnit(ExpirationIntervalUnit expirationIntervalUnit) |
-| `UseSiteExchangeRate` | `Boolean` | Optional | Whether or not to use the site's exchange rate or define your own pricing when your site has multiple currencies defined.
**Default**: `true` | Boolean getUseSiteExchangeRate() | setUseSiteExchangeRate(Boolean useSiteExchangeRate) |
+| `UseSiteExchangeRate` | `Boolean` | Optional | Whether or not to use the site's exchange rate or define your own pricing when your site has multiple currencies defined.
**Default**: `true` | Boolean getUseSiteExchangeRate() | setUseSiteExchangeRate(Boolean useSiteExchangeRate) |
## Example (as JSON)
diff --git a/doc/models/create-subscription-request.md b/doc/models/create-subscription-request.md
index fabfc752..5b16c350 100644
--- a/doc/models/create-subscription-request.md
+++ b/doc/models/create-subscription-request.md
@@ -16,6 +16,7 @@
```json
{
"subscription": {
+ "defer_signup": false,
"metafields": {
"custom_field_name_1": "custom_field_value_1",
"custom_field_name_2": "custom_field_value_2"
diff --git a/doc/models/create-subscription.md b/doc/models/create-subscription.md
index d2a561bc..01620c61 100644
--- a/doc/models/create-subscription.md
+++ b/doc/models/create-subscription.md
@@ -21,11 +21,12 @@
| `NetTerms` | `String` | Optional | (Optional) Default: null The number of days after renewal (on invoice billing) that a subscription is due. A value between 0 (due immediately) and 180. | String getNetTerms() | setNetTerms(String netTerms) |
| `CustomerId` | `Integer` | Optional | The ID of an existing customer within Chargify. Required, unless a `customer_reference` or a set of `customer_attributes` is given. | Integer getCustomerId() | setCustomerId(Integer customerId) |
| `NextBillingAt` | `ZonedDateTime` | Optional | (Optional) Set this attribute to a future date/time to sync imported subscriptions to your existing renewal schedule. See the notes on “Date/Time Format” in our [subscription import documentation](https://maxio.zendesk.com/hc/en-us/articles/24251489107213-Advanced-Billing-Subscription-Imports#date-format). If you provide a next_billing_at timestamp that is in the future, no trial or initial charges will be applied when you create the subscription. In fact, no payment will be captured at all. The first payment will be captured, according to the prices defined by the product, near the time specified by next_billing_at. If you do not provide a value for next_billing_at, any trial and/or initial charges will be assessed and charged at the time of subscription creation. If the card cannot be successfully charged, the subscription will not be created. See further notes in the section on Importing Subscriptions. | ZonedDateTime getNextBillingAt() | setNextBillingAt(ZonedDateTime nextBillingAt) |
-| `InitialBillingAt` | `ZonedDateTime` | Optional | (Optional) Set this attribute to a future date/time to create a subscription in the "Awaiting Signup" state, rather than "Active" or "Trialing". See the notes on “Date/Time Format” in our [subscription import documentation](https://maxio.zendesk.com/hc/en-us/articles/24251489107213-Advanced-Billing-Subscription-Imports#date-format). In the "Awaiting Signup" state, a subscription behaves like any other. It can be canceled, allocated to, had its billing date changed. etc. When the initial_billing_at date hits, the subscription will transition to the expected state. If the product has a trial, the subscription will enter a trial, otherwise it will go active. Setup fees will be respected either before or after the trial, as configured on the price point. If the payment is due at the initial_billing_at and it fails the subscription will be immediately canceled. See further notes in the section on Delayed Signups. | ZonedDateTime getInitialBillingAt() | setInitialBillingAt(ZonedDateTime initialBillingAt) |
+| `InitialBillingAt` | `ZonedDateTime` | Optional | (Optional) Set this attribute to a future date/time to create a subscription in the Awaiting Signup state, rather than Active or Trialing. You can omit the initial_billing_at date to activate the subscription immediately. In the Awaiting Signup state, a subscription behaves like any other. It can be canceled, allocated to, or have its billing date changed. etc. When the initial_billing_at date hits, the subscription will transition to the expected state. If the product has a trial, the subscription will enter a trial, otherwise it will go active. Setup fees will be respected either before or after the trial, as configured on the price point. If the payment is due at the initial_billing_at and it fails the subscription will be immediately canceled. See the [subscription import](https://maxio.zendesk.com/hc/en-us/articles/24251489107213-Advanced-Billing-Subscription-Imports#date-format) documentation for more information about Date/Time Formats. | ZonedDateTime getInitialBillingAt() | setInitialBillingAt(ZonedDateTime initialBillingAt) |
+| `DeferSignup` | `Boolean` | Optional | (Optional) Set this attribute to true to create the subscription in the Awaiting Signup Date state. Use this when you want to create a subscription that has an unknown first billing date. When the first billing date is known, update a subscription and set the `initial_billing_at` date. The subscription moves to the Awaiting Signup state with a scheduled initial billing date. You can omit the initial_billing_at date to activate the subscription immediately. See [Subscription States](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404222005773-Subscription-States) for more information.
**Default**: `false` | Boolean getDeferSignup() | setDeferSignup(Boolean deferSignup) |
| `StoredCredentialTransactionId` | `Integer` | Optional | For European sites subject to PSD2 and using 3D Secure, this can be used to reference a previous transaction for the customer. This will ensure the card will be charged successfully at renewal. | Integer getStoredCredentialTransactionId() | setStoredCredentialTransactionId(Integer storedCredentialTransactionId) |
| `SalesRepId` | `Integer` | Optional | - | Integer getSalesRepId() | setSalesRepId(Integer salesRepId) |
| `PaymentProfileId` | `Integer` | Optional | The Payment Profile ID of an existing card or bank account, which belongs to an existing customer to use for payment for this subscription. If the card, bank account, or customer does not exist already, or if you want to use a new (unstored) card or bank account for the subscription, use `payment_profile_attributes` instead to create a new payment profile along with the subscription. (This value is available on an existing subscription via the API as `credit_card` > id or `bank_account` > id) | Integer getPaymentProfileId() | setPaymentProfileId(Integer paymentProfileId) |
-| `Reference` | `String` | Optional | The reference value (provided by your app) for the subscription itelf. | String getReference() | setReference(String reference) |
+| `Reference` | `String` | Optional | The reference value (provided by your app) for the subscription itself. | String getReference() | setReference(String reference) |
| `CustomerAttributes` | [`CustomerAttributes`](../../doc/models/customer-attributes.md) | Optional | - | CustomerAttributes getCustomerAttributes() | setCustomerAttributes(CustomerAttributes customerAttributes) |
| `PaymentProfileAttributes` | [`PaymentProfileAttributes`](../../doc/models/payment-profile-attributes.md) | Optional | alias to credit_card_attributes | PaymentProfileAttributes getPaymentProfileAttributes() | setPaymentProfileAttributes(PaymentProfileAttributes paymentProfileAttributes) |
| `CreditCardAttributes` | [`PaymentProfileAttributes`](../../doc/models/payment-profile-attributes.md) | Optional | Credit Card data to create a new Subscription. Interchangeable with `payment_profile_attributes` property. | PaymentProfileAttributes getCreditCardAttributes() | setCreditCardAttributes(PaymentProfileAttributes creditCardAttributes) |
@@ -46,7 +47,7 @@
| `AuthorizerLastName` | `String` | Optional | (Optional) The last name of the person authorizing the ACH agreement. | String getAuthorizerLastName() | setAuthorizerLastName(String authorizerLastName) |
| `CalendarBillingFirstCharge` | `String` | Optional | (Optional) One of “prorated” (the default – the prorated product price will be charged immediately), “immediate” (the full product price will be charged immediately), or “delayed” (the full product price will be charged with the first scheduled renewal). | String getCalendarBillingFirstCharge() | setCalendarBillingFirstCharge(String calendarBillingFirstCharge) |
| `ReasonCode` | `String` | Optional | (Optional) Can be used when canceling a subscription (via the HTTP DELETE method) to indicate why a subscription was canceled. | String getReasonCode() | setReasonCode(String reasonCode) |
-| `ProductChangeDelayed` | `Boolean` | Optional | (Optional, used only for Delayed Product Change When set to true, indicates that a changed value for product_handle should schedule the product change to the next subscription renewal. | Boolean getProductChangeDelayed() | setProductChangeDelayed(Boolean productChangeDelayed) |
+| `ProductChangeDelayed` | `Boolean` | Optional | (Optional) used only for Delayed Product Change When set to true, indicates that a changed value for product_handle should schedule the product change to the next subscription renewal. | Boolean getProductChangeDelayed() | setProductChangeDelayed(Boolean productChangeDelayed) |
| `OfferId` | [`CreateSubscriptionOfferId`](../../doc/models/containers/create-subscription-offer-id.md) | Optional | This is a container for one-of cases. | CreateSubscriptionOfferId getOfferId() | setOfferId(CreateSubscriptionOfferId offerId) |
| `PrepaidConfiguration` | [`UpsertPrepaidConfiguration`](../../doc/models/upsert-prepaid-configuration.md) | Optional | - | UpsertPrepaidConfiguration getPrepaidConfiguration() | setPrepaidConfiguration(UpsertPrepaidConfiguration prepaidConfiguration) |
| `PreviousBillingAt` | `ZonedDateTime` | Optional | Providing a previous_billing_at that is in the past will set the current_period_starts_at when the subscription is created. It will also set activated_at if not explicitly passed during the subscription import. Can only be used if next_billing_at is also passed. Using this option will allow you to set the period start for the subscription so mid period component allocations have the correct prorated amount. | ZonedDateTime getPreviousBillingAt() | setPreviousBillingAt(ZonedDateTime previousBillingAt) |
@@ -55,14 +56,15 @@
| `ActivatedAt` | `ZonedDateTime` | Optional | - | ZonedDateTime getActivatedAt() | setActivatedAt(ZonedDateTime activatedAt) |
| `AgreementAcceptance` | [`AgreementAcceptance`](../../doc/models/agreement-acceptance.md) | Optional | Required when creating a subscription with Maxio Payments. | AgreementAcceptance getAgreementAcceptance() | setAgreementAcceptance(AgreementAcceptance agreementAcceptance) |
| `AchAgreement` | [`ACHAgreement`](../../doc/models/ach-agreement.md) | Optional | (Optional) If passed, the proof of the authorized ACH agreement terms will be persisted. | ACHAgreement getAchAgreement() | setAchAgreement(ACHAgreement achAgreement) |
-| `DunningCommunicationDelayEnabled` | `Boolean` | Optional | Enable Communication Delay feature, making sure no communication (email or SMS) is sent to the Customer between 9PM and 8AM in time zone set by the `dunning_communication_delay_time_zone` attribute.
**Default**: `false` | Boolean getDunningCommunicationDelayEnabled() | setDunningCommunicationDelayEnabled(Boolean dunningCommunicationDelayEnabled) |
+| `DunningCommunicationDelayEnabled` | `Boolean` | Optional | Enable Communication Delay feature, making sure no communication (email or SMS) is sent to the Customer between 9PM and 8AM in time zone set by the `dunning_communication_delay_time_zone` attribute.
**Default**: `false` | Boolean getDunningCommunicationDelayEnabled() | setDunningCommunicationDelayEnabled(Boolean dunningCommunicationDelayEnabled) |
| `DunningCommunicationDelayTimeZone` | `String` | Optional | Time zone for the Dunning Communication Delay feature. | String getDunningCommunicationDelayTimeZone() | setDunningCommunicationDelayTimeZone(String dunningCommunicationDelayTimeZone) |
-| `SkipBillingManifestTaxes` | `Boolean` | Optional | Valid only for the Subscription Preview endpoint. When set to `true` it skips calculating taxes for the current and next billing manifests.
**Default**: `false` | Boolean getSkipBillingManifestTaxes() | setSkipBillingManifestTaxes(Boolean skipBillingManifestTaxes) |
+| `SkipBillingManifestTaxes` | `Boolean` | Optional | Valid only for the Subscription Preview endpoint. When set to `true` it skips calculating taxes for the current and next billing manifests.
**Default**: `false` | Boolean getSkipBillingManifestTaxes() | setSkipBillingManifestTaxes(Boolean skipBillingManifestTaxes) |
## Example (as JSON)
```json
{
+ "defer_signup": false,
"metafields": {
"custom_field_name_1": "custom_field_value_1",
"custom_field_name_2": "custom_field_value_2"
diff --git a/doc/models/credit-card-payment-profile.md b/doc/models/credit-card-payment-profile.md
index c75b1cf8..da0204a7 100644
--- a/doc/models/credit-card-payment-profile.md
+++ b/doc/models/credit-card-payment-profile.md
@@ -31,6 +31,8 @@
| `ChargifyToken` | `String` | Optional | Token received after sending billing information using chargify.js. This token will only be received if passed as a sole attribute of credit_card_attributes (i.e. tok_9g6hw85pnpt6knmskpwp4ttt) | String getChargifyToken() | setChargifyToken(String chargifyToken) |
| `SiteGatewaySettingId` | `Integer` | Optional | - | Integer getSiteGatewaySettingId() | setSiteGatewaySettingId(Integer siteGatewaySettingId) |
| `GatewayHandle` | `String` | Optional | An identifier of connected gateway. | String getGatewayHandle() | setGatewayHandle(String gatewayHandle) |
+| `CreatedAt` | `ZonedDateTime` | Optional | A timestamp indicating when this payment profile was created | ZonedDateTime getCreatedAt() | setCreatedAt(ZonedDateTime createdAt) |
+| `UpdatedAt` | `ZonedDateTime` | Optional | A timestamp indicating when this payment profile was last updated | ZonedDateTime getUpdatedAt() | setUpdatedAt(ZonedDateTime updatedAt) |
## Example (as JSON)
diff --git a/doc/models/ebb-component.md b/doc/models/ebb-component.md
index cf386379..406769a2 100644
--- a/doc/models/ebb-component.md
+++ b/doc/models/ebb-component.md
@@ -12,7 +12,7 @@
| `Name` | `String` | Required | A name for this component that is suitable for showing customers and displaying on billing statements, ie. "Minutes". | String getName() | setName(String name) |
| `UnitName` | `String` | Required | The name of the unit of measurement for the component. It should be singular since it will be automatically pluralized when necessary. i.e. “message”, which may then be shown as “5 messages” on a subscription’s component line-item | String getUnitName() | setUnitName(String unitName) |
| `Description` | `String` | Optional | A description for the component that will be displayed to the user on the hosted signup page. | String getDescription() | setDescription(String description) |
-| `Handle` | `String` | Optional | A unique identifier for your use that can be used to retrieve this component is subsequent requests. Must start with a letter or number and may only contain lowercase letters, numbers, or the characters '.', ':', '-', or '_'.
**Constraints**: *Pattern*: `^[a-z0-9][a-z0-9\-_:.]*$` | String getHandle() | setHandle(String handle) |
+| `Handle` | `String` | Optional | A unique identifier for your use that can be used to retrieve this component is subsequent requests. Must start with a letter or number and may only contain lowercase letters, numbers, or the characters '.', ':', '-', or '_'.
**Constraints**: *Pattern*: `^[a-z0-9][a-z0-9\-_:.]*$` | String getHandle() | setHandle(String handle) |
| `Taxable` | `Boolean` | Optional | Boolean flag describing whether a component is taxable or not. | Boolean getTaxable() | setTaxable(Boolean taxable) |
| `PricingScheme` | [`PricingScheme`](../../doc/models/pricing-scheme.md) | Required | The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.html) for an overview of pricing schemes. | PricingScheme getPricingScheme() | setPricingScheme(PricingScheme pricingScheme) |
| `Prices` | [`List`](../../doc/models/price.md) | Optional | (Not required for ‘per_unit’ pricing schemes) One or more price brackets. See [Price Bracket Rules](https://maxio.zendesk.com/hc/en-us/articles/24261149166733-Component-Pricing-Schemes#price-bracket-rules) for an overview of how price brackets work for different pricing schemes. | List getPrices() | setPrices(List prices) |
diff --git a/doc/models/group-billing.md b/doc/models/group-billing.md
index f88b4b41..1c029beb 100644
--- a/doc/models/group-billing.md
+++ b/doc/models/group-billing.md
@@ -11,9 +11,9 @@ Optional attributes related to billing date and accrual. Note: Only applicable f
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
-| `Accrue` | `Boolean` | Optional | A flag indicating whether or not to accrue charges on the new subscription.
**Default**: `false` | Boolean getAccrue() | setAccrue(Boolean accrue) |
-| `AlignDate` | `Boolean` | Optional | A flag indicating whether or not to align the billing date of the new subscription with the billing date of the primary subscription of the hierarchy's default subscription group. Required to be true if prorate is also true.
**Default**: `false` | Boolean getAlignDate() | setAlignDate(Boolean alignDate) |
-| `Prorate` | `Boolean` | Optional | A flag indicating whether or not to prorate billing of the new subscription for the current period. A value of true is ignored unless align_date is also true.
**Default**: `false` | Boolean getProrate() | setProrate(Boolean prorate) |
+| `Accrue` | `Boolean` | Optional | A flag indicating whether or not to accrue charges on the new subscription.
**Default**: `false` | Boolean getAccrue() | setAccrue(Boolean accrue) |
+| `AlignDate` | `Boolean` | Optional | A flag indicating whether or not to align the billing date of the new subscription with the billing date of the primary subscription of the hierarchy's default subscription group. Required to be true if prorate is also true.
**Default**: `false` | Boolean getAlignDate() | setAlignDate(Boolean alignDate) |
+| `Prorate` | `Boolean` | Optional | A flag indicating whether or not to prorate billing of the new subscription for the current period. A value of true is ignored unless align_date is also true.
**Default**: `false` | Boolean getProrate() | setProrate(Boolean prorate) |
## Example (as JSON)
diff --git a/doc/models/issue-invoice-request.md b/doc/models/issue-invoice-request.md
index d28e7e6e..1e8c02f8 100644
--- a/doc/models/issue-invoice-request.md
+++ b/doc/models/issue-invoice-request.md
@@ -9,7 +9,7 @@
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
-| `OnFailedPayment` | [`FailedPaymentAction`](../../doc/models/failed-payment-action.md) | Optional | Action taken when payment for an invoice fails:
- `leave_open_invoice` - prepayments and credits applied to invoice; invoice status set to "open"; email sent to the customer for the issued invoice (if setting applies); payment failure recorded in the invoice history. This is the default option.
- `rollback_to_pending` - prepayments and credits not applied; invoice remains in "pending" status; no email sent to the customer; payment failure recorded in the invoice history.
- `initiate_dunning` - prepayments and credits applied to the invoice; invoice status set to "open"; email sent to the customer for the issued invoice (if setting applies); payment failure recorded in the invoice history; subscription will most likely go into "past_due" or "canceled" state (depending upon net terms and dunning settings).
**Default**: `FailedPaymentAction.LEAVE_OPEN_INVOICE` | FailedPaymentAction getOnFailedPayment() | setOnFailedPayment(FailedPaymentAction onFailedPayment) |
+| `OnFailedPayment` | [`FailedPaymentAction`](../../doc/models/failed-payment-action.md) | Optional | Action taken when payment for an invoice fails:
- `leave_open_invoice` - prepayments and credits applied to invoice; invoice status set to "open"; email sent to the customer for the issued invoice (if setting applies); payment failure recorded in the invoice history. This is the default option.
- `rollback_to_pending` - prepayments and credits not applied; invoice remains in "pending" status; no email sent to the customer; payment failure recorded in the invoice history.
- `initiate_dunning` - prepayments and credits applied to the invoice; invoice status set to "open"; email sent to the customer for the issued invoice (if setting applies); payment failure recorded in the invoice history; subscription will most likely go into "past_due" or "canceled" state (depending upon net terms and dunning settings).
**Default**: `FailedPaymentAction.LEAVE_OPEN_INVOICE` | FailedPaymentAction getOnFailedPayment() | setOnFailedPayment(FailedPaymentAction onFailedPayment) |
## Example (as JSON)
diff --git a/doc/models/list-components-filter.md b/doc/models/list-components-filter.md
index 79c4010b..c8602989 100644
--- a/doc/models/list-components-filter.md
+++ b/doc/models/list-components-filter.md
@@ -9,7 +9,7 @@
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
-| `Ids` | `List` | Optional | Allows fetching components with matching id based on provided value. Use in query `filter[ids]=1,2,3`.
**Constraints**: *Minimum Items*: `1` | List getIds() | setIds(List ids) |
+| `Ids` | `List` | Optional | Allows fetching components with matching id based on provided value. Use in query `filter[ids]=1,2,3`.
**Constraints**: *Minimum Items*: `1` | List getIds() | setIds(List ids) |
| `UseSiteExchangeRate` | `Boolean` | Optional | Allows fetching components with matching use_site_exchange_rate based on provided value (refers to default price point). Use in query `filter[use_site_exchange_rate]=true`. | Boolean getUseSiteExchangeRate() | setUseSiteExchangeRate(Boolean useSiteExchangeRate) |
## Example (as JSON)
diff --git a/doc/models/list-coupons-filter.md b/doc/models/list-coupons-filter.md
index 72c3de63..f58b54d9 100644
--- a/doc/models/list-coupons-filter.md
+++ b/doc/models/list-coupons-filter.md
@@ -14,7 +14,7 @@
| `EndDate` | `LocalDate` | Optional | The end date (format YYYY-MM-DD) with which to filter the date_field. Returns coupons with a timestamp up to and including 11:59:59PM in your site’s time zone on the date specified. Use in query `filter[end_date]=2011-12-15`. | LocalDate getEndDate() | setEndDate(LocalDate endDate) |
| `StartDatetime` | `ZonedDateTime` | Optional | The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns coupons with a timestamp at or after exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of start_date. Use in query `filter[start_datetime]=2011-12-19T10:15:30+01:00`. | ZonedDateTime getStartDatetime() | setStartDatetime(ZonedDateTime startDatetime) |
| `EndDatetime` | `ZonedDateTime` | Optional | The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns coupons with a timestamp at or before exact time provided in query. You can specify timezone in query - otherwise your site's time zone will be used. If provided, this parameter will be used instead of end_date. Use in query `filter[end_datetime]=2011-12-1T10:15:30+01:00`. | ZonedDateTime getEndDatetime() | setEndDatetime(ZonedDateTime endDatetime) |
-| `Ids` | `List` | Optional | Allows fetching coupons with matching id based on provided values. Use in query `filter[ids]=1,2,3`.
**Constraints**: *Minimum Items*: `1` | List getIds() | setIds(List ids) |
+| `Ids` | `List` | Optional | Allows fetching coupons with matching id based on provided values. Use in query `filter[ids]=1,2,3`.
**Constraints**: *Minimum Items*: `1` | List getIds() | setIds(List ids) |
| `Codes` | `List` | Optional | Allows fetching coupons with matching codes based on provided values. Use in query `filter[codes]=free,free_trial`. | List getCodes() | setCodes(List codes) |
| `UseSiteExchangeRate` | `Boolean` | Optional | Allows fetching coupons with matching use_site_exchange_rate based on provided value. Use in query `filter[use_site_exchange_rate]=true`. | Boolean getUseSiteExchangeRate() | setUseSiteExchangeRate(Boolean useSiteExchangeRate) |
diff --git a/doc/models/list-mrr-filter.md b/doc/models/list-mrr-filter.md
index ce2e7761..fe2afd1b 100644
--- a/doc/models/list-mrr-filter.md
+++ b/doc/models/list-mrr-filter.md
@@ -9,7 +9,7 @@
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
-| `SubscriptionIds` | `List` | Optional | Submit ids in order to limit results. Use in query: `filter[subscription_ids]=1,2,3`.
**Constraints**: *Minimum Items*: `1` | List getSubscriptionIds() | setSubscriptionIds(List subscriptionIds) |
+| `SubscriptionIds` | `List` | Optional | Submit ids in order to limit results. Use in query: `filter[subscription_ids]=1,2,3`.
**Constraints**: *Minimum Items*: `1` | List getSubscriptionIds() | setSubscriptionIds(List subscriptionIds) |
## Example (as JSON)
diff --git a/doc/models/list-products-filter.md b/doc/models/list-products-filter.md
index 6277e564..c9b3ab6e 100644
--- a/doc/models/list-products-filter.md
+++ b/doc/models/list-products-filter.md
@@ -9,7 +9,7 @@
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
-| `Ids` | `List` | Optional | Allows fetching products with matching id based on provided values. Use in query `filter[ids]=1,2,3`.
**Constraints**: *Minimum Items*: `1` | List getIds() | setIds(List ids) |
+| `Ids` | `List` | Optional | Allows fetching products with matching id based on provided values. Use in query `filter[ids]=1,2,3`.
**Constraints**: *Minimum Items*: `1` | List getIds() | setIds(List ids) |
| `PrepaidProductPricePoint` | [`PrepaidProductPricePointFilter`](../../doc/models/prepaid-product-price-point-filter.md) | Optional | Allows fetching products only if a prepaid product price point is present or not. To use this filter you also have to include the following param in the request `include=prepaid_product_price_point`. Use in query `filter[prepaid_product_price_point][product_price_point_id]=not_null`. | PrepaidProductPricePointFilter getPrepaidProductPricePoint() | setPrepaidProductPricePoint(PrepaidProductPricePointFilter prepaidProductPricePoint) |
| `UseSiteExchangeRate` | `Boolean` | Optional | Allows fetching products with matching use_site_exchange_rate based on provided value (refers to default price point). Use in query `filter[use_site_exchange_rate]=true`. | Boolean getUseSiteExchangeRate() | setUseSiteExchangeRate(Boolean useSiteExchangeRate) |
diff --git a/doc/models/list-service-credits-response.md b/doc/models/list-service-credits-response.md
new file mode 100644
index 00000000..e82e6edb
--- /dev/null
+++ b/doc/models/list-service-credits-response.md
@@ -0,0 +1,36 @@
+
+# List Service Credits Response
+
+## Structure
+
+`ListServiceCreditsResponse`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter | Setter |
+| --- | --- | --- | --- | --- | --- |
+| `ServiceCredits` | [`List`](../../doc/models/service-credit-1.md) | Optional | - | List getServiceCredits() | setServiceCredits(List serviceCredits) |
+
+## Example (as JSON)
+
+```json
+{
+ "service_credits": [
+ {
+ "id": 224,
+ "amount_in_cents": 54,
+ "ending_balance_in_cents": 94,
+ "entry_type": "Credit",
+ "memo": "memo2"
+ },
+ {
+ "id": 224,
+ "amount_in_cents": 54,
+ "ending_balance_in_cents": 94,
+ "entry_type": "Credit",
+ "memo": "memo2"
+ }
+ ]
+}
+```
+
diff --git a/doc/models/list-subscription-components-filter.md b/doc/models/list-subscription-components-filter.md
index 63735be2..b3d58c77 100644
--- a/doc/models/list-subscription-components-filter.md
+++ b/doc/models/list-subscription-components-filter.md
@@ -9,7 +9,7 @@
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
-| `Currencies` | `List` | Optional | Allows fetching components allocation with matching currency based on provided values. Use in query `filter[currencies]=EUR,USD`.
**Constraints**: *Minimum Items*: `1` | List getCurrencies() | setCurrencies(List currencies) |
+| `Currencies` | `List` | Optional | Allows fetching components allocation with matching currency based on provided values. Use in query `filter[currencies]=EUR,USD`.
**Constraints**: *Minimum Items*: `1` | List getCurrencies() | setCurrencies(List currencies) |
| `UseSiteExchangeRate` | `Boolean` | Optional | Allows fetching components allocation with matching use_site_exchange_rate based on provided value. Use in query `filter[use_site_exchange_rate]=true`. | Boolean getUseSiteExchangeRate() | setUseSiteExchangeRate(Boolean useSiteExchangeRate) |
## Example (as JSON)
diff --git a/doc/models/list-subscription-components-for-site-filter.md b/doc/models/list-subscription-components-for-site-filter.md
index 83b90ffc..8217d0fd 100644
--- a/doc/models/list-subscription-components-for-site-filter.md
+++ b/doc/models/list-subscription-components-for-site-filter.md
@@ -9,7 +9,7 @@
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
-| `Currencies` | `List` | Optional | Allows fetching components allocation with matching currency based on provided values. Use in query `filter[currencies]=USD,EUR`.
**Constraints**: *Minimum Items*: `1` | List getCurrencies() | setCurrencies(List currencies) |
+| `Currencies` | `List` | Optional | Allows fetching components allocation with matching currency based on provided values. Use in query `filter[currencies]=USD,EUR`.
**Constraints**: *Minimum Items*: `1` | List getCurrencies() | setCurrencies(List currencies) |
| `UseSiteExchangeRate` | `Boolean` | Optional | Allows fetching components allocation with matching use_site_exchange_rate based on provided value. Use in query `filter[use_site_exchange_rate]=true`. | Boolean getUseSiteExchangeRate() | setUseSiteExchangeRate(Boolean useSiteExchangeRate) |
| `Subscription` | [`SubscriptionFilter`](../../doc/models/subscription-filter.md) | Optional | Nested filter used for List Subscription Components For Site Filter | SubscriptionFilter getSubscription() | setSubscription(SubscriptionFilter subscription) |
diff --git a/doc/models/metered-component.md b/doc/models/metered-component.md
index 358f1176..a1fd26b4 100644
--- a/doc/models/metered-component.md
+++ b/doc/models/metered-component.md
@@ -12,7 +12,7 @@
| `Name` | `String` | Required | A name for this component that is suitable for showing customers and displaying on billing statements, ie. "Minutes". | String getName() | setName(String name) |
| `UnitName` | `String` | Required | The name of the unit of measurement for the component. It should be singular since it will be automatically pluralized when necessary. i.e. “message”, which may then be shown as “5 messages” on a subscription’s component line-item | String getUnitName() | setUnitName(String unitName) |
| `Description` | `String` | Optional | A description for the component that will be displayed to the user on the hosted signup page. | String getDescription() | setDescription(String description) |
-| `Handle` | `String` | Optional | A unique identifier for your use that can be used to retrieve this component is subsequent requests. Must start with a letter or number and may only contain lowercase letters, numbers, or the characters '.', ':', '-', or '_'.
**Constraints**: *Pattern*: `^[a-z0-9][a-z0-9\-_:.]*$` | String getHandle() | setHandle(String handle) |
+| `Handle` | `String` | Optional | A unique identifier for your use that can be used to retrieve this component is subsequent requests. Must start with a letter or number and may only contain lowercase letters, numbers, or the characters '.', ':', '-', or '_'.
**Constraints**: *Pattern*: `^[a-z0-9][a-z0-9\-_:.]*$` | String getHandle() | setHandle(String handle) |
| `Taxable` | `Boolean` | Optional | Boolean flag describing whether a component is taxable or not. | Boolean getTaxable() | setTaxable(Boolean taxable) |
| `PricingScheme` | [`PricingScheme`](../../doc/models/pricing-scheme.md) | Required | The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.html) for an overview of pricing schemes. | PricingScheme getPricingScheme() | setPricingScheme(PricingScheme pricingScheme) |
| `Prices` | [`List`](../../doc/models/price.md) | Optional | (Not required for ‘per_unit’ pricing schemes) One or more price brackets. See [Price Bracket Rules](https://maxio.zendesk.com/hc/en-us/articles/24261149166733-Component-Pricing-Schemes#price-bracket-rules) for an overview of how price brackets work for different pricing schemes. | List getPrices() | setPrices(List prices) |
diff --git a/doc/models/on-off-component.md b/doc/models/on-off-component.md
index 81ecbe8b..2ed8c725 100644
--- a/doc/models/on-off-component.md
+++ b/doc/models/on-off-component.md
@@ -11,7 +11,7 @@
| --- | --- | --- | --- | --- | --- |
| `Name` | `String` | Required | A name for this component that is suitable for showing customers and displaying on billing statements, ie. "Minutes". | String getName() | setName(String name) |
| `Description` | `String` | Optional | A description for the component that will be displayed to the user on the hosted signup page. | String getDescription() | setDescription(String description) |
-| `Handle` | `String` | Optional | A unique identifier for your use that can be used to retrieve this component is subsequent requests. Must start with a letter or number and may only contain lowercase letters, numbers, or the characters '.', ':', '-', or '_'.
**Constraints**: *Pattern*: `^[a-z0-9][a-z0-9\-_:.]*$` | String getHandle() | setHandle(String handle) |
+| `Handle` | `String` | Optional | A unique identifier for your use that can be used to retrieve this component is subsequent requests. Must start with a letter or number and may only contain lowercase letters, numbers, or the characters '.', ':', '-', or '_'.
**Constraints**: *Pattern*: `^[a-z0-9][a-z0-9\-_:.]*$` | String getHandle() | setHandle(String handle) |
| `Taxable` | `Boolean` | Optional | Boolean flag describing whether a component is taxable or not. | Boolean getTaxable() | setTaxable(Boolean taxable) |
| `UpgradeCharge` | [`CreditType`](../../doc/models/credit-type.md) | Optional | The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided.
Available values: `full`, `prorated`, `none`. | CreditType getUpgradeCharge() | setUpgradeCharge(CreditType upgradeCharge) |
| `DowngradeCredit` | [`CreditType`](../../doc/models/credit-type.md) | Optional | The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided.
Available values: `full`, `prorated`, `none`. | CreditType getDowngradeCredit() | setDowngradeCredit(CreditType downgradeCredit) |
diff --git a/doc/models/override-subscription.md b/doc/models/override-subscription.md
index ef4eec3a..56240e2f 100644
--- a/doc/models/override-subscription.md
+++ b/doc/models/override-subscription.md
@@ -12,7 +12,7 @@
| `ActivatedAt` | `ZonedDateTime` | Optional | Can be used to record an external signup date. Chargify uses this field to record when a subscription first goes active (either at signup or at trial end). Only ISO8601 format is supported. | ZonedDateTime getActivatedAt() | setActivatedAt(ZonedDateTime activatedAt) |
| `CanceledAt` | `ZonedDateTime` | Optional | Can be used to record an external cancellation date. Chargify sets this field automatically when a subscription is canceled, whether by request or via dunning. Only ISO8601 format is supported. | ZonedDateTime getCanceledAt() | setCanceledAt(ZonedDateTime canceledAt) |
| `CancellationMessage` | `String` | Optional | Can be used to record a reason for the original cancellation. | String getCancellationMessage() | setCancellationMessage(String cancellationMessage) |
-| `ExpiresAt` | `ZonedDateTime` | Optional | Can be used to record an external expiration date. Chargify sets this field automatically when a subscription expires (ceases billing) after a prescribed amount of time. Only ISO8601 format is supported. | ZonedDateTime getExpiresAt() | setExpiresAt(ZonedDateTime expiresAt) |
+| `ExpiresAt` | `ZonedDateTime` | Optional | Can be used to record an external expiration date. Chargify sets this field automatically when a subscription expires (ceases billing) after a prescribed amount of time. Only ISO8601 format is supported. This field is not supported when Multi-frequency is enabled for the Site. To change the Term End of a Subscription, use the Update Subscription endpoint. | ZonedDateTime getExpiresAt() | setExpiresAt(ZonedDateTime expiresAt) |
| `CurrentPeriodStartsAt` | `ZonedDateTime` | Optional | Can only be used when a subscription is unbilled, which happens when a future initial billing date is passed at subscription creation. The value passed must be before the current date and time. Allows you to set when the period started so mid period component allocations have the correct proration. Only ISO8601 format is supported. | ZonedDateTime getCurrentPeriodStartsAt() | setCurrentPeriodStartsAt(ZonedDateTime currentPeriodStartsAt) |
## Example (as JSON)
diff --git a/doc/models/paypal-payment-profile.md b/doc/models/paypal-payment-profile.md
index cd73435a..f717e886 100644
--- a/doc/models/paypal-payment-profile.md
+++ b/doc/models/paypal-payment-profile.md
@@ -26,6 +26,8 @@
| `SiteGatewaySettingId` | `Integer` | Optional | - | Integer getSiteGatewaySettingId() | setSiteGatewaySettingId(Integer siteGatewaySettingId) |
| `GatewayHandle` | `String` | Optional | - | String getGatewayHandle() | setGatewayHandle(String gatewayHandle) |
| `PaypalEmail` | `String` | Optional | - | String getPaypalEmail() | setPaypalEmail(String paypalEmail) |
+| `CreatedAt` | `ZonedDateTime` | Optional | A timestamp indicating when this payment profile was created | ZonedDateTime getCreatedAt() | setCreatedAt(ZonedDateTime createdAt) |
+| `UpdatedAt` | `ZonedDateTime` | Optional | A timestamp indicating when this payment profile was last updated | ZonedDateTime getUpdatedAt() | setUpdatedAt(ZonedDateTime updatedAt) |
## Example (as JSON)
diff --git a/doc/models/prepaid-product-price-point-filter.md b/doc/models/prepaid-product-price-point-filter.md
index 2e7684e0..186c0378 100644
--- a/doc/models/prepaid-product-price-point-filter.md
+++ b/doc/models/prepaid-product-price-point-filter.md
@@ -9,7 +9,7 @@
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
-| `ProductPricePointId` | `String` | Required, Constant | Passed as a parameter to list methods to return only non null values.
**Value**: `"not_null"` | String getProductPricePointId() | setProductPricePointId(String productPricePointId) |
+| `ProductPricePointId` | `String` | Required, Constant | Passed as a parameter to list methods to return only non null values.
**Value**: `"not_null"` | String getProductPricePointId() | setProductPricePointId(String productPricePointId) |
## Example (as JSON)
diff --git a/doc/models/prepaid-usage-component.md b/doc/models/prepaid-usage-component.md
index 68c890ea..410c6255 100644
--- a/doc/models/prepaid-usage-component.md
+++ b/doc/models/prepaid-usage-component.md
@@ -12,7 +12,7 @@
| `Name` | `String` | Required | A name for this component that is suitable for showing customers and displaying on billing statements, ie. "Minutes". | String getName() | setName(String name) |
| `UnitName` | `String` | Required | The name of the unit of measurement for the component. It should be singular since it will be automatically pluralized when necessary. i.e. “message”, which may then be shown as “5 messages” on a subscription’s component line-item | String getUnitName() | setUnitName(String unitName) |
| `Description` | `String` | Optional | A description for the component that will be displayed to the user on the hosted signup page. | String getDescription() | setDescription(String description) |
-| `Handle` | `String` | Optional | A unique identifier for your use that can be used to retrieve this component is subsequent requests. Must start with a letter or number and may only contain lowercase letters, numbers, or the characters '.', ':', '-', or '_'.
**Constraints**: *Pattern*: `^[a-z0-9][a-z0-9\-_:.]*$` | String getHandle() | setHandle(String handle) |
+| `Handle` | `String` | Optional | A unique identifier for your use that can be used to retrieve this component is subsequent requests. Must start with a letter or number and may only contain lowercase letters, numbers, or the characters '.', ':', '-', or '_'.
**Constraints**: *Pattern*: `^[a-z0-9][a-z0-9\-_:.]*$` | String getHandle() | setHandle(String handle) |
| `Taxable` | `Boolean` | Optional | Boolean flag describing whether a component is taxable or not. | Boolean getTaxable() | setTaxable(Boolean taxable) |
| `PricingScheme` | [`PricingScheme`](../../doc/models/pricing-scheme.md) | Required | The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.html) for an overview of pricing schemes. | PricingScheme getPricingScheme() | setPricingScheme(PricingScheme pricingScheme) |
| `Prices` | [`List`](../../doc/models/price.md) | Optional | (Not required for ‘per_unit’ pricing schemes) One or more price brackets. See [Price Bracket Rules](https://maxio.zendesk.com/hc/en-us/articles/24261149166733-Component-Pricing-Schemes#price-bracket-rules) for an overview of how price brackets work for different pricing schemes. | List getPrices() | setPrices(List prices) |
diff --git a/doc/models/quantity-based-component.md b/doc/models/quantity-based-component.md
index a6954e1e..dc6de8c4 100644
--- a/doc/models/quantity-based-component.md
+++ b/doc/models/quantity-based-component.md
@@ -12,7 +12,7 @@
| `Name` | `String` | Required | A name for this component that is suitable for showing customers and displaying on billing statements, ie. "Minutes". | String getName() | setName(String name) |
| `UnitName` | `String` | Required | The name of the unit of measurement for the component. It should be singular since it will be automatically pluralized when necessary. i.e. “message”, which may then be shown as “5 messages” on a subscription’s component line-item | String getUnitName() | setUnitName(String unitName) |
| `Description` | `String` | Optional | A description for the component that will be displayed to the user on the hosted signup page. | String getDescription() | setDescription(String description) |
-| `Handle` | `String` | Optional | A unique identifier for your use that can be used to retrieve this component is subsequent requests. Must start with a letter or number and may only contain lowercase letters, numbers, or the characters '.', ':', '-', or '_'.
**Constraints**: *Pattern*: `^[a-z0-9][a-z0-9\-_:.]*$` | String getHandle() | setHandle(String handle) |
+| `Handle` | `String` | Optional | A unique identifier for your use that can be used to retrieve this component is subsequent requests. Must start with a letter or number and may only contain lowercase letters, numbers, or the characters '.', ':', '-', or '_'.
**Constraints**: *Pattern*: `^[a-z0-9][a-z0-9\-_:.]*$` | String getHandle() | setHandle(String handle) |
| `Taxable` | `Boolean` | Optional | Boolean flag describing whether a component is taxable or not. | Boolean getTaxable() | setTaxable(Boolean taxable) |
| `PricingScheme` | [`PricingScheme`](../../doc/models/pricing-scheme.md) | Required | The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.html) for an overview of pricing schemes. | PricingScheme getPricingScheme() | setPricingScheme(PricingScheme pricingScheme) |
| `Prices` | [`List`](../../doc/models/price.md) | Optional | (Not required for ‘per_unit’ pricing schemes) One or more price brackets. See [Price Bracket Rules](https://maxio.zendesk.com/hc/en-us/articles/24261149166733-Component-Pricing-Schemes#price-bracket-rules) for an overview of how price brackets work for different pricing schemes. | List getPrices() | setPrices(List prices) |
diff --git a/doc/models/reactivation-billing.md b/doc/models/reactivation-billing.md
index 4ca06b09..e5855c4c 100644
--- a/doc/models/reactivation-billing.md
+++ b/doc/models/reactivation-billing.md
@@ -11,7 +11,7 @@ These values are only applicable to subscriptions using calendar billing
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
-| `ReactivationCharge` | [`ReactivationCharge`](../../doc/models/reactivation-charge.md) | Optional | You may choose how to handle the reactivation charge for that subscription: 1) `prorated` A prorated charge for the product price will be attempted for to complete the period 2) `immediate` A full-price charge for the product price will be attempted immediately 3) `delayed` A full-price charge for the product price will be attempted at the next renewal
**Default**: `ReactivationCharge.PRORATED` | ReactivationCharge getReactivationCharge() | setReactivationCharge(ReactivationCharge reactivationCharge) |
+| `ReactivationCharge` | [`ReactivationCharge`](../../doc/models/reactivation-charge.md) | Optional | You may choose how to handle the reactivation charge for that subscription: 1) `prorated` A prorated charge for the product price will be attempted for to complete the period 2) `immediate` A full-price charge for the product price will be attempted immediately 3) `delayed` A full-price charge for the product price will be attempted at the next renewal
**Default**: `ReactivationCharge.PRORATED` | ReactivationCharge getReactivationCharge() | setReactivationCharge(ReactivationCharge reactivationCharge) |
## Example (as JSON)
diff --git a/doc/models/service-credit-1.md b/doc/models/service-credit-1.md
new file mode 100644
index 00000000..b641f2a9
--- /dev/null
+++ b/doc/models/service-credit-1.md
@@ -0,0 +1,32 @@
+
+# Service Credit 1
+
+## Structure
+
+`ServiceCredit1`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter | Setter |
+| --- | --- | --- | --- | --- | --- |
+| `Id` | `Integer` | Optional | - | Integer getId() | setId(Integer id) |
+| `AmountInCents` | `Long` | Optional | The amount in cents of the entry | Long getAmountInCents() | setAmountInCents(Long amountInCents) |
+| `EndingBalanceInCents` | `Long` | Optional | The new balance for the credit account | Long getEndingBalanceInCents() | setEndingBalanceInCents(Long endingBalanceInCents) |
+| `EntryType` | [`ServiceCreditType`](../../doc/models/service-credit-type.md) | Optional | The type of entry | ServiceCreditType getEntryType() | setEntryType(ServiceCreditType entryType) |
+| `Memo` | `String` | Optional | The memo attached to the entry | String getMemo() | setMemo(String memo) |
+| `InvoiceUid` | `String` | Optional | The invoice uid associated with the entry. Only present for debit entries | String getInvoiceUid() | setInvoiceUid(String invoiceUid) |
+| `RemainingBalanceInCents` | `Long` | Optional | The remaining balance for the entry | Long getRemainingBalanceInCents() | setRemainingBalanceInCents(Long remainingBalanceInCents) |
+| `CreatedAt` | `ZonedDateTime` | Optional | The date and time the entry was created | ZonedDateTime getCreatedAt() | setCreatedAt(ZonedDateTime createdAt) |
+
+## Example (as JSON)
+
+```json
+{
+ "id": 174,
+ "amount_in_cents": 4,
+ "ending_balance_in_cents": 44,
+ "entry_type": "Credit",
+ "memo": "memo8"
+}
+```
+
diff --git a/doc/models/subscription-filter.md b/doc/models/subscription-filter.md
index a0f57a3d..82621dd3 100644
--- a/doc/models/subscription-filter.md
+++ b/doc/models/subscription-filter.md
@@ -11,7 +11,7 @@ Nested filter used for List Subscription Components For Site Filter
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
-| `States` | [`List`](../../doc/models/subscription-state-filter.md) | Optional | Allows fetching components allocations that belong to the subscription with matching states based on provided values. To use this filter you also have to include the following param in the request `include=subscription`. Use in query `filter[subscription][states]=active,canceled&include=subscription`.
**Constraints**: *Minimum Items*: `1` | List getStates() | setStates(List states) |
+| `States` | [`List`](../../doc/models/subscription-state-filter.md) | Optional | Allows fetching components allocations that belong to the subscription with matching states based on provided values. To use this filter you also have to include the following param in the request `include=subscription`. Use in query `filter[subscription][states]=active,canceled&include=subscription`.
**Constraints**: *Minimum Items*: `1` | List getStates() | setStates(List states) |
| `DateField` | [`SubscriptionListDateField`](../../doc/models/subscription-list-date-field.md) | Optional | The type of filter you'd like to apply to your search. To use this filter you also have to include the following param in the request `include=subscription`. | SubscriptionListDateField getDateField() | setDateField(SubscriptionListDateField dateField) |
| `StartDate` | `LocalDate` | Optional | The start date (format YYYY-MM-DD) with which to filter the date_field. Returns components that belong to the subscription with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified. To use this filter you also have to include the following param in the request `include=subscription`. | LocalDate getStartDate() | setStartDate(LocalDate startDate) |
| `EndDate` | `LocalDate` | Optional | The end date (format YYYY-MM-DD) with which to filter the date_field. Returns components that belong to the subscription with a timestamp up to and including 11:59:59PM in your site’s time zone on the date specified. To use this filter you also have to include the following param in the request `include=subscription`. | LocalDate getEndDate() | setEndDate(LocalDate endDate) |
diff --git a/doc/models/subscription-group-credit-card.md b/doc/models/subscription-group-credit-card.md
index 49877099..5d78cb6e 100644
--- a/doc/models/subscription-group-credit-card.md
+++ b/doc/models/subscription-group-credit-card.md
@@ -9,9 +9,6 @@
| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
-| `FullNumber` | [`SubscriptionGroupCreditCardFullNumber`](../../doc/models/containers/subscription-group-credit-card-full-number.md) | Optional | This is a container for one-of cases. | SubscriptionGroupCreditCardFullNumber getFullNumber() | setFullNumber(SubscriptionGroupCreditCardFullNumber fullNumber) |
-| `ExpirationMonth` | [`SubscriptionGroupCreditCardExpirationMonth`](../../doc/models/containers/subscription-group-credit-card-expiration-month.md) | Optional | This is a container for one-of cases. | SubscriptionGroupCreditCardExpirationMonth getExpirationMonth() | setExpirationMonth(SubscriptionGroupCreditCardExpirationMonth expirationMonth) |
-| `ExpirationYear` | [`SubscriptionGroupCreditCardExpirationYear`](../../doc/models/containers/subscription-group-credit-card-expiration-year.md) | Optional | This is a container for one-of cases. | SubscriptionGroupCreditCardExpirationYear getExpirationYear() | setExpirationYear(SubscriptionGroupCreditCardExpirationYear expirationYear) |
| `ChargifyToken` | `String` | Optional | - | String getChargifyToken() | setChargifyToken(String chargifyToken) |
| `VaultToken` | `String` | Optional | - | String getVaultToken() | setVaultToken(String vaultToken) |
| `CurrentVault` | [`CreditCardVault`](../../doc/models/credit-card-vault.md) | Optional | The vault that stores the payment profile with the provided `vault_token`. Use `bogus` for testing. | CreditCardVault getCurrentVault() | setCurrentVault(CreditCardVault currentVault) |
@@ -24,6 +21,9 @@
| `BillingState` | `String` | Optional | - | String getBillingState() | setBillingState(String billingState) |
| `BillingZip` | `String` | Optional | - | String getBillingZip() | setBillingZip(String billingZip) |
| `BillingCountry` | `String` | Optional | - | String getBillingCountry() | setBillingCountry(String billingCountry) |
+| `FullNumber` | [`SubscriptionGroupCreditCardFullNumber`](../../doc/models/containers/subscription-group-credit-card-full-number.md) | Optional | This is a container for one-of cases. | SubscriptionGroupCreditCardFullNumber getFullNumber() | setFullNumber(SubscriptionGroupCreditCardFullNumber fullNumber) |
+| `ExpirationMonth` | [`SubscriptionGroupCreditCardExpirationMonth`](../../doc/models/containers/subscription-group-credit-card-expiration-month.md) | Optional | This is a container for one-of cases. | SubscriptionGroupCreditCardExpirationMonth getExpirationMonth() | setExpirationMonth(SubscriptionGroupCreditCardExpirationMonth expirationMonth) |
+| `ExpirationYear` | [`SubscriptionGroupCreditCardExpirationYear`](../../doc/models/containers/subscription-group-credit-card-expiration-year.md) | Optional | This is a container for one-of cases. | SubscriptionGroupCreditCardExpirationYear getExpirationYear() | setExpirationYear(SubscriptionGroupCreditCardExpirationYear expirationYear) |
| `LastFour` | `String` | Optional | - | String getLastFour() | setLastFour(String lastFour) |
| `CardType` | [`CardType`](../../doc/models/card-type.md) | Optional | The type of card used. | CardType getCardType() | setCardType(CardType cardType) |
| `CustomerVaultToken` | `String` | Optional | - | String getCustomerVaultToken() | setCustomerVaultToken(String customerVaultToken) |
@@ -34,11 +34,12 @@
```json
{
- "full_number": 4111111111111111,
"chargify_token": "tok_592nf92ng0sjd4300p",
- "expiration_month": "String1",
- "expiration_year": "String5",
- "vault_token": "vault_token6"
+ "full_number": 4111111111111111,
+ "vault_token": "vault_token6",
+ "current_vault": "braintree_blue",
+ "gateway_handle": "gateway_handle6",
+ "first_name": "first_name4"
}
```
diff --git a/doc/models/subscription-migration-preview-options.md b/doc/models/subscription-migration-preview-options.md
index cc1d8ccd..49ca32d6 100644
--- a/doc/models/subscription-migration-preview-options.md
+++ b/doc/models/subscription-migration-preview-options.md
@@ -11,10 +11,10 @@
| --- | --- | --- | --- | --- | --- |
| `ProductId` | `Integer` | Optional | The ID of the target Product. Either a product_id or product_handle must be present. A Subscription can be migrated to another product for both the current Product Family and another Product Family. Note: Going to another Product Family, components will not be migrated as well. | Integer getProductId() | setProductId(Integer productId) |
| `ProductPricePointId` | `Integer` | Optional | The ID of the specified product's price point. This can be passed to migrate to a non-default price point. | Integer getProductPricePointId() | setProductPricePointId(Integer productPricePointId) |
-| `IncludeTrial` | `Boolean` | Optional | Whether to include the trial period configured for the product price point when starting a new billing period. Note that if preserve_period is set, then include_trial will be ignored.
**Default**: `false` | Boolean getIncludeTrial() | setIncludeTrial(Boolean includeTrial) |
-| `IncludeInitialCharge` | `Boolean` | Optional | If `true` is sent initial charges will be assessed.
**Default**: `false` | Boolean getIncludeInitialCharge() | setIncludeInitialCharge(Boolean includeInitialCharge) |
-| `IncludeCoupons` | `Boolean` | Optional | If `true` is sent, any coupons associated with the subscription will be applied to the migration. If `false` is sent, coupons will not be applied. Note: When migrating to a new product family, the coupon cannot migrate.
**Default**: `true` | Boolean getIncludeCoupons() | setIncludeCoupons(Boolean includeCoupons) |
-| `PreservePeriod` | `Boolean` | Optional | If `false` is sent, the subscription's billing period will be reset to today and the full price of the new product will be charged. If `true` is sent, the billing period will not change and a prorated charge will be issued for the new product.
**Default**: `false` | Boolean getPreservePeriod() | setPreservePeriod(Boolean preservePeriod) |
+| `IncludeTrial` | `Boolean` | Optional | Whether to include the trial period configured for the product price point when starting a new billing period. Note that if preserve_period is set, then include_trial will be ignored.
**Default**: `false` | Boolean getIncludeTrial() | setIncludeTrial(Boolean includeTrial) |
+| `IncludeInitialCharge` | `Boolean` | Optional | If `true` is sent initial charges will be assessed.
**Default**: `false` | Boolean getIncludeInitialCharge() | setIncludeInitialCharge(Boolean includeInitialCharge) |
+| `IncludeCoupons` | `Boolean` | Optional | If `true` is sent, any coupons associated with the subscription will be applied to the migration. If `false` is sent, coupons will not be applied. Note: When migrating to a new product family, the coupon cannot migrate.
**Default**: `true` | Boolean getIncludeCoupons() | setIncludeCoupons(Boolean includeCoupons) |
+| `PreservePeriod` | `Boolean` | Optional | If `false` is sent, the subscription's billing period will be reset to today and the full price of the new product will be charged. If `true` is sent, the billing period will not change and a prorated charge will be issued for the new product.
**Default**: `false` | Boolean getPreservePeriod() | setPreservePeriod(Boolean preservePeriod) |
| `ProductHandle` | `String` | Optional | The handle of the target Product. Either a product_id or product_handle must be present. A Subscription can be migrated to another product for both the current Product Family and another Product Family. Note: Going to another Product Family, components will not be migrated as well. | String getProductHandle() | setProductHandle(String productHandle) |
| `ProductPricePointHandle` | `String` | Optional | The ID or handle of the specified product's price point. This can be passed to migrate to a non-default price point. | String getProductPricePointHandle() | setProductPricePointHandle(String productPricePointHandle) |
| `Proration` | [`Proration`](../../doc/models/proration.md) | Optional | - | Proration getProration() | setProration(Proration proration) |
diff --git a/doc/models/subscription-product-migration.md b/doc/models/subscription-product-migration.md
index d13ba920..ef926c39 100644
--- a/doc/models/subscription-product-migration.md
+++ b/doc/models/subscription-product-migration.md
@@ -11,10 +11,10 @@
| --- | --- | --- | --- | --- | --- |
| `ProductId` | `Integer` | Optional | The ID of the target Product. Either a product_id or product_handle must be present. A Subscription can be migrated to another product for both the current Product Family and another Product Family. Note: Going to another Product Family, components will not be migrated as well. | Integer getProductId() | setProductId(Integer productId) |
| `ProductPricePointId` | `Integer` | Optional | The ID of the specified product's price point. This can be passed to migrate to a non-default price point. | Integer getProductPricePointId() | setProductPricePointId(Integer productPricePointId) |
-| `IncludeTrial` | `Boolean` | Optional | Whether to include the trial period configured for the product price point when starting a new billing period. Note that if preserve_period is set, then include_trial will be ignored.
**Default**: `false` | Boolean getIncludeTrial() | setIncludeTrial(Boolean includeTrial) |
-| `IncludeInitialCharge` | `Boolean` | Optional | If `true` is sent initial charges will be assessed.
**Default**: `false` | Boolean getIncludeInitialCharge() | setIncludeInitialCharge(Boolean includeInitialCharge) |
-| `IncludeCoupons` | `Boolean` | Optional | If `true` is sent, any coupons associated with the subscription will be applied to the migration. If `false` is sent, coupons will not be applied. Note: When migrating to a new product family, the coupon cannot migrate.
**Default**: `true` | Boolean getIncludeCoupons() | setIncludeCoupons(Boolean includeCoupons) |
-| `PreservePeriod` | `Boolean` | Optional | If `false` is sent, the subscription's billing period will be reset to today and the full price of the new product will be charged. If `true` is sent, the billing period will not change and a prorated charge will be issued for the new product.
**Default**: `false` | Boolean getPreservePeriod() | setPreservePeriod(Boolean preservePeriod) |
+| `IncludeTrial` | `Boolean` | Optional | Whether to include the trial period configured for the product price point when starting a new billing period. Note that if preserve_period is set, then include_trial will be ignored.
**Default**: `false` | Boolean getIncludeTrial() | setIncludeTrial(Boolean includeTrial) |
+| `IncludeInitialCharge` | `Boolean` | Optional | If `true` is sent initial charges will be assessed.
**Default**: `false` | Boolean getIncludeInitialCharge() | setIncludeInitialCharge(Boolean includeInitialCharge) |
+| `IncludeCoupons` | `Boolean` | Optional | If `true` is sent, any coupons associated with the subscription will be applied to the migration. If `false` is sent, coupons will not be applied. Note: When migrating to a new product family, the coupon cannot migrate.
**Default**: `true` | Boolean getIncludeCoupons() | setIncludeCoupons(Boolean includeCoupons) |
+| `PreservePeriod` | `Boolean` | Optional | If `false` is sent, the subscription's billing period will be reset to today and the full price of the new product will be charged. If `true` is sent, the billing period will not change and a prorated charge will be issued for the new product.
**Default**: `false` | Boolean getPreservePeriod() | setPreservePeriod(Boolean preservePeriod) |
| `ProductHandle` | `String` | Optional | The handle of the target Product. Either a product_id or product_handle must be present. A Subscription can be migrated to another product for both the current Product Family and another Product Family. Note: Going to another Product Family, components will not be migrated as well. | String getProductHandle() | setProductHandle(String productHandle) |
| `ProductPricePointHandle` | `String` | Optional | The ID or handle of the specified product's price point. This can be passed to migrate to a non-default price point. | String getProductPricePointHandle() | setProductPricePointHandle(String productPricePointHandle) |
| `Proration` | [`Proration`](../../doc/models/proration.md) | Optional | - | Proration getProration() | setProration(Proration proration) |
diff --git a/doc/models/tax-configuration.md b/doc/models/tax-configuration.md
index 3d2cb7c0..0d05ee96 100644
--- a/doc/models/tax-configuration.md
+++ b/doc/models/tax-configuration.md
@@ -11,7 +11,7 @@
| --- | --- | --- | --- | --- | --- |
| `Kind` | [`TaxConfigurationKind`](../../doc/models/tax-configuration-kind.md) | Optional | **Default**: `TaxConfigurationKind.CUSTOM` | TaxConfigurationKind getKind() | setKind(TaxConfigurationKind kind) |
| `DestinationAddress` | [`TaxDestinationAddress`](../../doc/models/tax-destination-address.md) | Optional | - | TaxDestinationAddress getDestinationAddress() | setDestinationAddress(TaxDestinationAddress destinationAddress) |
-| `FullyConfigured` | `Boolean` | Optional | Returns `true` when Chargify has been properly configured to charge tax using the specified tax system. More details about taxes: https://maxio.zendesk.com/hc/en-us/articles/24287012608909-Taxes-Overview
**Default**: `false` | Boolean getFullyConfigured() | setFullyConfigured(Boolean fullyConfigured) |
+| `FullyConfigured` | `Boolean` | Optional | Returns `true` when Chargify has been properly configured to charge tax using the specified tax system. More details about taxes: https://maxio.zendesk.com/hc/en-us/articles/24287012608909-Taxes-Overview
**Default**: `false` | Boolean getFullyConfigured() | setFullyConfigured(Boolean fullyConfigured) |
## Example (as JSON)
diff --git a/doc/models/update-subscription-request.md b/doc/models/update-subscription-request.md
index 6eec1d6e..0af2f0f1 100644
--- a/doc/models/update-subscription-request.md
+++ b/doc/models/update-subscription-request.md
@@ -16,6 +16,7 @@
```json
{
"subscription": {
+ "defer_signup": false,
"dunning_communication_delay_time_zone": "\"Eastern Time (US & Canada)\"",
"credit_card_attributes": {
"full_number": "full_number2",
diff --git a/doc/models/update-subscription.md b/doc/models/update-subscription.md
index 56b16e36..0c8a0655 100644
--- a/doc/models/update-subscription.md
+++ b/doc/models/update-subscription.md
@@ -16,7 +16,10 @@
| `NextProductId` | `String` | Optional | Set to an empty string to cancel a delayed product change. | String getNextProductId() | setNextProductId(String nextProductId) |
| `NextProductPricePointId` | `String` | Optional | - | String getNextProductPricePointId() | setNextProductPricePointId(String nextProductPricePointId) |
| `SnapDay` | [`UpdateSubscriptionSnapDay`](../../doc/models/containers/update-subscription-snap-day.md) | Optional | This is a container for one-of cases. | UpdateSubscriptionSnapDay getSnapDay() | setSnapDay(UpdateSubscriptionSnapDay snapDay) |
+| `InitialBillingAt` | `ZonedDateTime` | Optional | (Optional) Set this attribute to a future date/time to update a subscription in the Awaiting Signup Date state, to Awaiting Signup. In the Awaiting Signup state, a subscription behaves like any other. It can be canceled, allocated to, or have its billing date changed. etc. When the `initial_billing_at` date hits, the subscription will transition to the expected state. If the product has a trial, the subscription will enter a trial, otherwise it will go active. Setup fees will be respected either before or after the trial, as configured on the price point. If the payment is due at the initial_billing_at and it fails the subscription will be immediately canceled. You can omit the initial_billing_at date to activate the subscription immediately. See the [subscription import](https://maxio.zendesk.com/hc/en-us/articles/24251489107213-Advanced-Billing-Subscription-Imports#date-format) documentation for more information about Date/Time formats. | ZonedDateTime getInitialBillingAt() | setInitialBillingAt(ZonedDateTime initialBillingAt) |
+| `DeferSignup` | `Boolean` | Optional | (Optional) Set this attribute to true to move the subscription from Awaiting Signup, to Awaiting Signup Date. Use this when you want to update a subscription that has an unknown initial billing date. When the first billing date is known, update a subscription to set the `initial_billing_at` date. The subscription moves to the awaiting signup with a scheduled initial billing date. You can omit the initial_billing_at date to activate the subscription immediately. See [Subscription States](https://maxio-chargify.zendesk.com/hc/en-us/articles/5404222005773-Subscription-States) for more information.
**Default**: `false` | Boolean getDeferSignup() | setDeferSignup(Boolean deferSignup) |
| `NextBillingAt` | `ZonedDateTime` | Optional | - | ZonedDateTime getNextBillingAt() | setNextBillingAt(ZonedDateTime nextBillingAt) |
+| `ExpiresAt` | `ZonedDateTime` | Optional | Timestamp giving the expiration date of this subscription (if any). You may manually change the expiration date at any point during a subscription period. | ZonedDateTime getExpiresAt() | setExpiresAt(ZonedDateTime expiresAt) |
| `PaymentCollectionMethod` | `String` | Optional | - | String getPaymentCollectionMethod() | setPaymentCollectionMethod(String paymentCollectionMethod) |
| `ReceivesInvoiceEmails` | `Boolean` | Optional | - | Boolean getReceivesInvoiceEmails() | setReceivesInvoiceEmails(Boolean receivesInvoiceEmails) |
| `NetTerms` | [`UpdateSubscriptionNetTerms`](../../doc/models/containers/update-subscription-net-terms.md) | Optional | This is a container for one-of cases. | UpdateSubscriptionNetTerms getNetTerms() | setNetTerms(UpdateSubscriptionNetTerms netTerms) |
@@ -33,6 +36,7 @@
```json
{
+ "defer_signup": false,
"dunning_communication_delay_time_zone": "\"Eastern Time (US & Canada)\"",
"credit_card_attributes": {
"full_number": "full_number2",
diff --git a/doc/utility-classes.md b/doc/utility-classes.md
deleted file mode 100644
index 7dfd29f5..00000000
--- a/doc/utility-classes.md
+++ /dev/null
@@ -1,63 +0,0 @@
-
-# Utility Classes Documentation
-
-## ApiHelper Class
-
-This is a Helper class with commonly used utilities for the SDK.
-
-### Fields
-
-| Name | Description | Type |
-| --- | --- | --- |
-| mapper | Deserialization of Json data. | `ObjectMapper` |
-
-### Methods
-
-| Name | Description | Return Type |
-| --- | --- | --- |
-| `serialize(Object obj)` | Json Serialization of a given object. | `String` |
-| `deserialize(String json)` | Json deserialization of the given Json string. | `LinkedHashMap` |
-| `deserialize(String json, Class clazz)` | Json deserialization of the given Json string. | ` T` |
-| `deserialize(String json, TypeReference typeReference)` | JSON Deserialization of the given json string. | ` T` |
-| `deserializeArray(String json, Class classArray)` | JSON Deserialization of the given json string. | ` List` |
-
-## FileWrapper Class
-
-Class to wrap file and contentType to be sent as part of a HTTP request.
-
-### Constructors
-
-| Name | Description |
-| --- | --- |
-| `FileWrapper(File file)` | Initialization constructor. |
-| `FileWrapper(File file, String contentType)` | Initialization constructor. |
-
-### Methods
-
-| Name | Description | Return Type |
-| --- | --- | --- |
-| `getFile()` | File instance. | `File` |
-| `getContentType()` | Content type of the file. | `String` |
-
-## ZonedDateTime Class
-
-This is a utility class for DateTime operations.
-
-### Methods
-
-| Name | Description | Return Type |
-| --- | --- | --- |
-| `fromUnixTimestamp(Long date)` | Parse a Unix Timestamp to a DateTime object. | `ZonedDateTime` |
-| `fromUnixTimestamp(String date)` | Parse a Unix Timestamp string to a DateTime object. | `ZonedDateTime` |
-| `toUnixTimestamp(ZonedDateTime value)` | Convert a DateTime object to a Unix Timestamp string. | `String` |
-| `toUnixTimestamp(List values)` | Convert a List of DateTime objects to Unix Timestamp strings. | `List` |
-| `fromRfc1123DateTime(String date)` | Parse a datetime string in Rfc1123 format to a DateTime object. | `ZonedDateTime` |
-| `toRfc1123DateTime(ZonedDateTime value)` | Convert a DateTime object to a Rfc1123 formatted string. | `String` |
-| `toRfc1123DateTime(List values)` | Convert a List of DateTime objects to Rfc1123 formatted strings. | `List` |
-| `fromRfc8601DateTime(String date)` | Parse a datetime string in Rfc8601(Rfc3339) format to a DateTime object. | `ZonedDateTime` |
-| `toRfc8601DateTime(ZonedDateTime value)` | Convert a DateTime object to a Rfc8601(Rfc3339) formatted string. | `String` |
-| `toRfc8601DateTime(List values)` | Convert a List of DateTime objects to Rfc8601(Rfc3339) formatted strings. | `List` |
-| `fromSimpleDate(String date)` | Parse a simple date string to a LocalDate object. | `LocalDate` |
-| `toSimpleDate(LocalDate value)` | Convert a LocalDate object to a string. | `String` |
-| `toSimpleDate(List values)` | Convert a List of LocalDate objects to strings. | `List` |
-
diff --git a/pom.xml b/pom.xml
index 92f6bf68..c2640442 100644
--- a/pom.xml
+++ b/pom.xml
@@ -8,7 +8,7 @@
4.0.0
com.maxio
advanced-billing-sdk
- 6.1.0
+ 7.0.0
jar
Advanced Billing SDK
Ultimate billing and pricing flexibility for B2B SaaS.
@@ -38,10 +38,6 @@ Maxio integrates directly into your product, so you can seamlessly manage your p
Repository Snapshot Server
https://s01.oss.sonatype.org/content/repositories/snapshots
-
- ossrh
- https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/
-
@@ -52,7 +48,7 @@ Maxio integrates directly into your product, so you can seamlessly manage your p
io.apimatic
core
- [0.6.7, 0.7)
+ [0.6.12, 0.7)
io.apimatic
@@ -167,14 +163,15 @@ Maxio integrates directly into your product, so you can seamlessly manage your p
- org.sonatype.plugins
- nexus-staging-maven-plugin
- 1.6.8
+ org.sonatype.central
+ central-publishing-maven-plugin
+ 0.8.0
true
- ossrh
- https://s01.oss.sonatype.org/
- true
+ ossrh
+ true
+ true
+ validated
diff --git a/src/main/java/com/maxio/advancedbilling/AdvancedBillingClient.java b/src/main/java/com/maxio/advancedbilling/AdvancedBillingClient.java
index 412d0aad..50a2ea08 100644
--- a/src/main/java/com/maxio/advancedbilling/AdvancedBillingClient.java
+++ b/src/main/java/com/maxio/advancedbilling/AdvancedBillingClient.java
@@ -99,7 +99,7 @@ public final class AdvancedBillingClient implements Configuration {
private static final CompatibilityFactory compatibilityFactory = new CompatibilityFactoryImpl();
- private static String userAgent = "AB SDK Java:6.1.0 on OS {os-info}";
+ private static String userAgent = "AB SDK Java:7.0.0 on OS {os-info}";
/**
* Current API environment.
diff --git a/src/main/java/com/maxio/advancedbilling/authentication/BasicAuthManager.java b/src/main/java/com/maxio/advancedbilling/authentication/BasicAuthManager.java
index 321a28e7..a0331494 100644
--- a/src/main/java/com/maxio/advancedbilling/authentication/BasicAuthManager.java
+++ b/src/main/java/com/maxio/advancedbilling/authentication/BasicAuthManager.java
@@ -81,6 +81,6 @@ public String getErrorMessage() {
}
return "BasicAuth - " + errorMessage;
- }
+ }
}
diff --git a/src/main/java/com/maxio/advancedbilling/controllers/APIExportsController.java b/src/main/java/com/maxio/advancedbilling/controllers/APIExportsController.java
index 5a40453f..2c1a40d0 100644
--- a/src/main/java/com/maxio/advancedbilling/controllers/APIExportsController.java
+++ b/src/main/java/com/maxio/advancedbilling/controllers/APIExportsController.java
@@ -56,7 +56,7 @@ public List listExportedProformaInvoices(
* Builds the ApiCall object for listExportedProformaInvoices.
*/
private ApiCall, ApiException> prepareListExportedProformaInvoicesRequest(
- final ListExportedProformaInvoicesInput input) throws IOException {
+ final ListExportedProformaInvoicesInput input) {
return new ApiCall.Builder, ApiException>()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -103,7 +103,7 @@ public List listExportedInvoices(
* Builds the ApiCall object for listExportedInvoices.
*/
private ApiCall, ApiException> prepareListExportedInvoicesRequest(
- final ListExportedInvoicesInput input) throws IOException {
+ final ListExportedInvoicesInput input) {
return new ApiCall.Builder, ApiException>()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -150,7 +150,7 @@ public List listExportedSubscriptions(
* Builds the ApiCall object for listExportedSubscriptions.
*/
private ApiCall, ApiException> prepareListExportedSubscriptionsRequest(
- final ListExportedSubscriptionsInput input) throws IOException {
+ final ListExportedSubscriptionsInput input) {
return new ApiCall.Builder, ApiException>()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -193,7 +193,7 @@ public BatchJobResponse exportProformaInvoices() throws ApiException, IOExceptio
/**
* Builds the ApiCall object for exportProformaInvoices.
*/
- private ApiCall prepareExportProformaInvoicesRequest() throws IOException {
+ private ApiCall prepareExportProformaInvoicesRequest() {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -231,7 +231,7 @@ public BatchJobResponse exportInvoices() throws ApiException, IOException {
/**
* Builds the ApiCall object for exportInvoices.
*/
- private ApiCall prepareExportInvoicesRequest() throws IOException {
+ private ApiCall prepareExportInvoicesRequest() {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -269,7 +269,7 @@ public BatchJobResponse exportSubscriptions() throws ApiException, IOException {
/**
* Builds the ApiCall object for exportSubscriptions.
*/
- private ApiCall prepareExportSubscriptionsRequest() throws IOException {
+ private ApiCall prepareExportSubscriptionsRequest() {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -307,7 +307,7 @@ public BatchJobResponse readProformaInvoicesExport(
* Builds the ApiCall object for readProformaInvoicesExport.
*/
private ApiCall prepareReadProformaInvoicesExportRequest(
- final String batchId) throws IOException {
+ final String batchId) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -347,7 +347,7 @@ public BatchJobResponse readInvoicesExport(
* Builds the ApiCall object for readInvoicesExport.
*/
private ApiCall prepareReadInvoicesExportRequest(
- final String batchId) throws IOException {
+ final String batchId) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -387,7 +387,7 @@ public BatchJobResponse readSubscriptionsExport(
* Builds the ApiCall object for readSubscriptionsExport.
*/
private ApiCall prepareReadSubscriptionsExportRequest(
- final String batchId) throws IOException {
+ final String batchId) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
diff --git a/src/main/java/com/maxio/advancedbilling/controllers/AdvanceInvoiceController.java b/src/main/java/com/maxio/advancedbilling/controllers/AdvanceInvoiceController.java
index 2158eb6a..dbc60c72 100644
--- a/src/main/java/com/maxio/advancedbilling/controllers/AdvanceInvoiceController.java
+++ b/src/main/java/com/maxio/advancedbilling/controllers/AdvanceInvoiceController.java
@@ -6,7 +6,6 @@
package com.maxio.advancedbilling.controllers;
-import com.fasterxml.jackson.core.JsonProcessingException;
import com.maxio.advancedbilling.ApiHelper;
import com.maxio.advancedbilling.Server;
import com.maxio.advancedbilling.exceptions.ApiException;
@@ -47,7 +46,7 @@ public AdvanceInvoiceController(GlobalConfiguration globalConfig) {
* endpoints for proforma invoices to preview this advance invoice before using this endpoint to
* generate it.
* @param subscriptionId Required parameter: The Chargify id of the subscription
- * @param body Optional parameter: Example:
+ * @param body Optional parameter:
* @return Returns the Invoice response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
@@ -63,7 +62,7 @@ public Invoice issueAdvanceInvoice(
*/
private ApiCall prepareIssueAdvanceInvoiceRequest(
final int subscriptionId,
- final IssueAdvanceInvoiceRequest body) throws JsonProcessingException, IOException {
+ final IssueAdvanceInvoiceRequest body) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -112,7 +111,7 @@ public Invoice readAdvanceInvoice(
* Builds the ApiCall object for readAdvanceInvoice.
*/
private ApiCall prepareReadAdvanceInvoiceRequest(
- final int subscriptionId) throws IOException {
+ final int subscriptionId) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -143,7 +142,7 @@ private ApiCall prepareReadAdvanceInvoiceRequest(
* returned to the subscription. For a full overview of the impact of voiding, please [see our
* help docs]($m/Invoice).
* @param subscriptionId Required parameter: The Chargify id of the subscription
- * @param body Optional parameter: Example:
+ * @param body Optional parameter:
* @return Returns the Invoice response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
@@ -159,7 +158,7 @@ public Invoice voidAdvanceInvoice(
*/
private ApiCall prepareVoidAdvanceInvoiceRequest(
final int subscriptionId,
- final VoidInvoiceRequest body) throws JsonProcessingException, IOException {
+ final VoidInvoiceRequest body) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
diff --git a/src/main/java/com/maxio/advancedbilling/controllers/BillingPortalController.java b/src/main/java/com/maxio/advancedbilling/controllers/BillingPortalController.java
index 17c3afa7..4dc5dcf3 100644
--- a/src/main/java/com/maxio/advancedbilling/controllers/BillingPortalController.java
+++ b/src/main/java/com/maxio/advancedbilling/controllers/BillingPortalController.java
@@ -73,7 +73,7 @@ public CustomerResponse enableBillingPortalForCustomer(
*/
private ApiCall prepareEnableBillingPortalForCustomerRequest(
final int customerId,
- final AutoInvite autoInvite) throws IOException {
+ final AutoInvite autoInvite) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -122,7 +122,7 @@ public PortalManagementLink readBillingPortalLink(
* Builds the ApiCall object for readBillingPortalLink.
*/
private ApiCall prepareReadBillingPortalLinkRequest(
- final int customerId) throws IOException {
+ final int customerId) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -172,7 +172,7 @@ public ResentInvitation resendBillingPortalInvitation(
* Builds the ApiCall object for resendBillingPortalInvitation.
*/
private ApiCall prepareResendBillingPortalInvitationRequest(
- final int customerId) throws IOException {
+ final int customerId) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -217,7 +217,7 @@ public RevokedInvitation revokeBillingPortalAccess(
* Builds the ApiCall object for revokeBillingPortalAccess.
*/
private ApiCall prepareRevokeBillingPortalAccessRequest(
- final int customerId) throws IOException {
+ final int customerId) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
diff --git a/src/main/java/com/maxio/advancedbilling/controllers/ComponentPricePointsController.java b/src/main/java/com/maxio/advancedbilling/controllers/ComponentPricePointsController.java
index 6f89272a..60591044 100644
--- a/src/main/java/com/maxio/advancedbilling/controllers/ComponentPricePointsController.java
+++ b/src/main/java/com/maxio/advancedbilling/controllers/ComponentPricePointsController.java
@@ -6,7 +6,6 @@
package com.maxio.advancedbilling.controllers;
-import com.fasterxml.jackson.core.JsonProcessingException;
import com.maxio.advancedbilling.ApiHelper;
import com.maxio.advancedbilling.Server;
import com.maxio.advancedbilling.exceptions.ApiException;
@@ -77,7 +76,7 @@ public ComponentResponse promoteComponentPricePointToDefault(
*/
private ApiCall preparePromoteComponentPricePointToDefaultRequest(
final int componentId,
- final int pricePointId) throws IOException {
+ final int pricePointId) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -103,7 +102,7 @@ private ApiCall preparePromoteComponentPricePoi
/**
* This endpoint can be used to create a new price point for an existing component.
* @param componentId Required parameter: The Advanced Billing id of the component
- * @param body Optional parameter: Example:
+ * @param body Optional parameter:
* @return Returns the ComponentPricePointResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
@@ -119,7 +118,7 @@ public ComponentPricePointResponse createComponentPricePoint(
*/
private ApiCall prepareCreateComponentPricePointRequest(
final int componentId,
- final CreateComponentPricePointRequest body) throws JsonProcessingException, IOException {
+ final CreateComponentPricePointRequest body) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -169,7 +168,7 @@ public ComponentPricePointsResponse listComponentPricePoints(
* Builds the ApiCall object for listComponentPricePoints.
*/
private ApiCall prepareListComponentPricePointsRequest(
- final ListComponentPricePointsInput input) throws IOException {
+ final ListComponentPricePointsInput input) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -202,7 +201,7 @@ private ApiCall prepareListComponent
* Use this endpoint to create multiple component price points in one request.
* @param componentId Required parameter: The Advanced Billing id of the component for which
* you want to fetch price points.
- * @param body Optional parameter: Example:
+ * @param body Optional parameter:
* @return Returns the ComponentPricePointsResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
@@ -218,7 +217,7 @@ public ComponentPricePointsResponse bulkCreateComponentPricePoints(
*/
private ApiCall prepareBulkCreateComponentPricePointsRequest(
final String componentId,
- final CreateComponentPricePointsRequest body) throws JsonProcessingException, IOException {
+ final CreateComponentPricePointsRequest body) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -258,7 +257,7 @@ private ApiCall prepareBulkCreateCom
* @param pricePointId Required parameter: The id or handle of the price point. When using the
* handle, it must be prefixed with `handle:`. Example: `123` for an integer ID, or
* `handle:example-price_point-handle` for a string handle.
- * @param body Optional parameter: Example:
+ * @param body Optional parameter:
* @return Returns the ComponentPricePointResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
@@ -276,7 +275,7 @@ public ComponentPricePointResponse updateComponentPricePoint(
private ApiCall prepareUpdateComponentPricePointRequest(
final UpdateComponentPricePointComponentId componentId,
final UpdateComponentPricePointPricePointId pricePointId,
- final UpdateComponentPricePointRequest body) throws JsonProcessingException, IOException {
+ final UpdateComponentPricePointRequest body) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -334,7 +333,7 @@ public ComponentPricePointResponse readComponentPricePoint(
private ApiCall prepareReadComponentPricePointRequest(
final ReadComponentPricePointComponentId componentId,
final ReadComponentPricePointPricePointId pricePointId,
- final Boolean currencyPrices) throws IOException {
+ final Boolean currencyPrices) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -383,7 +382,7 @@ public ComponentPricePointResponse archiveComponentPricePoint(
*/
private ApiCall prepareArchiveComponentPricePointRequest(
final ArchiveComponentPricePointComponentId componentId,
- final ArchiveComponentPricePointPricePointId pricePointId) throws IOException {
+ final ArchiveComponentPricePointPricePointId pricePointId) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -429,7 +428,7 @@ public ComponentPricePointResponse unarchiveComponentPricePoint(
*/
private ApiCall prepareUnarchiveComponentPricePointRequest(
final int componentId,
- final int pricePointId) throws IOException {
+ final int pricePointId) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -459,7 +458,7 @@ private ApiCall prepareUnarchiveCompo
* there should be a matching price level created in the given currency. Note: Currency Prices
* are not able to be created for custom price points.
* @param pricePointId Required parameter: The Advanced Billing id of the price point
- * @param body Optional parameter: Example:
+ * @param body Optional parameter:
* @return Returns the ComponentCurrencyPricesResponse response from the API call
* @throws ApiException Represents error response from the server.
* @throws IOException Signals that an I/O exception of some sort has occurred.
@@ -475,7 +474,7 @@ public ComponentCurrencyPricesResponse createCurrencyPrices(
*/
private ApiCall prepareCreateCurrencyPricesRequest(
final int pricePointId,
- final CreateCurrencyPricesRequest body) throws JsonProcessingException, IOException {
+ final CreateCurrencyPricesRequest body) {
return new ApiCall.Builder()
.globalConfig(getGlobalConfiguration())
.requestBuilder(requestBuilder -> requestBuilder
@@ -508,7 +507,7 @@ private ApiCall