Actions28
- Companies Actions
- Products Actions
- Orders Actions
- Subscriptions Actions
- Contacts Actions
- Invoices Actions
- Usage Summaries Actions
Overview
This node operation, Find Subscription Usage Summaries, retrieves usage summary data for a specific subscription from an external API. It is useful for scenarios where users need to monitor or analyze the consumption and billing details associated with a particular subscription in a paginated and filtered manner.
Typical use cases include:
- Fetching detailed usage reports for a subscription to audit costs.
- Integrating subscription usage data into dashboards or reporting tools.
- Automating alerts or workflows based on usage thresholds or patterns.
For example, a user might want to get all usage summaries for a subscription to understand how resources are being consumed over time or to verify charges before invoicing.
Properties
| Name | Meaning |
|---|---|
| Subscription Id | The unique identifier of the subscription for which usage summaries are requested. |
| Additional Query Parameters | Optional filters and pagination controls: - Page: Page number of results (default 0). - Size: Number of usage summaries per page (default 10). - Sort: Field to sort by, options: Resource Group, Current Charges, Partner Total. - Resource Group: Filter usage summaries by this resource group name. - Company Id: Filter usage summaries by this company identifier. |
Output
The node outputs JSON data representing a list of usage summaries related to the specified subscription. Each item in the output typically contains fields such as resource group, current charges, partner totals, and other usage-related metrics.
If binary data were involved, it would represent downloadable reports or files, but this node focuses on JSON structured usage summary data.
Dependencies
- Requires an API key credential for authenticating requests to the external Pax8 Partner API.
- The node uses the base URL
https://api.pax8.com/v1to make HTTP requests. - Proper configuration of the API authentication token in n8n credentials is necessary.
Troubleshooting
- Invalid Subscription Id: If the subscription ID is incorrect or does not exist, the API may return an error or empty results. Verify the subscription ID value.
- Authentication Errors: Missing or invalid API credentials will cause authorization failures. Ensure the API key credential is correctly set up.
- Pagination Issues: Requesting pages beyond available data may return empty arrays. Adjust the page and size parameters accordingly.
- Sorting/Filtering Errors: Using unsupported sort fields or filter values may result in API errors. Use only the documented options.
Links and References
- Pax8 API Documentation (for detailed API usage and parameters)
- n8n documentation on HTTP Request Node for understanding API integrations