AvantGuard - Pax8 - VendorUsage icon

AvantGuard - Pax8 - VendorUsage

AvantGuard - Pax8

Actions2

Overview

This node interacts with the AvantGuard Pax8 Vendor Usage API to retrieve detailed usage line data for a specified billing period and summary key. It is useful for scenarios where users need to analyze or report on subscription usage metrics, such as tracking consumption, auditing billing details, or integrating usage data into other systems.

A practical example would be fetching all usage lines for a particular month (e.g., "2024-05") and a specific summary key that identifies a grouping of usage records. This allows finance or operations teams to automate the extraction of usage data for reconciliation or further processing.

Properties

Name Meaning
Billing Period The billing period in the format yyyy-MM for which usage lines are requested.
Summary Key A key that summarizes or groups usage lines; used to filter the results accordingly.
Additional Query Parameters Optional parameters to refine the query:
- Subscription Id: Filter by internal subscription identifier.
- External Subscription Id: Filter by external subscription identifier.

Output

The node outputs JSON data representing the usage lines retrieved from the API. Each item in the output corresponds to a usage line record containing details such as usage metrics, associated subscriptions, and billing information.

If binary data were involved, it would typically represent files or attachments related to usage, but this node focuses solely on JSON usage data.

Dependencies

  • Requires an API key credential for authenticating with the AvantGuard Pax8 Vendor Usage API.
  • The node sends requests to the base URL: https://api.pax8.com/v2/usage.
  • Proper configuration of the API authentication token within n8n credentials is necessary.

Troubleshooting

  • Common Issues:

    • Incorrect or missing billing period format (yyyy-MM) may cause the API to reject the request.
    • Invalid or expired API credentials will result in authentication errors.
    • Providing invalid summary keys or subscription IDs might return empty results or errors.

  • Error Messages:

    • Authentication failures usually indicate issues with the API key; verify and update credentials.
    • Validation errors on query parameters suggest checking the format and presence of required fields.
    • Network or connectivity errors require ensuring that n8n can reach the API endpoint.

Links and References

  • Pax8 API Documentation (general reference for API usage)
  • AvantGuard Pax8 Vendor Usage API (specific documentation should be consulted if available)

Discussion