Skip to content

Latest commit

 

History

History
36 lines (31 loc) · 4.19 KB

meter.md

File metadata and controls

36 lines (31 loc) · 4.19 KB

Meter

Example Usage

import { Meter } from "@polar-sh/sdk/models/components/meter.js";

let value: Meter = {
  metadata: {
    "key": "<value>",
  },
  createdAt: new Date("2024-01-22T16:24:11.216Z"),
  modifiedAt: new Date("2025-04-24T10:11:14.990Z"),
  id: "<value>",
  name: "<value>",
  filter: {
    conjunction: "and",
    clauses: [],
  },
  aggregation: {},
  organizationId: "<value>",
};

Fields

Field Type Required Description
metadata Record<string, components.MeterMetadata> ✔️ N/A
createdAt Date ✔️ Creation timestamp of the object.
modifiedAt Date ✔️ Last modification timestamp of the object.
id string ✔️ The ID of the object.
name string ✔️ The name of the meter. Will be shown on customer's invoices and usage.
filter components.Filter ✔️ N/A
aggregation components.MeterAggregation ✔️ The aggregation to apply on the filtered events to calculate the meter.
organizationId string ✔️ The ID of the organization owning the meter.