v6

latestOpenAPI 3.1.02026-07-311856741.1 MB
meters
public

Get Meter

Get a meter by ID.

Scopes: meters:read meters:write

get/v1/meters/{id}

Path parameters

idstring uuid4 required

The meter ID.

The meter ID.

Response

Successful Response

metadataMetadataOutputType required
created_atstring date-time required

Creation timestamp of the object.

modified_atstring date-time nullable required

Last modification timestamp of the object.

idstring uuid4 required

The ID of the object.

namestring required

The name of the meter. Will be shown on customer's invoices and usage.

unit'scalar' | 'token' | 'custom' required
custom_labelstring nullable

The label for the custom unit.

custom_multiplierinteger nullable

The multiplier to convert from base unit to display scale.

organization_idstring uuid4 required

The ID of the organization owning the meter.

archived_atstring date-time nullable

Whether the meter is archived and the time it was archived.