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

# List Meters

`GET /v1/customer-portal/meters/`

## Request

- Base URL: `https://api.polar.sh`
- URL: `https://api.polar.sh/v1/customer-portal/meters/`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

List meters of the authenticated customer.

**Scopes**: `customer_portal:read` `customer_portal:write`

## Query parameters

- `meter_id` union: Filter by meter ID.
  - string, uuid4: The meter ID.
  - string[]
- `query` string, nullable: Filter by meter name.
- `page` integer: Page number, defaults to 1.
- `limit` integer: Size of a page, defaults to 10. Maximum is 100.
- `sorting` CustomerCustomerMeterSortProperty[], 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

- ListResourceCustomerCustomerMeter
  - `items` CustomerCustomerMeter[], 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.
    - `meter` CustomerCustomerMeterMeter, 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.
  - `pagination` Pagination, required
    - `total_count` integer, required
    - `max_page` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/polar/apis/polar-api.md) - [All operations](https://skmtc.dev/polar/apis/polar-api/llms.txt) - [OpenAPI document](https://skmtc.dev/polar/apis/polar-api/revisions/77e4ef94fcc3?raw)