Skip to main content

POST /consumption-amendment/v1/{mpid}

Creates a consumption amendment request for the specified MPAN and period.

Request​

Method and path:

  • POST /consumption-amendment/v1/{mpid}

Headers:

  • X-API-KEY (required): string, API key in UUID format.
  • X-IDEMPOTENCY-KEY (required): string.
  • X-TEST-MODE (optional): string.

Path parameters:

  • mpid (required): string supplier MPID.

Body schema:

  • Consumption amendment request object
{
  "mpan_core": 1234567890123,
  "supplier_reference": "CA-2026-0001",
  "period_start_date": "2026-02-01T00:00:00+00:00",
  "period_end_date": "2026-02-28T00:00:00+00:00",
  "measurement_quantity_id": "AI",
  "gross_revised_consumption": "3500.125",
  "reason_code": "A"
}

Response​

Success:

  • 201 Created
  • Body: supplier process response object
{
  "request_id": "72f30f06-afcc-4ad8-8c1f-78e556ea9cbc",
  "request_type": "consumption-amendment",
  "request_status": "Pending",
  "description": "Consumption Amendment Process",
  "created_at": "2026-03-11T14:04:22+00:00",
  "last_updated_at": "2026-03-11T14:04:22+00:00",
  "mpan_core": 1234567890123
}

Other documented responses:

  • 401 Unauthorized
  • 422 Validation error
  • 428 Missing X-IDEMPOTENCY-KEY

Field-level constraints: