---
title: "List Usage Summaries"
method: GET
path: "/subscriptions/{subscriptionId}/usage-summaries"
tags: ["Usage Summaries"]
---

# List Usage Summaries

`GET /subscriptions/{subscriptionId}/usage-summaries`

## Request

- Base URL: `https://api.pax8.com/v1`
- URL: `https://api.pax8.com/v1/subscriptions/{subscriptionId}/usage-summaries`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://token-manager.pax8.com/oauth/token`

Fetch a paginated list of usage summaries. Default page is 0 and default size is 10. The maximum page size is 200

## Path parameters

- `subscriptionId` string, uuid, required

## Query parameters

- `page` number
- `size` number
- `sort` 'resourceGroup,asc' | 'resourceGroup,desc'
- `resourceGroup` string
- `companyId` string, uuid

## Response `200`

Successful operation

- object
  - `content` UsageSummary[]
    - `id` string, uuid: The id
    - `companyId` string, uuid: The company id
    - `productId` string, uuid: The product id
    - `resourceGroup` string: Resource group assigned to the usage summary
    - `vendorName` string: Vendor Name
    - `currentCharges` number: Charges for the current month
    - `currencyCode` string: The currency ISO 4217 code
    - `partnerTotal` number: The partner total for the current month
    - `isTrial` boolean: Indicates whether the usage summary is for a trial
  - `page` Page
    - `size` number: The size of the page
    - `totalElements` unknown
    - `totalPages` unknown
    - `number` unknown

## Other responses

- `404`: Invalid subscriptionId or companyId

---

[API](https://skmtc.dev/pax8/apis/partner-endpoints.md) - [All operations](https://skmtc.dev/pax8/apis/partner-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/pax8/apis/partner-endpoints/revisions/f90cec5b4720?raw)
