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.
Operational notes
Update a meter.
Scopes: meters:write
Authorizations
You can generate an Organization Access Token from your organization's settings.
Path Parameters
The meter ID.
Body
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.
The name of the meter. Will be shown on customer's invoices and usage.
3The unit of the meter.
scalar, token, custom The label for the custom unit. Required when unit is 'custom'.
The multiplier to convert from base unit to display scale. Required when unit is 'custom'.
x > 0The filter to apply on events that'll be used to calculate the meter.
The aggregation to apply on the filtered events to calculate the meter.
- CountAggregation
- PropertyAggregation
- UniqueAggregation
Whether the meter is archived. Archived meters are no longer used for billing.
Response
Meter updated.
The time Ruba created this record.
The time this record last changed.
The stable identifier for this record.
The name of the meter. Will be shown on customer's invoices and usage.
The unit of the meter.
scalar, token, custom The filter to apply on events that'll be used to calculate the meter.
The aggregation to apply on the filtered events to calculate the meter.
- CountAggregation
- PropertyAggregation
- UniqueAggregation
The ID of the organization owning the meter.
The label for the custom unit.
The multiplier to convert from base unit to display scale.
Whether the meter is archived and the time it was archived.