Skip to main content
POST
Create a smart meter order

Authorizations

Authorization
string
header
required

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

Body

application/json

The meter order to create

subscription
string
required

ID of the subscription to create the meter order for

Example:

"sub_mi4f0oda6x9m7gcsvjk0ole1"

Response

The created meter order details

object
enum<string>
required

Type of the object, always 'meter_order'

Available options:
meter_order
id
string
required

Unique identifier for the meter order

Example:

"prdo_mi4f0oda6x9m7gcsvjk0ole1"

subscription
string
required

ID of the subscription

Example:

"sub_mi4f0oda6x9m7gcsvjk0ole1"

customer
string
required

ID of the customer

Example:

"cus_mi4f0oda6x9m7gcsvjk0ole1"

provider
enum<string>
required

The smart meter provider

Available options:
energy-metering,
metrify,
inexogy
Example:

"energy-metering"

status
enum<string>
required

Lifecycle milestone of the meter order. Progresses roughly createdplacedcheck_submittedcheck_reviewedscheduledinstalledactivated; cancelled is a terminal state.

Available options:
created,
placed,
check_submitted,
check_reviewed,
scheduled,
installed,
activated,
cancelled
Example:

"created"

created_at
required

Timestamp when the order was created

Example:

"2026-06-30T12:00:00Z"

installed_at
required

Timestamp when the smart meter was installed, or null if the order has not reached the installed milestone.

Example:

null

activated_at
required

Timestamp when the smart meter began delivering readings, or null if the order has not been activated.

Example:

null

cancelled_at
required

Timestamp when the order was cancelled, or null if the order is not cancelled.

Example:

null

cancelled_reason
enum<string> | null
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.

Available options:
pre_existing,
customer_request,
null
Example:

null

blocked_at
required

Timestamp when the order was blocked, or null if the order is not blocked.

Example:

null

blocked_reason
enum<string> | null
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.

Available options:
check_missing,
grid_operator_registration,
null
Example:

null

appointment_at
required

Scheduled installation appointment, when the provider has communicated one. Null while no appointment is known.

Example:

null