MeterCreate
April 10, 2026 ยท View on GitHub
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
metadata | Dict[str, models.MeterCreateMetadata] | :heavy_minus_sign: | 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 | str | :heavy_check_mark: | The name of the meter. Will be shown on customer's invoices and usage. | |
unit | Optional[models.MeterUnit] | :heavy_minus_sign: | N/A | |
custom_label | OptionalNullable[str] | :heavy_minus_sign: | The label for the custom unit, e.g. 'request'. Required when unit is 'custom'. | |
custom_multiplier | OptionalNullable[int] | :heavy_minus_sign: | 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_ | models.Filter | :heavy_check_mark: | N/A | |
aggregation | models.MeterCreateAggregation | :heavy_check_mark: | The aggregation to apply on the filtered events to calculate the meter. | |
organization_id | OptionalNullable[str] | :heavy_minus_sign: | The ID of the organization owning the meter. Required unless you use an organization token. | 1dbfc517-0bbf-4301-9ba8-555ca42b9737 |