v1

latestOpenAPI 3.0.02026-07-263365201.7 KB

Smart Meter Orders

List smart meter orders

Retrieve all meter orders for the organization

get/meter-orders

Query parameters

cursorstring nullable

limitnumber

filter[field][operator]string nullable

Filterable fields:

status (enum): created, placed, check_submitted, check_reviewed, scheduled, installed, activated, cancelled
customer (string)
subscription (string)

See Filtering Documentation for supported operators and syntax.

Example:value

Filterable fields:

status (enum): created, placed, check_submitted, check_reviewed, scheduled, installed, activated, cancelled
customer (string)
subscription (string)

See Filtering Documentation for supported operators and syntax.

Response

Retrieve all meter orders for the organization

object'list' required

next_pagestring nullable

has_moreboolean

Example response

{
  "items": [
    {
      "id": "prdo_mi4f0oda6x9m7gcsvjk0ole1",
      "subscription": "sub_mi4f0oda6x9m7gcsvjk0ole1",
      "customer": "cus_mi4f0oda6x9m7gcsvjk0ole1",
      "provider": "energy-metering",
      "status": "created"
    }
  ],
  "next_page": "eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0="
}