Change Meter
Intent
Applies the supplied changes to the meter.
When to call it
Call this when the meter already exists and its stored values need to change.
Access boundary
Authorize the request with a token that carries meters:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Authorizations
Path Parameters
Identifier of the meter.
Body
Metadata map for information your integration needs to retain.
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 assigned to the meter. Will be shown on customer's invoices and usage.
3Unit: Unit of the meter.
scalar, token, custom Custom Label: Label for the custom unit. Required when unit is 'custom'.
Custom Multiplier: Multiplier to convert from base unit to display scale. Required when unit is 'custom'.
x > 0Filter: Filter to apply on events that'll be used to calculate the meter.
Aggregation: Aggregation to apply on the filtered events to calculate the meter.
- CountAggregation
- PropertyAggregation
- UniqueAggregation
Indicates whether the meter is archived. Archived meters are no longer used for billing.
Response
Response: Meter updated.
The time Ruba created this record.
The time this record last changed.
The stable identifier for this record.
Name assigned to the meter. Will be shown on customer's invoices and usage.
Unit: Unit of the meter.
scalar, token, custom Filter: Filter to apply on events that'll be used to calculate the meter.
Aggregation: Aggregation to apply on the filtered events to calculate the meter.
- CountAggregation
- PropertyAggregation
- UniqueAggregation
Unique identifier for the organization owning the meter.
Custom Label: Label for the custom unit.
Custom Multiplier: Multiplier to convert from base unit to display scale.
Indicates whether the meter is archived and the time it was archived.