Skip to content

Latest commit

 

History

History
15 lines (12 loc) · 12.3 KB

File metadata and controls

15 lines (12 loc) · 12.3 KB

MeterUpdate

Fields

Field Type Required Description
metadata Dict[str, models.MeterUpdateMetadata] 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 OptionalNullable[str] The name of the meter. Will be shown on customer's invoices and usage.
unit OptionalNullable[models.MeterUnit] The unit of the meter.
custom_label OptionalNullable[str] The label for the custom unit. Required when unit is 'custom'.
custom_multiplier OptionalNullable[int] The multiplier to convert from base unit to display scale. Required when unit is 'custom'.
filter_ OptionalNullable[models.Filter] The filter to apply on events that'll be used to calculate the meter.
aggregation OptionalNullable[models.Aggregation] The aggregation to apply on the filtered events to calculate the meter.
is_archived OptionalNullable[bool] Whether the meter is archived. Archived meters are no longer used for billing.