---
title: "Get Usage Balances"
method: GET
path: "/api/v1/customers/{externalId}/usage-balances"
tags: ["Customer", "Usage Meters"]
---

# Get Usage Balances

`GET /api/v1/customers/{externalId}/usage-balances`

## Path parameters

- `externalId` string, required — The external ID of the customer

## Query parameters

- `subscriptionId` string

## Response `200`

Successful response

- object
  - `usageMeterBalances` object[], required
    - `id` string, required
    - `createdAt` integer, required — Epoch milliseconds.
    - `updatedAt` integer, required — Epoch milliseconds.
    - `livemode` boolean, required
    - `organizationId` string, required
    - `name` string, required — The name of the usage meter
    - `pricingModelId` string, required
    - `slug` string, required — The slug of the usage meter
    - `aggregationType` 'sum' | 'count_distinct_properties', required — The type of aggregation to perform on the usage meter. Defaults to "sum", which aggregates all the usage event amounts for the billing period. "count_distinct_properties" counts the number of distinct properties in the billing period for a given meter.
    - `availableBalance` number, required
    - `subscriptionId` string, required

## Other responses

- `400` — Invalid input data
- `401` — Authorization not provided
- `403` — Insufficient access
- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.net/flowglad/apis/flowglad-api-2.md) · [All operations](https://skmtc.net/flowglad/apis/flowglad-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flowglad/flowglad-api-2/revisions/c838c92c3606/schema)