Input fields

acceptedTAndC : Boolean! required

True if the customer has accepted the terms and conditions.
accountUserMetadata : [MetadataInput]

Account user metadata.
billingFrequency : BillingFrequency default: YEARLY

The billing frequency.
billingName : String

The customer's billing name (only required for direct debit).
consentData : FraConsentDataInput

Consents for Distribution Network Operators.
Deprecation
The 'consentData' field is deprecated.

Consents are now set per supply point ID. Please use 'consentDataPerSupplyPointId' instead.

- Marked as deprecated on 2024-03-20.
- Scheduled for removal on or after 2024-05-20.
consentDataPerSupplyPointId : [IndustryConsentDataPerSupplyPointInput!]

Consents per supply point for Distribution Network Operators.
consents : [ConsentTypeInput]

Consents to update for account user.
iban : String

The IBAN number.
paymentDay : Int

The preferred day of the month the customer wants the payment to occur (only required for direct debit).
paymentInstructionVendorReference : String

The vendor reference.
preferences : UpdateAccountUserCommsPreferencesInput

Comms preferences.
Deprecation
The 'preferences' field is deprecated.

Preferences field use the legacy system. Please use 'consents' instead.

- Marked as deprecated on 2025-02-05.
- Scheduled for removal on or after 2025-05-01.
quoteCode : UUID! required

The code for the quote to be checked out.
requiresPostalComms : Boolean

Requires postal communications.
scheduleType : ScheduleType default: DIRECT_DEBIT

The payment method for the schedule.
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

{ "acceptedTAndC": true, "accountUserMetadata": MetadataInput, "billingFrequency": "MONTHLY", "billingName": "laugh-senior-example-environmental-something", "consentDataPerSupplyPointId": IndustryConsentDataPerSupplyPointInput, "consents": ConsentTypeInput, "iban": "continue-face-cold-effort-weight", "paymentDay": 85, "paymentInstructionVendorReference": "evening-represent-lawyer-focus-listen", "quoteCode": "57e54acc-62f5-480c-8fdf-8e1a060cea63", "requiresPostalComms": true, "scheduleType": "BACS_TRANSFER" }