Sign in

v1

latestOpenAPI 3.0.02026-07-263365201.7 KB
Usage

Create a meter reading

Submit a customer-reported analog meter reading for the active meter of a subscription.

post/meter-readings

Request body

valuenumber required

Cumulative meter value in kWh

timestampstring date-time required

Timestamp of the reading in UTC

messagestring

Optional message from the submitter

subscriptionstring required

The subscription the meter reading belongs to

Example request

{
  "value": 150,
  "timestamp": "2024-03-14T12:00:00Z",
  "message": "Reading to start the subscription",
  "subscription": "sub_rocbrf1u5e48mm0reeqoag90"
}

Response

Meter reading accepted

object'meter_reading' required
idstring required

The unique identifier for the meter reading

customerstring required

The unique identifier for the customer

subscriptionstring required

The unique identifier for the subscription

meterstring required

The unique identifier for the meter

valuenumber required

The value of the meter reading

timestampstring date-time required

Timestamp get's always adjusted to the start of the day in Europe/Berlin

type'customer_report' | 'grid_reading' | 'grid_estimation' required

The type of the meter reading

created_atstring date-time required

Example response

{
  "id": "mr_rocbrf1u5e48mm0reeqoag90",
  "customer": "cus_a8n8ol7yd4h0wohx824f0bui",
  "subscription": "sub_rocbrf1u5e48mm0reeqoag90",
  "meter": "mtr_azk4zue2ijx4ff1dbjt14m5h",
  "value": 150,
  "type": "customer_report"
}