You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
### 📝 Changelog: API Documentation Updates
We've made several updates to the API documentation to improve clarity,
consistency, and accuracy. This release includes enhancements to the
descriptions for various endpoints, corrections to example data, and
updates to external links.
---
### 🌐 Webhooks API Improvements
* **Simplified descriptions:** We've streamlined the descriptions for
several webhook endpoints, including **List Webhooks**, **Enable
Webhooks**, **Replay Webhooks**, **Create Endpoint**, **Update
Endpoint**, and **List Endpoints**, to make them more concise and easier
to understand.
* **Updated documentation links:** All internal and external links
within the webhook documentation have been updated to point to the
correct, current resources.
---
### 💰 Billing and Subscription Updates
* **Enhanced Customer API:** The **Read Customer** endpoint now includes
a complete example response, providing a clearer picture of the data
you'll receive from the API.
* **Component Price Point examples:** We've added new examples for
**Volume** and **Tiered** price points to the **Create Component Price
Point** endpoint, providing clearer guidance for different pricing
schemes. The **Stairstep Price Point** example was also corrected to
include a valid `ending_quantity`.
* **Flexible Subscription Usage:** The `subscription_id` path parameter
for the **Create Usage** endpoint has been updated to
`subscription_id_or_reference`. This allows you to use either the
subscription's ID or its reference string, making the endpoint more
flexible.
* **Updated documentation links:** The links in the documentation for
**GoCardless**, **Stripe SEPA/BECS Direct Debit**, and **Chargify.js**
have been corrected to ensure they point to the latest and most relevant
documentation.
---
### 🧰 General Enhancements
* **Concise descriptions:** We've shortened descriptions for the **Read
Customer** and **Read Component** endpoints to be more direct.
* **Improved link consistency:** All external links, especially those
referencing **Chargify.js** and various examples, have been reviewed and
updated to the correct, canonical URLs.
---------
Co-authored-by: maxio-sdk <maxio-sdk@maxio.com>
Run the following command from your project directory to install the package from npm:
30
30
31
31
```bash
32
-
npm install @maxio-com/advanced-billing-sdk@7.0.0
32
+
npm install @maxio-com/advanced-billing-sdk@7.0.1
33
33
```
34
34
35
-
For additional package details, see the [Npm page for the @maxio-com/advanced-billing-sdk@7.0.0 npm](https://www.npmjs.com/package/@maxio-com/advanced-billing-sdk/v/7.0.0).
35
+
For additional package details, see the [Npm page for the @maxio-com/advanced-billing-sdk@7.0.1 npm](https://www.npmjs.com/package/@maxio-com/advanced-billing-sdk/v/7.0.1).
36
36
37
37
## Initialize the API Client
38
38
39
-
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-typescript-sdk/tree/7.0.0/doc/client.md)
39
+
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-typescript-sdk/tree/7.0.1/doc/client.md)
40
40
41
41
The following parameters are configurable for the API Client:
42
42
@@ -45,9 +45,9 @@ The following parameters are configurable for the API Client:
45
45
| site |`string`| The subdomain for your Advanced Billing site.<br>*Default*: `'subdomain'`|
46
46
| environment |`Environment`| The API environment. <br> **Default: `Environment.US`**|
47
47
| timeout |`number`| Timeout for API calls.<br>*Default*: `120000`|
| basicAuthCredentials |[`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-typescript-sdk/tree/7.0.0/doc/auth/basic-authentication.md)| The credential object for basicAuth |
50
+
| basicAuthCredentials |[`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-typescript-sdk/tree/7.0.1/doc/auth/basic-authentication.md)| The credential object for basicAuth |
51
51
52
52
The API client can be initialized as follows:
53
53
@@ -80,56 +80,57 @@ The SDK can be configured to use a different environment for making API calls. A
80
80
81
81
This API uses the following authentication schemes.
*[Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-typescript-sdk/tree/7.0.0/doc/controllers/subscription-group-invoice-account.md)
103
-
*[Subscription Group Status](https://www.github.com/maxio-com/ab-typescript-sdk/tree/7.0.0/doc/controllers/subscription-group-status.md)
*[Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-typescript-sdk/tree/7.0.1/doc/controllers/subscription-group-invoice-account.md)
103
+
*[Subscription Group Status](https://www.github.com/maxio-com/ab-typescript-sdk/tree/7.0.1/doc/controllers/subscription-group-status.md)
Copy file name to clipboardExpand all lines: doc/controllers/payment-profiles.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -96,9 +96,9 @@ For more information on GoCardless, please view the following resources:
96
96
97
97
+[Full documentation on GoCardless](https://maxio.zendesk.com/hc/en-us/articles/24176159136909-GoCardless)
98
98
99
-
+[Using Chargify.js with GoCardless - minimal example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#minimal-example-with-direct-debit-gocardless-gateway)
99
+
+[Using Chargify.js with GoCardless - minimal example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#h_01K0PJ15QQZKCER8CFK40MR6XJ)
100
100
101
-
+[Using Chargify.js with GoCardless - full example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#full-example-with-direct-debit-gocardless-gateway)
101
+
+[Using Chargify.js with GoCardless - full example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#h_01K0PJ15QR09JVHWW0MCA7HVJV)
102
102
103
103
### GoCardless with Local Bank Details
104
104
@@ -170,9 +170,9 @@ For more information on Stripe SEPA Direct Debit, please view the following reso
170
170
171
171
+[Full documentation on Stripe SEPA Direct Debit](https://maxio.zendesk.com/hc/en-us/articles/24176170430093-Stripe-SEPA-and-BECS-Direct-Debit)
172
172
173
-
+[Using Chargify.js with Stripe Direct Debit - minimal example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#minimal-example-with-sepa-or-becs-direct-debit-stripe-gateway)
173
+
+[Using Chargify.js with Stripe Direct Debit - minimal example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#h_01K0PJ15QQFKKN8Z7B7DZ9AJS5)
174
174
175
-
+[Using Chargify.js with Stripe Direct Debit - full example](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDIy-examples#full-example-with-sepa-direct-debit-stripe-gateway)
175
+
+[Using Chargify.js with Stripe Direct Debit - full example](https://docs.maxio.com/hc/en-us/articles/38206331271693-Examples#h_01K0PJ15QRECQQ4ECS3ZA55GY7)
176
176
177
177
### Stripe SEPA Direct Debit Payment Profiles
178
178
@@ -1155,7 +1155,7 @@ One Time Tokens aka Advanced Billing Tokens house the credit card or ACH (Author
1155
1155
1156
1156
You can use One Time Tokens while creating a subscription or payment profile instead of passing all bank account or credit card data directly to a given API endpoint.
1157
1157
1158
-
To obtain a One Time Token you have to use [Chargify.js](https://developers.chargify.com/docs/developer-docs/ZG9jOjE0NjAzNDI0-overview).
1158
+
To obtain a One Time Token you have to use [Chargify.js](https://docs.maxio.com/hc/en-us/articles/38163190843789-Chargify-js-Overview#chargify-js-overview-0-0).
0 commit comments