Sign in

v1

latestOpenAPI 3.0.02026-07-263365201.7 KB
Smart Meter Orders

Create a smart meter order

Create a new meter order for a subscription. The subscription's plan must support a smart-meter product type. Not applicable for feed-in subscriptions, as a smart meter must be present before starting a feed-in subscription.

post/meter-orders

Request body

subscriptionstring required

ID of the subscription to create the meter order for

Example request

{
  "subscription": "sub_mi4f0oda6x9m7gcsvjk0ole1"
}

Response

The created meter order details

object'meter_order' required

Type of the object, always 'meter_order'

idstring required

Unique identifier for the meter order

subscriptionstring required

ID of the subscription

customerstring required

ID of the customer

provider'energy-metering' | 'metrify' | 'inexogy' required

The smart meter provider

status'created' | 'placed' | 'check_submitted' | 'check_reviewed' | 'scheduled' | 'installed' | 'activated' | 'cancelled' required

Lifecycle milestone of the meter order. Progresses roughly created → placed → check_submitted → check_reviewed → scheduled → installed → activated; cancelled is a terminal state.

cancelled_reason'pre_existing' | 'customer_request' | 'null' nullable required

Why the order was cancelled: pre_existing when a smart meter was already installed at the location, customer_request when the customer or an operator cancelled the order. Null when the order is not cancelled.

blocked_reason'check_missing' | 'grid_operator_registration' | 'null' nullable required

Why the order is blocked: check_missing when the smart-meter check has not been performed yet, grid_operator_registration when the grid operator registration is pending. Null when the order is not blocked.

Example response

{
  "id": "prdo_mi4f0oda6x9m7gcsvjk0ole1",
  "subscription": "sub_mi4f0oda6x9m7gcsvjk0ole1",
  "customer": "cus_mi4f0oda6x9m7gcsvjk0ole1",
  "provider": "energy-metering",
  "status": "created"
}