AvantGuard - Pax8 - VendorUsage icon

AvantGuard - Pax8 - VendorUsage

AvantGuard - Pax8

Actions2

Overview

The node integrates with the AvantGuard Pax8 Vendor Usage API to save usage lines data for a specified billing period. It is designed to send usage information related to subscriptions within a given billing cycle, allowing users to report or update usage metrics programmatically.

Common scenarios include:

  • Automating the reporting of subscription usage data for billing reconciliation.
  • Integrating with internal systems to push usage metrics to the vendor's platform.
  • Managing subscription usage details in bulk for a specific billing period.

For example, a user might use this node to submit monthly usage data for all active subscriptions during the "2024-05" billing period, optionally filtering by subscription IDs or adding custom fields to the request body.

Properties

Name Meaning
Billing Period The billing period for which usage lines are being saved, formatted as yyyy-MM (e.g., "2024-05").
Additional Query Parameters Optional query parameters to refine the request:
- Subscription Id
- External Subscription Id
Additional Body Fields Optional additional JSON fields to include in the request body, allowing customization beyond defaults.

Output

The node outputs JSON data representing the response from the AvantGuard Pax8 Vendor Usage API after saving usage lines. This typically includes confirmation of the saved usage data or any error messages returned by the API.

If binary data were involved, it would be summarized here; however, this node deals exclusively with JSON payloads.

Dependencies

  • Requires an API key credential for authenticating with the AvantGuard Pax8 Vendor Usage API.
  • The base URL for API requests is https://api.pax8.com/v2/usage.
  • The node expects JSON content type and accepts JSON responses.
  • No other external dependencies are indicated.

Troubleshooting

  • Invalid Billing Period Format: Ensure the billing period follows the yyyy-MM format. Incorrect formats may cause API errors.
  • Missing Required Credentials: The node requires a valid API authentication token; missing or invalid credentials will result in authentication errors.
  • API Errors Due to Query Parameters: Providing invalid subscription IDs or external subscription IDs may cause the API to reject the request.
  • Malformed Additional Body Fields: If the JSON provided in additional body fields is not well-formed, the request will fail. Validate JSON syntax before submission.

Links and References

Discussion