Runs payment adequacy with the projected costs of the new agreements. If necessary, a new payment schedule will be created aligning with the date the new agreements become active and in accordance with the relevant payment adequacy policy.

updatePaymentAmount : Boolean

Runs payment adequacy and checks if the amount the customer is paying each month should be updated.

Deprecation

The 'updatePaymentAmount' field is deprecated.

Use runPaymentAdequacy instead.

- Marked as deprecated on 2025-03-05.
- Scheduled for removal on or after 2025-09-05.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{
  "accountNumber": "A-CCD63156",
  "meterPointSwitchContexts": MeterPointSwitchContext,
  "runPaymentAdequacy": true
}