Skip to main content

Input fields

changeOfTenancyType : ChangeOfTenancyType! required

Change of tenancy type (subrogation or transfer) for the supply point.

Deprecated. The city of the supply property.

Deprecation
The 'changeOfTenancyAddress' field is deprecated.

Use 'structuredAddress' on the supply point group instead. When it is supplied, these fields are ignored and the structured address is used for the change of tenancy.

- Marked as deprecated on 2026-08-05.
- Scheduled for removal on or after 2026-11-05.
dismissDebtRejections : Boolean! required

Whether to dismiss debt-related rejections during enrollment.

door : String

Deprecated. The door of the supply property.

Deprecation
The 'changeOfTenancyAddress' field is deprecated.

Use 'structuredAddress' on the supply point group instead. When it is supplied, these fields are ignored and the structured address is used for the change of tenancy.

- Marked as deprecated on 2026-08-05.
- Scheduled for removal on or after 2026-11-05.
estimatedAnnualFlow : Int

The estimated annual flow.

floor : String

Deprecated. The floor of the supply property.

Deprecation
The 'changeOfTenancyAddress' field is deprecated.

Use 'structuredAddress' on the supply point group instead. When it is supplied, these fields are ignored and the structured address is used for the change of tenancy.

- Marked as deprecated on 2026-08-05.
- Scheduled for removal on or after 2026-11-05.
isPrincipalHouse : Boolean! required

Whether the supply property is the principal house of the customer.

postalCode : String

Deprecated. The postal code of the supply property.

Deprecation
The 'changeOfTenancyAddress' field is deprecated.

Use 'structuredAddress' on the supply point group instead. When it is supplied, these fields are ignored and the structured address is used for the change of tenancy.

- Marked as deprecated on 2026-08-05.
- Scheduled for removal on or after 2026-11-05.
province : Provinces

Deprecated. The province of the supply property.

Deprecation
The 'changeOfTenancyAddress' field is deprecated.

Use 'structuredAddress' on the supply point group instead. When it is supplied, these fields are ignored and the structured address is used for the change of tenancy.

- Marked as deprecated on 2026-08-05.
- Scheduled for removal on or after 2026-11-05.
streetName : String

Deprecated. The street name of the supply property.

Deprecation
The 'changeOfTenancyAddress' field is deprecated.

Use 'structuredAddress' on the supply point group instead. When it is supplied, these fields are ignored and the structured address is used for the change of tenancy.

- Marked as deprecated on 2026-08-05.
- Scheduled for removal on or after 2026-11-05.
streetNumber : String

Deprecated. The street number of the supply property.

Deprecation
The 'changeOfTenancyAddress' field is deprecated.

Use 'structuredAddress' on the supply point group instead. When it is supplied, these fields are ignored and the structured address is used for the change of tenancy.

- Marked as deprecated on 2026-08-05.
- Scheduled for removal on or after 2026-11-05.
streetType : String

Deprecated. The street type of the supply property.

Deprecation
The 'changeOfTenancyAddress' field is deprecated.

Use 'structuredAddress' on the supply point group instead. When it is supplied, these fields are ignored and the structured address is used for the change of tenancy.

- Marked as deprecated on 2026-08-05.
- Scheduled for removal on or after 2026-11-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

{ "changeOfTenancyType": "SUBROGATION", "dismissDebtRejections": true, "estimatedAnnualFlow": 76, "isPrincipalHouse": true }