AvantGuard - Pax8 - Partner icon

AvantGuard - Pax8 - Partner

AvantGuard - Pax8

Actions28

Overview

This node operation updates an existing subscription in a subscription management system. It allows users to modify key subscription details such as quantity, start date, billing term, status, pricing, and other optional fields. This is useful for scenarios where subscription parameters need adjustment after creation, such as changing the number of seats/licenses, updating billing cycles, or modifying subscription status.

Practical examples include:

  • Increasing the number of licenses for a customer’s subscription.
  • Changing the billing term from monthly to annual.
  • Updating the subscription status to "Cancelled" when a customer ends their service.
  • Adjusting pricing or currency information for a subscription.

Properties

Name Meaning
Subscription Id The unique identifier of the subscription to be updated.
Quantity The new quantity (e.g., number of licenses or units) for the subscription.
Start Date The start date of the subscription period.
Billing Term The billing cycle for the subscription. Options: Monthly, Annual, 2 Year, 3 Year, 1 Time, Trial, Activation.
Additional Body Fields Optional additional fields that can be included in the update request. These include:
- Id: Another identifier for the subscription.
- Parent Subscription Id: Identifier of a parent subscription if applicable.
- Company Id: Associated company identifier.
- Product Id: Identifier of the product subscribed to.
- End Date: Subscription end date.
- Created Date: Creation timestamp.
- Updated Date: Last update timestamp.
- Billing Start: When billing starts.
- Status: Subscription status with options:
* Active
* Cancelled
* Pending Manual
* Pending Automated
* Pending Cancel
* Waiting For Details
* Trial
* Converted
* Pending Activation
* Activated
- Price: Customer price.
- Currency Code: ISO 4217 currency code (e.g., USD).
- Partner Cost: Price for the partner.
- Provisioning Details: JSON array describing provisioning info (e.g., user email).
- Commitment Term: JSON object specifying commitment duration (e.g., {"term": "3-Year"}).

Output

The node outputs JSON data representing the updated subscription object returned by the API. This typically includes all subscription details reflecting the changes made, such as updated quantity, dates, status, pricing, and any other modified fields.

If the API supports binary data output (not indicated here), it would represent related files or attachments, but this node primarily deals with JSON subscription data.

Dependencies

  • Requires an API key credential for authenticating with the external subscription management API.
  • The base URL for API requests is https://api.pax8.com/v1.
  • The node sends JSON-formatted HTTP requests and expects JSON responses.
  • Proper configuration of the API authentication credentials within n8n is necessary.

Troubleshooting

  • Invalid Subscription Id: If the subscription ID does not exist or is malformed, the API will likely return an error indicating the subscription was not found. Verify the subscription ID before running the node.
  • Missing Required Fields: Quantity, Start Date, and Billing Term are required. Omitting these will cause validation errors.
  • Invalid Status Value: Ensure the status field uses one of the allowed options; otherwise, the API may reject the update.
  • Date Format Issues: Dates should be provided in a valid string format accepted by the API (usually ISO 8601). Incorrect formats may cause errors.
  • Authentication Errors: If the API key or credentials are invalid or missing, the node will fail to authenticate.
  • JSON Parsing Errors: For fields like Provisioning Details and Commitment Term, ensure valid JSON strings are provided; otherwise, parsing will fail.

Links and References

This summary is based on static analysis of the node's properties and bundled source code without runtime execution.

Discussion