MeterUpdate

April 10, 2026 ยท View on GitHub

Fields

FieldTypeRequiredDescription
metadataDict[str, models.MeterUpdateMetadata]: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.
nameOptionalNullable[str]:heavy_minus_sign:The name of the meter. Will be shown on customer's invoices and usage.
unitOptionalNullable[models.MeterUnit]:heavy_minus_sign:The unit of the meter.
custom_labelOptionalNullable[str]:heavy_minus_sign:The label for the custom unit. Required when unit is 'custom'.
custom_multiplierOptionalNullable[int]:heavy_minus_sign:The multiplier to convert from base unit to display scale. Required when unit is 'custom'.
filter_OptionalNullable[models.Filter]:heavy_minus_sign:The filter to apply on events that'll be used to calculate the meter.
aggregationOptionalNullable[models.Aggregation]:heavy_minus_sign:The aggregation to apply on the filtered events to calculate the meter.
is_archivedOptionalNullable[bool]:heavy_minus_sign:Whether the meter is archived. Archived meters are no longer used for billing.