Pax8

Interact with the Pax8 Partner API

Actions100

Usage Summaries → List Usage Summaries

AI-generated

Summary

List usage summaries for a Pax8 subscription, with optional filtering, sorting, and pagination.

Inputs

  • subscriptionId (required) — Pax8 subscription identifier (path parameter).
  • returnAll — Automatically paginate to return all results. Default false.
  • maxResults — Maximum number of results to return. 0 means no limit. Default 0.
  • page — The page number to request in the usage summaries list. Default 0.
  • size — Returns this number of usage summaries per page. Default 0.
  • sort — Return usage summaries sorted by this field and direction, formatted as fieldName,direction (e.g., resourceGroup,desc). Default resourceGroup.
  • resourceGroup — Return only usage summaries matching this resourceGroup value.
  • companyId — Return only usage summaries with this companyId value.

Output shape

Array of usage summary objects from the API's content field. If no content is returned, the raw API response is returned instead.

The node uses paged list helpers; when returnAll is true, pagination occurs automatically. The sort parameter accepts fieldName,direction format as specified in the options.

Links

Discussion