> ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # List Meters > List meters of the authenticated customer. **Scopes**: `customer_portal:read` `customer_portal:write` ## OpenAPI ````yaml /openapi/2027-01.openapi.json get /v1/customer-portal/meters/ openapi: 3.1.0 info: title: Polar API summary: Polar HTTP and Webhooks API description: >- Read the docs at https://polar.sh/docs/api-reference. See https://polar.sh/docs/api-reference/versioning for the API versioning and deprecation policy. version: 2027-01 servers: - url: https://api.polar.sh description: Production environment x-speakeasy-server-id: production x-polar-environment: production - url: https://sandbox-api.polar.sh description: Sandbox environment x-speakeasy-server-id: sandbox x-polar-environment: sandbox security: [] tags: - name: public description: >- Endpoints shown and documented in the Polar API documentation and available in our SDKs. - name: private description: >- Endpoints that should appear in the schema only in development to generate our internal JS SDK. - name: mcp description: Endpoints supported by Polar's MCP server. - name: cli description: Endpoints exposed as commands by Polar's CLI. externalDocs: description: API versioning and deprecation policy url: https://polar.sh/docs/api-reference/versioning paths: /v1/customer-portal/meters/: get: tags: - customer_portal - customer_meters - public summary: List Meters description: |- List meters of the authenticated customer. **Scopes**: `customer_portal:read` `customer_portal:write` operationId: customer_portal:customer_meters:list parameters: - name: meter_id in: query required: false schema: anyOf: - type: string format: uuid4 description: The meter ID. - type: array items: type: string format: uuid4 description: The meter ID. - type: 'null' title: MeterID Filter description: Filter by meter ID. description: Filter by meter ID. - name: query in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by meter name. title: Query description: Filter by meter name. - name: page in: query required: false schema: type: integer exclusiveMinimum: 0 description: Page number, defaults to 1. default: 1 title: Page description: Page number, defaults to 1. - name: limit in: query required: false schema: type: integer exclusiveMinimum: 0 description: Size of a page, defaults to 10. Maximum is 100. default: 10 title: Limit description: Size of a page, defaults to 10. Maximum is 100. - name: sorting in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/CustomerCustomerMeterSortProperty' - type: 'null' description: >- 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. default: - '-modified_at' title: Sorting description: >- 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. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ListResource_CustomerCustomerMeter_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - customer_session: - customer_portal:read - customer_portal:write - member_session: - customer_portal:read - customer_portal:write x-codeSamples: - lang: python source: | from polar.v2027_01 import Polar polar = Polar("polar_oat_xxx") for item in polar.customer_portal.customer_meters.iter_list( page=1, limit=10, sorting=['-modified_at'], ): print(item) - lang: typescript source: > import { createPolar } from "@polar-sh/sdk/2027-01"; const polar = createPolar({ accessToken: "polar_oat_xxx", }); for await (const item of polar.customerPortal.customerMeters.iterList( { "page": 1, "limit": 10, "sorting": [ "-modified_at" ] }, )) { console.log(item); } components: schemas: CustomerCustomerMeterSortProperty: type: string enum: - created_at - '-created_at' - modified_at - '-modified_at' - meter_id - '-meter_id' - meter_name - '-meter_name' - consumed_units - '-consumed_units' - credited_units - '-credited_units' - balance - '-balance' title: CustomerCustomerMeterSortProperty ListResource_CustomerCustomerMeter_: properties: items: items: $ref: '#/components/schemas/CustomerCustomerMeter' type: array title: Items pagination: $ref: '#/components/schemas/Pagination' type: object required: - items - pagination title: ListResource[CustomerCustomerMeter] HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError CustomerCustomerMeter: properties: id: type: string format: uuid4 title: Id description: The ID of the object. created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. examples: - '2026-01-01T00:00:00.000000Z' modified_at: anyOf: - type: string format: date-time examples: - '2026-01-01T00:00:00.000000Z' - type: 'null' title: Modified At description: Last modification timestamp of the object. customer_id: type: string format: uuid4 title: Customer Id description: The ID of the customer. examples: - 992fae2a-2a17-4b7a-8d9e-e287cf90131b meter_id: type: string format: uuid4 title: Meter Id description: The ID of the meter. examples: - d498a884-e2cd-4d3e-8002-f536468a8b22 consumed_units: type: number title: Consumed Units description: The number of consumed units. examples: - 25 credited_units: type: integer title: Credited Units description: The number of credited units. examples: - 100 balance: type: number title: Balance description: >- The balance of the meter, i.e. the difference between credited and consumed units. examples: - 75 meter: $ref: '#/components/schemas/CustomerCustomerMeterMeter' type: object required: - id - created_at - modified_at - customer_id - meter_id - consumed_units - credited_units - balance - meter title: CustomerCustomerMeter Pagination: properties: total_count: type: integer title: Total Count max_page: type: integer title: Max Page type: object required: - total_count - max_page title: Pagination ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError CustomerCustomerMeterMeter: properties: created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. examples: - '2026-01-01T00:00:00.000000Z' modified_at: anyOf: - type: string format: date-time examples: - '2026-01-01T00:00:00.000000Z' - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the object. name: type: string title: Name description: >- The name of the meter. Will be shown on customer's invoices and usage. type: object required: - created_at - modified_at - id - name title: CustomerCustomerMeterMeter securitySchemes: customer_session: type: http description: >- Customer session tokens are specific tokens that are used to authenticate customers on your organization. You can create those sessions programmatically using the [Create Customer Session endpoint](/api-reference/customer-sessions/create-customer-session). scheme: bearer member_session: type: http description: >- Member session tokens are specific tokens that are used to authenticate members on your organization. You can create those sessions programmatically using the [Create Member Session endpoint](/api-reference/customer-sessions/create-customer-session). scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.