Sign in

v6

latestOpenAPI 3.1.02026-07-311856741.1 MB
meters
public

Update Meter

Update a meter.

Scopes: meters:write

patch/v1/meters/{id}

Path parameters

idstring uuid4 required

The meter ID.

The meter ID.

Request body

metadataobject

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.

namestring nullable

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

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

The label for the custom unit. Required when unit is 'custom'.

custom_multiplierinteger nullable

The multiplier to convert from base unit to display scale. Required when unit is 'custom'.

is_archivedboolean nullable

Whether the meter is archived. Archived meters are no longer used for billing.

Response

Meter updated.

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.