Skip to main content

Input fields

accountType : AccountTypeChoices default: DOMESTIC

The type of account to create.

billingAddress : LifecycleAddressInput! required

The billing address.

billingName : String! required

The billing name.

brandCode : String! required

The brand of the created account.

chosenPaymentDay : Int

The chosen payment day.

customerDetails : CustomerDetailsInput! required

Customer details required to make a French account.

dateOfSale : Date

The date of sale, defaults to today if not provided.

PCEId : String

PCE ID of the gas meter point.

Deprecation
The 'PCEId' field is deprecated.

Use SupplyPointInfoInput.

- Marked as deprecated on 2025-04-10.
- Scheduled for removal on or after 2025-07-01.
preferredSsd : Date

The preferred supply start date.

PRMId : String

PRM ID of the electricity meter point.

Deprecation
The 'PRMId' field is deprecated.

Use SupplyPointInfoInput.

- Marked as deprecated on 2025-04-10.
- Scheduled for removal on or after 2025-07-01.
salesInfo : SalesInformationInput! required

Sales information.

supplyPointInfoList : [PrepareAccountSupplyPointInput]

Information of the supply points that the customer is intending to sign up for supply.

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

{ "accountType": "BUSINESS", "billingAddress": LifecycleAddressInput, "billingName": "marriage-push-all-he-network", "brandCode": "themselves-message-fish-page-on", "chosenPaymentDay": 38, "customerDetails": CustomerDetailsInput, "dateOfSale": "2015-11-11", "preferredSsd": "2007-07-03", "salesInfo": SalesInformationInput, "supplyPointInfoList": PrepareAccountSupplyPointInput }