meter_order.cancelled

{
  "id": "evt_mi4f0oda6x9m7gcsvjk0ole1",
  "timestamp": "2026-01-15T10:30:00.000Z",
  "topic": "meter_order.cancelled",
  "context": {
    "meter_order": "prdo_mi4f0oda6x9m7gcsvjk0ole1",
    "subscription": "sub_mi4f0oda6x9m7gcsvjk0ole1"
  }
}

Available from API version 2026-05-27.curie onwards.

Triggered when a smart meter order is cancelled and will not progress further. The order resource carries a cancellation_reason field describing why. A subscription can only ever have one smart meter order, so a cancelled order is terminal.

Response body parameters

string

required

Unique event identifier (starts with evt_).

string

required

ISO 8601 timestamp when the event was created.

literal

required

Always meter_order.cancelled for this event.

object

required

Event-specific data containing related resource IDs.

Hide properties

string

required

ID of the related smart meter order.Fetch the full record via GET /meter-orders/{id}.

string

required

ID of the related subscription (starts with sub_).Fetch the full record via GET /subscriptions/{id}.

{
  "id": "evt_mi4f0oda6x9m7gcsvjk0ole1",
  "timestamp": "2026-01-15T10:30:00.000Z",
  "topic": "meter_order.cancelled",
  "context": {
    "meter_order": "prdo_mi4f0oda6x9m7gcsvjk0ole1",
    "subscription": "sub_mi4f0oda6x9m7gcsvjk0ole1"
  }
}

meter_order.blocked

Subscriptions

Invoices

Meter Orders

meter_order.cancelled

Response body parameters

​Response body parameters

Response body parameters