---
title: "List Customer Meters"
method: GET
path: "/v1/customer-meters/"
tags: ["customer_meters", "public"]
---

# List Customer Meters

`GET /v1/customer-meters/`

List customer meters.

**Scopes**: `customer_meters:read`

## Query parameters

- `organization_id` union — Filter by organization ID.
  - string, uuid4 — The organization ID.
  - string[]
- `customer_id` union — Filter by customer ID.
  - string, uuid4 — The customer ID.
  - string[]
- `external_customer_id` union — Filter by external customer ID.
  - string
  - string[]
- `meter_id` union — Filter by meter ID.
  - string, uuid4 — The meter ID.
  - string[]
- `page` integer — Page number, defaults to 1.
- `limit` integer — Size of a page, defaults to 10. Maximum is 100.
- `sorting` CustomerMeterSortProperty[], nullable — Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.

## Response `200`

Successful Response

- ListResourceCustomerMeter
  - `items` CustomerMeter[], required
    - `id` string, uuid4, required — The ID of the object.
    - `created_at` string, date-time, required — Creation timestamp of the object.
    - `modified_at` string, date-time, nullable, required — Last modification timestamp of the object.
    - `customer_id` string, uuid4, required — The ID of the customer.
    - `meter_id` string, uuid4, required — The ID of the meter.
    - `consumed_units` number, required — The number of consumed units.
    - `credited_units` integer, required — The number of credited units.
    - `balance` number, required — The balance of the meter, i.e. the difference between credited and consumed units.
    - `customer` Customer, required — unresolved $ref
    - `meter` Meter, required
      - `metadata` MetadataOutputType, required
      - `created_at` string, date-time, required — Creation timestamp of the object.
      - `modified_at` string, date-time, nullable, required — Last modification timestamp of the object.
      - `id` string, uuid4, required — The ID of the object.
      - `name` string, required — The name of the meter. Will be shown on customer's invoices and usage.
      - `unit` 'scalar' | 'token' | 'custom', required
      - `custom_label` string, nullable — The label for the custom unit.
      - `custom_multiplier` integer, nullable — The multiplier to convert from base unit to display scale.
      - `filter` Filter, required
        - `conjunction` 'and' | 'or', required
        - `clauses` union[], required
          - union
            - FilterClause
              - …
            - Filter — recursive
      - `aggregation` union, required — The aggregation to apply on the filtered events to calculate the meter.
        - CountAggregation
          - `func` 'count'
        - PropertyAggregation
          - `func` 'sum' | 'max' | 'min' | 'avg', required
          - `property` string, required
        - UniqueAggregation
          - `func` 'unique'
          - `property` string, required
      - `organization_id` string, uuid4, required — The ID of the organization owning the meter.
      - `archived_at` string, date-time, nullable — Whether the meter is archived and the time it was archived.
  - `pagination` Pagination, required
    - `total_count` integer, required
    - `max_page` integer, required

## Other responses

- `422` — Validation Error

---

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