Where the account's current payment schedule has a debt repayment element, we let the user choose whether to continue making catch-up payments, or to repay the full debt in addition to their next payment.

persistFlatRate : Boolean

If the customer is currently on a flat rate tariff, persist this into the new agreement.

propertyId : ID!


            required

The ID of the property that agreements should be renewed for.

quotedProductId : ID!


            required

The ID of the quoted product we wish to use to create new agreements. Part of the tariff renewal journey involves re-quoting to ensure this is available.

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-31857627",
  "changeOn": "1989-01-05",
  "makeFullDebtRepayment": true,
  "persistFlatRate": true,
  "propertyId": "93433072",
  "quotedProductId": "88440601"
}