Skip to main content

Input fields

accountNumber : String! required

Account number.

customerAgreesToConsentGranularityChange : Boolean

Has the customer agreed to a change in the meter point's consent granularity?

isNewAccount : Boolean
mpan : String

The MPAN to switch.

mprn : String

The MPRN to switch.

productCode : String! required

The product code to switch to.

targetAgreementChangeDate : Date

A target start date for the new agreement. Must be today or later. Will be ignored if date is in the past at time of creating the new agreement.

termsAndConditions : TermsAndConditionsInput
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-65CC0ABE", "customerAgreesToConsentGranularityChange": true, "isNewAccount": true, "mpan": "side-much-team-discussion-message", "mprn": "weight-official-learn-especially-nature", "productCode": "whatever-accept-situation-star-though", "targetAgreementChangeDate": "2011-11-25", "termsAndConditions": TermsAndConditionsInput }