v6

latestOpenAPI 3.1.02026-07-311856741.1 MB

customer_portal

customer_meters

public

Get Customer Meter

Get a meter by ID for the authenticated customer.

Scopes: customer_portal:read customer_portal:write

get/v1/customer-portal/meters/{id}

Path parameters

idstring uuid4 required

The customer meter ID.

Response

Successful Response

idstring uuid4 required

The ID of the object.

created_atstring date-time required

Creation timestamp of the object.

modified_atstring date-time nullable required

Last modification timestamp of the object.

customer_idstring uuid4 required

The ID of the customer.

meter_idstring uuid4 required

The ID of the meter.

consumed_unitsnumber required

The number of consumed units.

credited_unitsinteger required

The number of credited units.

balancenumber required

The balance of the meter, i.e. the difference between credited and consumed units.

Example response

{
  "customer_id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
  "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22",
  "consumed_units": 25,
  "credited_units": 100,
  "balance": 75
}