metercreate.md

MeterCreate

Example Usage

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

let value: MeterCreate = {
  name: "<value>",
  filter: {
    conjunction: "or",
    clauses: [
      {
        property: "<value>",
        operator: "lt",
        value: false,
      },
    ],
  },
  aggregation: {
    func: "avg",
    property: "<value>",
  },
  organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
};

Fields

Field	Type	Required	Description	Example
metadata	Record<string, components.MeterCreateMetadata>	➖	Key-value object allowing you to store additional information. The key must be a string with a maximum length of 40 characters. The value must be either: * A string with a maximum length of 500 characters * An integer * A floating-point number * A boolean You can store up to 50 key-value pairs.
name	string	✔️	The name of the meter. Will be shown on customer's invoices and usage.
unit	components.MeterUnit	➖	N/A
customLabel	string	➖	The label for the custom unit, e.g. 'request'. Required when unit is 'custom'.
customMultiplier	number	➖	The multiplier to convert from the base unit to display scale, e.g. 1000 to display per 1000 units. Defaults to 1 when not provided.
filter	components.Filter	✔️	N/A
aggregation	components.MeterCreateAggregation	✔️	The aggregation to apply on the filtered events to calculate the meter.
organizationId	string	➖	The ID of the organization owning the meter. Required unless you use an organization token.	1dbfc517-0bbf-4301-9ba8-555ca42b9737