Actions28
- Companies Actions
- Products Actions
- Orders Actions
- Subscriptions Actions
- Contacts Actions
- Invoices Actions
- Usage Summaries Actions
Overview
This node operation "Find Usage Lines" under the "Usage Summaries" resource is designed to retrieve detailed usage line items associated with a specific usage summary. It allows users to query usage data recorded on a particular date and filter results optionally by product ID or other additional parameters.
Common scenarios for this node include:
- Extracting detailed usage records for billing or auditing purposes.
- Filtering usage lines by date and product to analyze consumption patterns.
- Integrating usage data into reporting workflows or dashboards.
For example, a user might want to find all usage lines recorded on January 1, 2020, for a given usage summary ID, optionally narrowing down to a specific product.
Properties
| Name | Meaning |
|---|---|
| Usage Summary Id | The unique identifier of the usage summary to retrieve usage lines from. |
| Usage Date | The date when the usage was recorded; used as a query parameter to filter usage lines by date. |
| Additional Query Parameters | Optional extra filters that can be added to the query, such as Product Id to narrow results. |
The "Additional Query Parameters" collection currently supports:
- Product Id: Filter usage lines to only those associated with this product identifier.
Output
The node outputs JSON data representing the usage lines found for the specified usage summary and date, optionally filtered by additional parameters. Each item in the output corresponds to a usage line record containing details such as usage metrics, product information, timestamps, and other relevant fields as defined by the external API.
No binary data output is indicated by the source code.
Dependencies
- Requires an API key credential for authenticating requests to the external Pax8 Partner API.
- The base URL for API requests is
https://api.pax8.com/v1. - The node uses standard HTTP headers accepting and sending JSON content.
Troubleshooting
- Missing or invalid Usage Summary Id: Ensure the provided usage summary ID is correct and exists in the system.
- Invalid Usage Date format: The usage date should be in a valid string format (e.g., "YYYY-MM-DD").
- API authentication errors: Verify that the API key credential is correctly configured and has necessary permissions.
- No results returned: Check if the combination of usage summary ID, usage date, and optional filters actually matches existing usage lines.
- Network or connectivity issues: Confirm network access to the API endpoint and no firewall restrictions.
Links and References
- Pax8 API Documentation (general reference for API endpoints and usage)
- n8n documentation on creating custom nodes