v1

latestOpenAPI 3.0.02026-07-263365201.7 KB

Usage

List meter readings

Retrieve all meter readings for the organization with cursor pagination. Customer users will only see their own. Use filter[subscription][eq]=<id> to scope to a single subscription.

get/meter-readings

Query parameters

cursorstring nullable

limitnumber

filter[field][operator]string nullable

Filterable fields:

type (string)
subscription (string)
created_at (date)

See Filtering Documentation for supported operators and syntax.

Example:value

Filterable fields:

type (string)
subscription (string)
created_at (date)

See Filtering Documentation for supported operators and syntax.

Response

Retrieve all meter readings for the organization with cursor pagination. Customer users will only see their own. Use filter[subscription][eq]=<id> to scope to a single subscription.

object'list' required

next_pagestring nullable

has_moreboolean

Example response

{
  "items": [
    {
      "id": "mr_rocbrf1u5e48mm0reeqoag90",
      "customer": "cus_a8n8ol7yd4h0wohx824f0bui",
      "subscription": "sub_rocbrf1u5e48mm0reeqoag90",
      "meter": "mtr_azk4zue2ijx4ff1dbjt14m5h",
      "value": 150,
      "type": "customer_report"
    }
  ],
  "next_page": "eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0="
}