---
title: "Retrieve usage data"
method: GET
path: "/subscriptions/{id}/usage"
tags: ["Usage"]
---

# Retrieve usage data

`GET /subscriptions/{id}/usage`

Retrieve the usage data for a subscription. Usage is the electricity consumed from the grid, or fed into the grid for feed-in subscriptions. Values are positive magnitudes for both directions; the direction comes from the plan. Results depend on the meter type.

**Smart meters**:
Usage data becomes available from 4pm on the following day. Metering Service Providers (MSB) might share preliminary values until replaced by final values up to the 8th working day of the following month. Data is available as soon as provided by the responsible MSB. Delays or missing data may occur.

**Analog meters**:
Data is based on meter readings by customers and MSBs and available on a monthly level. In the absence of metering readings, Nomos creates a preliminary estimation at the end of each month. Subsequent meter readings take precedence over existing estimates and trigger invoice corrections if applicable.

## Path parameters

- `id` string, required

## Query parameters

- `resolution` 'auto' | '15min' | 'hour' | 'day' | 'week' | 'month' — The resolution of the consumption. 'auto' will choose a good resolution based on the start and end date.
- `start` string — The start date of the interval (inclusive). Defaults depend on the meter type. **Smart meters**: yesterday start of day (00:00:00) in the customers's timezone. **Analog meters**: subscription start date or 12 months ago, whichever is later.
- `end` string — The end date of the interval (exclusive). Defaults depend on the meter type. **Smart meters**: today start of day (00:00:00) in the customers's timezone. **Analog meters**: latest available reading date.

## Response `200`

Retrieve the subscription usage

- object
  - `object` 'usage', required
  - `meter_type` 'analog' | 'smart', required — The meter type. Smart meters record consumption data in 15min intervals, analog meter readings only get reported periodically by the metering operator or the customer.
  - `resolution` '15min' | 'hour' | 'day' | 'week' | 'month', required — The resolution of the consumption. An optimal resolution will be chosen based on the start and end date if no `resolution` is provided in the query params.
  - `data` object[], required — The consumption of the meter
    - `start` string, date-time, required — The start date of the consumption interval
    - `usage` number, required — Consumption in kWh in the interval
    - `type` 'final' | 'preliminary', required — Preliminary values are still subject to change

## Other responses

- `400` — The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
- `401` — The client must authenticate itself to get the requested response.
- `402` — A higher pricing plan is required to access the resource.
- `403` — The client does not have the necessary permissions to access the resource.
- `404` — The server can't find the requested resource.
- `405` — The request method is not allowed.
- `409` — The request could not be completed due to a conflict mainly due to unique constraints.
- `422` — The request was well-formed but was unable to be followed due to semantic errors.
- `429` — The client has sent too many requests.
- `500` — The server has encountered a situation it doesn't know how to handle.

---

[API](https://skmtc.net/nomos/apis/nomos-api.md) · [All operations](https://skmtc.net/nomos/apis/nomos-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nomos/nomos-api/versions/da60ad83e92f/schema)