Skip to main content
POST
/
subscriptions
/
{id}
/
meter_readings
Submit a meter reading
curl --request POST \
  --url https://api.nomos.energy/subscriptions/{id}/meter_readings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": 150,
  "timestamp": "2024-03-14T12:00:00Z",
  "message": "Reading to start the subscription"
}
'
{
  "object": "meter_reading",
  "id": "mr_rocbrf1u5e48mm0reeqoag90",
  "customer": "cus_a8n8ol7yd4h0wohx824f0bui",
  "subscription": "sub_rocbrf1u5e48mm0reeqoag90",
  "meter": "mtr_azk4zue2ijx4ff1dbjt14m5h",
  "value": 150,
  "timestamp": "2023-11-07T05:31:56Z",
  "type": "customer_report",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required
Example:

"sub_ig1f5x45789r3ax7dlfff4q4"

Body

application/json

Meter reading input

​
value
number
required

Cumulative meter value in kWh

Required range: x > 0
Example:

150

​
timestamp
string<date-time>
required

Timestamp of the reading in UTC

Example:

"2024-03-14T12:00:00Z"

​
message
string

Optional message from the submitter

Maximum string length: 500
Example:

"Reading to start the subscription"

Response

Meter reading accepted

​
object
enum<string>
required
Available options:
meter_reading
​
id
string
required

The unique identifier for the meter reading

Example:

"mr_rocbrf1u5e48mm0reeqoag90"

​
customer
string
required

The unique identifier for the customer

Example:

"cus_a8n8ol7yd4h0wohx824f0bui"

​
subscription
string
required

The unique identifier for the subscription

Example:

"sub_rocbrf1u5e48mm0reeqoag90"

​
meter
string
required

The unique identifier for the meter

Example:

"mtr_azk4zue2ijx4ff1dbjt14m5h"

​
value
number
required

The value of the meter reading

Example:

150

​
timestamp
string<date-time>
required

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

​
type
enum<string>
required

The type of the meter reading

Available options:
customer_report,
grid_reading,
grid_estimation
Example:

"customer_report"

​
created_at
string<date-time>
required