GET
/
v1
/
meters
/
{id}
/
quantities
Typescript (SDK)
import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.meters.quantities({
    id: "<value>",
    startTimestamp: new Date("2025-11-25T04:37:16.823Z"),
    endTimestamp: new Date("2025-11-26T17:06:00.727Z"),
    interval: "day",
  });

  console.log(result);
}

run();
{
  "quantities": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "quantity": 10
    }
  ],
  "total": 100
}

Authorizations

​
Authorization
string
header
required

You can generate an Organization Access Token from your organization's settings.

Path Parameters

​
id
string<uuid4>
required

The meter ID.

Query Parameters

​
start_timestamp
string<date-time>
required

Start timestamp.

​
end_timestamp
string<date-time>
required

End timestamp.

​
interval
enum<string>
required

Interval between two timestamps.

Available options:
year,
month,
week,
day,
hour
​
customer_id

Filter by customer ID. The customer ID.

​
external_customer_id

Filter by external customer ID.

​
metadata
object | null

Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.

Response

Successful Response

​
quantities
MeterQuantity · object[]
required
​
total
number
required

The total quantity for the period.

Examples:

100