Managing Meters with the API

Meters are the customer-specific buckets of usage for the different meter types. When customer opts for a meter type then the meter need to be created using these parameters:

• Meter Key (for the Meter processor where usage data is guided)

• Meter Type ID (for the meter type the usage should be aggregated for)

• The User ID (for the customer)

Meters can be created, retrieved, updated, and deleted using the API, see API Reference.

Meter inherits these properties defined on the meter type used when creating a meter -

• Active From - Meter is active from the date time defined on the Active From field on the Meter Type. If Active To is before the meter creation time then Meter is activated as soon as it is created. The time is calculated based on timezone defined on the Meter Type when created by user interface.

• Active To - Meter is active to the date time defined on the Active To field on the Meter Type. The time is calculated based on timezone defined on the Meter Type when created by user interface.

• Unit - Unit defined on the Meter Type is a unit which is a unit for metered record value.

• Aggregation type - Meter follows the aggregation which is defined on the Meter Type.

• Reset schedule - Meter follows the reset schedule defined in the Meter Type. The period end of the Meter is calculated based on the reset schedule. The timezone defined on Meter type is considered when calculating period start and period end. See Meter Reset in Metered Output Record .
  When Meter is newly created the period start is when meter is created. It is shown on Period start field Meter Inspector in the selected timezone.

Update of Meter supports the update of parameter “deleteOnReset“ which can be set to true or false, default false. Once set to true, the meter is deleted when the current period ends after sending the metered record to downstream function.