Skip to main content

Input fields

bandCategory : LimitedBandCategories! required

The band category of the product rate.

bandSubcategory : AllBandSubCategories

The band subcategory of the product rate. For gas products, pass 'null'. For electricity products, select a subcategory.

gsp : GSPGroupIdsOptions! required

The GSP group id of the product rate.

paymentMethod : PaymentMethodChoices

The payment method of the product rate, if applicable.

pricePerUnit : Decimal! required

The value of the product rate.

validFrom : DateTime! required

Date and time the product rate is effective from.

validTo : DateTime

Date and time the product rate is effective to.

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

{ "bandCategory": "STANDING_CHARGE", "bandSubcategory": "STANDARD", "gsp": "_A", "paymentMethod": "DIRECT_DEBIT", "pricePerUnit": "1.0", "validFrom": "1980-07-27T18:06:06.906952+00:00", "validTo": "2014-11-08T22:25:38.812593+00:00" }