AvantGuard - Pax8 - Partner icon

AvantGuard - Pax8 - Partner

AvantGuard - Pax8

Actions28

Overview

This node operation, Find Subscriptions, allows users to retrieve a list of subscriptions from the Pax8 API with flexible filtering and pagination options. It is useful in scenarios where you want to query subscription data for reporting, auditing, or integration purposes. For example, you might use it to fetch all active monthly subscriptions for a specific company or product, or to paginate through large sets of subscription records sorted by creation date.

Properties

Name Meaning
Additional Query Parameters Optional filters and controls for the subscription search:
- Page The page number to request in the subscriptions list (pagination).
- Size Number of subscriptions to return per page.
- Sort Field and direction to sort the results by. Options: Quantity, Start Date, End Date, Created Date, Billing Start, Price.
- Status Filter subscriptions by their status. Options include Active, Cancelled, Pending Manual, Pending Automated, Pending Cancel, Waiting For Details, Trial, Converted, Pending Activation, Activated.
- Billing Term Filter subscriptions by billing term. Options include Monthly, Annual, 2 Year, 3 Year, One Time, Trial, Activation.
- Company Id Filter subscriptions belonging to a specific company by its ID.
- Product Id Filter subscriptions related to a specific product by its ID.

Output

The output of this node operation is a JSON array containing subscription objects that match the specified query parameters. Each subscription object includes details such as subscription status, billing term, associated company and product IDs, dates, quantities, prices, and other relevant metadata as provided by the Pax8 API.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Pax8 API.
  • The node uses the base URL https://api.pax8.com/v1 and expects JSON responses.
  • Proper configuration of the API authentication credential within n8n is necessary.

Troubleshooting

  • Empty Results: If no subscriptions are returned, verify that the filter parameters (e.g., companyId, productId, status) are correct and correspond to existing data.
  • Invalid Parameter Errors: Ensure that numeric fields like page and size are valid numbers and that option fields like status and billingTerm use allowed values.
  • Authentication Failures: Confirm that the API key credential is correctly set up and has sufficient permissions.
  • API Rate Limits: If many requests are made rapidly, the API may throttle; implement delays or pagination accordingly.

Links and References

Discussion