Skip to main content

Input fields

changeOn : Date

The date the product switch should take effect. Defaults to the current agreement end date, or tomorrow if the agreement is open-ended.

commission : CommissionInput

Information on the commission that's associated with this agreement.

flatRate : Boolean

Should the meter point stay on a flat rate, if it's currently on one.

Deprecation
The 'flatRate' field is deprecated.

Please use `flatRateBehaviour` instead for more explicit control over flat-rate handling.

- Marked as deprecated on 2026-04-28.
- Scheduled for removal on or after 2026-10-28.

You can read more about this deprecation on:
https://announcements.kraken.tech/announcements/uk/edf/1220/
flatRateBehaviour : FlatRateBehaviour

Whether to change the flat-rate status of the meter point. Raises an error if both flatRate and flatRateBehaviour are provided.

mpxn : String! required

The MPxN of the meter point.

quotedProductId : ID! required

The ID of the selected quoted product.

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

{ "changeOn": "2000-07-24", "commission": CommissionInput, "flatRateBehaviour": "PERSIST", "mpxn": "skill-former-outside-source-play", "quotedProductId": "83921254" }