{ "openapi": "3.0.0", "info": { "title": "UK Pricing API", "description": "---\nVersion History\n\n1.1.0\n+ Added Individual MPAN properties ProfileClass, MeterTimeswitchClass, LineLossFactorClass, DuosTariffId, and MhhsMigrated to /electricprices and /prompts.\n\n+ Now supports both legacy and post-MHHS format Top Lines. Elements will be extracted where present, but otherwise must be provided in new properties to make quotes possible for suppliers that require them.\n\n1.2.0\n+ Added ElectricSupply.ForcedRateStructure - Applicable for MHHS-Migrated meters where SSC is empty. Only some Suppliers support pricing via this method.\n\n1.3.0\n+ Deprecating Plan.PlanType in favour of dedicated properties: IsRenewable, StandingChargeType, Pricebook, IncludeMOPCharges, HalfHourlyNumberOfRates. PlanType will be processed if provided.\n+ Advanced Meters support - Added MarketSegment and ConnectionType to ElectricSupply and PromptsSearch. These will be used to determine HH status and MeteringSystem.\n+ /ratestructuredata endpoint. Provide Electric Meter details to retrieve the RateStructure/VoltageType that will be used to quote. Optionally include specific supplier names to limit the results to those suppliers only, as some will differ.\n\n1.4.0\n+ ReturnAllProducts Plan option - Instead of specifying each Plan element, or relying on the supplier default, this option can be used to retrieve all valid plans currently in effect for a given supplier. Any other included properties e.g. Duration, will filter these results internally.\n", "version": "1.4.0" }, "servers": [ ], "paths": { "/electricprices": { "post": { "summary": "Fetch electricity prices", "description": "Returns a collection of electric Rate Information for a given set of electric suppliers and settings.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetElectricRates" }, "examples": { "standard": { "summary": "Standard quote (new Plan properties)", "value": { "quoteDetails": { "QuoteReference": "ACME-0001", "SecurityDetails": { "LicenceCode": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", "mascaradeuser": "Test User" }, "ElectricSupply": { "DayConsumption": { "Amount": 20000 }, "NightConsumption": { "Amount": 10000 }, "MPANTop": "04811661", "MPANBottom": "1600000000000", "StandardSettlementConfig": "0151", "ContractEndDate": "2026-12-31", "SmartMeter": false }, "PostCode": "M1 1AA", "CurrentSupplier": "Haven Power", "PaymentMethod": "Monthly Direct Debit", "Uplift": 0.5, "StandingChargeUplift": 0, "QuoteDefinitions": [ { "Supplier": "British Gas", "Plans": [ { "Id": 1, "Duration": 12, "Pricebook": "Fixed", "StandingChargeType": "Standard", "IsRenewable": false }, { "Id": 2, "Duration": 24, "Pricebook": "Fixed", "StandingChargeType": "Standard", "IsRenewable": true, "Uplift": 1.0 } ] }, { "Supplier": "EDF", "Plans": [ { "Id": 3, "Duration": 36 } ] } ], "Settings": [ { "key": "ShowNoQuoteReason", "value": "true" } ] } } }, "returnAllProducts": { "summary": "Return all products", "value": { "quoteDetails": { "QuoteReference": "ACME-0002", "SecurityDetails": { "LicenceCode": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", "mascaradeuser": "Test User" }, "ElectricSupply": { "DayConsumption": { "Amount": 20000 }, "NightConsumption": { "Amount": 10000 }, "MPANTop": "04811661", "MPANBottom": "1600000000000", "StandardSettlementConfig": "0151", "ContractEndDate": "2026-12-31" }, "PostCode": "M1 1AA", "CurrentSupplier": "Haven Power", "PaymentMethod": "Monthly Direct Debit", "Uplift": 0.5, "QuoteDefinitions": [ { "Supplier": "British Gas", "Plans": [ { "Id": 1, "ReturnAllProducts": true } ] }, { "Supplier": "EDF", "Plans": [ { "Id": 2, "ReturnAllProducts": true, "Duration": 24, "StandingChargeType": "Standard" } ] } ], "Settings": [ { "key": "ShowNoQuoteReason", "value": "true" } ] } } }, "mhhsMigrated": { "summary": "MHHS-migrated meter with ForcedRateStructure", "value": { "quoteDetails": { "QuoteReference": "ACME-0003", "SecurityDetails": { "LicenceCode": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", "mascaradeuser": "Test User" }, "ElectricSupply": { "DayConsumption": { "Amount": 20000 }, "NightConsumption": { "Amount": 10000 }, "MPANBottom": "1600000000000", "MhhsMigrated": true, "ProfileClass": 4, "MeterTimeswitchClass": 811, "LineLossFactorClass": "661", "DuosTariffId": "661", "ForcedRateStructure": "Economy7", "ContractEndDate": "2026-12-31" }, "PostCode": "M1 1AA", "PaymentMethod": "Monthly Direct Debit", "Uplift": 0.5, "QuoteDefinitions": [ { "Supplier": "British Gas", "Plans": [ { "Id": 1, "Duration": 12 } ] } ], "Settings": [ { "key": "ShowNoQuoteReason", "value": "true" } ] } } }, "halfHourly": { "summary": "Half-hourly meter", "value": { "quoteDetails": { "QuoteReference": "ACME-0004", "SecurityDetails": { "LicenceCode": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", "mascaradeuser": "Test User" }, "ElectricSupply": { "DayConsumption": { "Amount": 180000 }, "NightConsumption": { "Amount": 70000 }, "KvaConsumption": { "Amount": 120 }, "KvarhConsumption": { "Amount": 15000 }, "MPANTop": "00845661", "MPANBottom": "1600000000000", "MeasurementClass": "C", "ContractEndDate": "2026-12-31" }, "PostCode": "M1 1AA", "PaymentMethod": "Monthly Direct Debit", "Uplift": 0.5, "QuoteDefinitions": [ { "Supplier": "British Gas", "Plans": [ { "Id": 1, "Duration": 12, "HalfHourlyNumberOfRates": 2, "IncludeMOPCharges": true } ] } ], "Settings": [ { "key": "ShowNoQuoteReason", "value": "true" } ] } } }, "advancedMeter": { "summary": "Advanced meter (MarketSegment and ConnectionType)", "value": { "quoteDetails": { "QuoteReference": "ACME-0006", "SecurityDetails": { "LicenceCode": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", "mascaradeuser": "Test User" }, "ElectricSupply": { "DayConsumption": { "Amount": 180000 }, "NightConsumption": { "Amount": 70000 }, "KvaConsumption": { "Amount": 120 }, "KvarhConsumption": { "Amount": 15000 }, "MPANBottom": "1600000000000", "MhhsMigrated": true, "MarketSegment": "A", "ConnectionType": "L", "LineLossFactorClass": "661", "DuosTariffId": "661", "ContractEndDate": "2026-12-31" }, "PostCode": "M1 1AA", "PaymentMethod": "Monthly Direct Debit", "Uplift": 0.5, "QuoteDefinitions": [ { "Supplier": "British Gas", "Plans": [ { "Id": 1, "Duration": 12, "HalfHourlyNumberOfRates": 2, "IncludeMOPCharges": true } ] } ], "Settings": [ { "key": "ShowNoQuoteReason", "value": "true" } ] } } } } } }, "required": true }, "responses": { "default": { "description": "not available", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetElectricRatesResultWrapper" }, "example": { "GetElectricRatesResult": { "Rates": [ { "Supplier": "British Gas", "Term": "12", "StandingCharge": "45.00", "DayUnitrate": "24.10", "NightUnitrate": "18.30", "AnnualPrice": "£6,833.25", "RawAnnualPrice": 6833.25, "BaseAnnualPrice": "£6,833.25", "RawBaseAnnualPrice": 6833.25, "Uplift": "0.5", "StandingChargeUplift": "0", "Renewal": false, "RawCommission": 150.0, "Commission": "£150.00", "OutsidePricingWindow": false, "ContractEndDate": "2027-12-31", "Id": 1, "Pricebook": "Fixed", "IsRenewable": false, "StandingChargeType": "standard", "PaymentMethod": { "Type": "Direct Debit", "Frequency": "Monthly", "Amount": "Fixed", "DisplayName": "Monthly Direct Debit" } }, { "Supplier": "British Gas", "Term": "24", "StandingCharge": "45.00", "DayUnitrate": "24.60", "NightUnitrate": "18.80", "AnnualPrice": "£7,033.25", "RawAnnualPrice": 7033.25, "BaseAnnualPrice": "£7,033.25", "RawBaseAnnualPrice": 7033.25, "Uplift": "0.5", "StandingChargeUplift": "0", "Renewal": false, "RawCommission": 300.0, "Commission": "£300.00", "OutsidePricingWindow": false, "ContractEndDate": "2028-12-31", "Id": 2, "Pricebook": "Fixed", "IsRenewable": true, "StandingChargeType": "standard", "PaymentMethod": { "Type": "Direct Debit", "Frequency": "Monthly", "Amount": "Fixed", "DisplayName": "Monthly Direct Debit" } }, { "Supplier": "EDF", "Term": "36", "Id": 3, "NoQuoteReason": "No prices available for the requested duration." } ], "Reference": "ACME-0001" } } } } } }, "x-codegen-request-body-name": "GetElectricRatesWrapper" } }, "/gasprices": { "post": { "summary": "Fetch gas prices", "description": "Returns a collection of gas Rate Information for a given set of gas suppliers and settings.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetGasRates" }, "examples": { "standard": { "summary": "Standard quote", "value": { "quoteDetails": { "QuoteReference": "ACME-0010", "SecurityDetails": { "LicenceCode": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", "mascaradeuser": "Test User" }, "GasSupply": { "Consumption": { "Amount": 50000 }, "MPR": "1234567890", "ContractEndDate": "2026-12-31", "SmartMeter": false }, "PostCode": "M1 1AA", "CurrentSupplier": "CNG", "PaymentMethod": "Monthly Direct Debit", "Uplift": 0.5, "QuoteDefinitions": [ { "Supplier": "British Gas", "Plans": [ { "Id": 1, "Duration": 12, "Pricebook": "Fixed", "StandingChargeType": "Standard" }, { "Id": 2, "EndDate": "2028-06-30" } ] } ], "Settings": [ { "key": "ShowNoQuoteReason", "value": "true" } ] } } }, "returnAllProducts": { "summary": "Return all products", "value": { "quoteDetails": { "QuoteReference": "ACME-0011", "SecurityDetails": { "LicenceCode": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", "mascaradeuser": "Test User" }, "GasSupply": { "Consumption": { "Amount": 50000 }, "MPR": "1234567890", "ContractEndDate": "2026-12-31", "SmartMeter": false }, "PostCode": "M1 1AA", "CurrentSupplier": "CNG", "PaymentMethod": "Monthly Direct Debit", "Uplift": 0.5, "QuoteDefinitions": [ { "Supplier": "British Gas", "Plans": [ { "Id": 1, "ReturnAllProducts": true } ] } ], "Settings": [ { "key": "ShowNoQuoteReason", "value": "true" } ] } } } } } }, "required": true }, "responses": { "default": { "description": "not available", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetGasRatesResultWrapper" }, "example": { "GetGasRatesResult": { "Rates": [ { "Supplier": "British Gas", "Term": "12", "StandingCharge": "30.00", "DayUnitrate": "6.10", "AnnualPrice": "£3,159.50", "RawAnnualPrice": 3159.5, "BaseAnnualPrice": "£3,159.50", "RawBaseAnnualPrice": 3159.5, "Uplift": "0.5", "StandingChargeUplift": "0", "Renewal": false, "RawCommission": 250.0, "Commission": "£250.00", "OutsidePricingWindow": false, "ContractEndDate": "2027-12-31", "Id": 1, "Pricebook": "Fixed", "StandingChargeType": "standard", "PaymentMethod": { "Type": "Direct Debit", "Frequency": "Monthly", "Amount": "Fixed", "DisplayName": "Monthly Direct Debit" } } ], "Reference": "ACME-0010" } } } } } }, "x-codegen-request-body-name": "GetGasRatesWrapper" } }, "/ping": { "get": { "responses": { "default": { "description": "not available", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PingResultWrapper" }, "example": { "PingResult": "pong" } } } } }, "summary": "Ping", "description": "Health check. Returns \"pong\" if the service is reachable." } }, "/pricechange": { "post": { "summary": "Fetch price change history", "description": "Returns a collection of price change information, detailing the most recent price change for each supplier, utility, duration, and product. This does not guarantee that each particular product is available to price, as it may have expired.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLatestPriceChange" }, "examples": { "supplier": { "summary": "Latest price changes for a supplier", "value": { "priceChangeRequest": { "SecurityDetails": { "LicenceCode": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", "mascaradeuser": "Test User" }, "SupplierName": "British Gas", "IncludeFuture": false } } } } } }, "required": true }, "responses": { "default": { "description": "not available", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLatestPriceChangeResultWrapper" }, "example": { "GetLatestPriceChangeResult": { "PriceChanges": [ { "Supplier": "British Gas", "Utility": "electric", "HalfHourly": false, "Duration": 12, "Product": "Fixed", "Description": "Fixed 12 months", "Version": "2026-09", "LastPriceChange": "2026-09-30" }, { "Supplier": "British Gas", "Utility": "gas", "HalfHourly": false, "Duration": 24, "Product": "Fixed", "Description": "Fixed 24 months", "Version": "2026-09", "LastPriceChange": "2026-09-30" } ] } } } } } }, "x-codegen-request-body-name": "GetLatestPriceChangeWrapper" } }, "/prompts": { "post": { "summary": "Rate Structure Lookup", "description": "Returns the structure that the requested electric meter will price on for the suppliers given. If no suppliers are specified, the result will describe the maximum number of rates that can come back, taking all suppliers into account. A meter detected as half-hourly always returns a fixed 2-rate (Day/Night) result; use /ratestructuredata for HH/advanced meter details.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetNumberOfPrompts" }, "examples": { "legacyTopLine": { "summary": "Legacy MPAN Top Line", "value": { "promptsSearch": { "MPANTop": "04811661", "MPANBottom": "1600000000000", "StandardSettlementConfig": "0151", "Suppliers": [ "British Gas", "EDF" ], "SecurityDetails": { "LicenceCode": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", "mascaradeuser": "Test User" } } } }, "mhhsMigrated": { "summary": "MHHS-migrated meter elements", "value": { "promptsSearch": { "MPANBottom": "1600000000000", "MhhsMigrated": true, "ProfileClass": 4, "MeterTimeswitchClass": 811, "LineLossFactorClass": "661", "DuosTariffId": "661", "SecurityDetails": { "LicenceCode": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", "mascaradeuser": "Test User" } } } }, "advancedMeter": { "summary": "Advanced (HH) meter", "value": { "promptsSearch": { "MPANBottom": "1600000000000", "MhhsMigrated": true, "MarketSegment": "A", "ConnectionType": "L", "LineLossFactorClass": "661", "DuosTariffId": "661", "SecurityDetails": { "LicenceCode": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", "mascaradeuser": "Test User" } } } } } } }, "required": true }, "responses": { "default": { "description": "not available", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetNumberOfPromptsResultWrapper" }, "example": { "GetNumberOfPromptsResult": { "NumberOfPrompts": 2, "ThePrompts": [ "Day", "Night" ] } } } } } }, "x-codegen-request-body-name": "GetNumberOfPromptsWrapper" } }, "/ratestructuredata": { "post": { "summary": "Rate Structure Data Lookup", "description": "Returns the RateStructure, VoltageType and MeteringSystem that the given electric meter will be quoted on. The Aggregate result covers all suppliers (or only those listed in Suppliers); SupplierSpecific gives a breakdown per requested supplier, as some suppliers differ. Meter elements not supplied directly are extracted from the MPAN Top Line where present.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRateStructureData" }, "examples": { "withSuppliers": { "summary": "Rate structure for specific suppliers", "value": { "rateStructureSearch": { "MpanTopLine": "04811661", "MpanBottomLine": "1600000000000", "StandardSettlementConfig": "0151", "Suppliers": [ "British Gas", "EDF" ], "SecurityDetails": { "LicenceCode": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", "mascaradeuser": "Test User" } } } }, "advancedMeter": { "summary": "Advanced (HH) meter", "value": { "rateStructureSearch": { "MpanBottomLine": "1600000000000", "MhhsMigrated": true, "MarketSegment": "A", "ConnectionType": "L", "LineLossFactorClass": "661", "DuosTariffId": "661", "SecurityDetails": { "LicenceCode": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", "mascaradeuser": "Test User" } } } } } } }, "required": true }, "responses": { "default": { "description": "not available", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRateStructureDataResultWrapper" }, "example": { "GetRateStructureDataResult": { "Aggregate": { "RateStructure": "Economy7", "MeteringSystem": "WC", "RateDescriptions": [ "Day", "Night" ], "LegacyHalfHourlyOrAdvanced": false }, "SupplierSpecific": [ { "Key": "British Gas", "Value": { "RateStructure": "Economy7", "MeteringSystem": "WC", "RateDescriptions": [ "Day", "Night" ], "LegacyHalfHourlyOrAdvanced": false } }, { "Key": "EDF", "Value": { "RateStructure": "Economy7", "MeteringSystem": "WC", "RateDescriptions": [ "Day", "Night" ], "LegacyHalfHourlyOrAdvanced": false } } ], "LegacyHalfHourlyOrAdvancedIncluded": false, "NonLegacyHalfHourlyOrAdvancedIncluded": true, "CurrentTransformerIncluded": false, "NonCurrentTransformerIncluded": true, "AllIncludedRateDescriptions": [ "Day", "Night" ] } } } } } }, "x-codegen-request-body-name": "GetRateStructureDataWrapper" } } }, "components": { "schemas": { "Consumption": { "type": "object", "properties": { "Amount": { "type": "number", "format": "int", "example": 30000 } }, "format": "Consumption" }, "ElectricSupply": { "type": "object", "properties": { "DayConsumption": { "$ref": "#/components/schemas/Consumption" }, "NightConsumption": { "$ref": "#/components/schemas/Consumption" }, "WendConsumption": { "$ref": "#/components/schemas/Consumption" }, "KvaConsumption": { "$ref": "#/components/schemas/Consumption" }, "KvarhConsumption": { "$ref": "#/components/schemas/Consumption" }, "MPANTop": { "maxLength": 9, "minLength": 8, "type": "string", "example": "040151661" }, "MPANBottom": { "maxLength": 13, "minLength": 13, "type": "string", "example": "1600000000000" }, "MeasurementClass": { "type": "string", "example": "A" }, "MeterType": { "type": "string" }, "ContractRenewalDate": { "type": "string", "format": "date", "example": "2020-09-20" }, "ContractEndDate": { "type": "string", "format": "date" }, "NewContractEndDate": { "type": "string", "format": "date" }, "CurrentSupplier": { "type": "string", "example": "Haven Power" }, "SmartMeter": { "type": "boolean", "default": false }, "StandardSettlementConfig": { "type": "string", "example": "0151" }, "MhhsMigrated": { "type": "boolean", "nullable": true, "description": "Whether the meter has migrated to MHHS. Determines how the MPAN Top Line is interpreted." }, "DuosTariffId": { "type": "string", "example": "661" }, "ProfileClass": { "type": "integer", "format": "int32", "example": 4 }, "MeterTimeswitchClass": { "type": "integer", "format": "int32", "example": 811 }, "LineLossFactorClass": { "maxLength": 3, "minLength": 0, "type": "string", "example": "661" }, "MarketSegment": { "type": "string", "description": "MHHS Market Segment of the meter, e.g. \"A\" = Advanced. Used with ConnectionType to determine half-hourly/advanced status and MeteringSystem.", "example": "A" }, "ConnectionType": { "type": "string", "enum": [ "W", "L", "H", "E" ], "description": "MHHS Connection Type: W = Whole Current, L = LV Current Transformer, H = HV Current Transformer, E = EHV Current Transformer. Used with MarketSegment to determine half-hourly/advanced status and MeteringSystem.", "example": "L" }, "ForcedRateStructure": { "type": "string", "enum": [ "Standard", "Economy7", "EveningAndWeekend", "EveningWeekendAndNight", "OffPeak" ], "description": "Forces the rate structure to quote on. Applicable for MHHS-migrated meters where StandardSettlementConfig is empty. Only some suppliers support pricing via this method." } }, "format": "ElectricSupply" }, "Error": { "type": "object", "properties": { "Message": { "type": "string" }, "ErrorDetail": { "type": "string" } }, "format": "Error", "nullable": true }, "GasSupply": { "type": "object", "properties": { "Consumption": { "$ref": "#/components/schemas/Consumption" }, "MPR": { "type": "string", "example": "123567890" }, "ContractRenewalDate": { "type": "string", "format": "date", "example": "2020-09-12" }, "ContractEndDate": { "type": "string", "format": "date" }, "NewContractEndDate": { "type": "string", "format": "date" }, "CurrentSupplier": { "type": "string", "example": "CNG" }, "SmartMeter": { "type": "boolean", "default": false } }, "format": "GasSupply" }, "GetElectricRates": { "type": "object", "properties": { "quoteDetails": { "$ref": "#/components/schemas/QuoteDetails" } }, "format": "GetElectricRates" }, "GetElectricRatesResultWrapper": { "type": "object", "properties": { "GetElectricRatesResult": { "$ref": "#/components/schemas/QuoteResult" } }, "format": "GetElectricRatesResultWrapper" }, "GetGasRates": { "type": "object", "properties": { "quoteDetails": { "$ref": "#/components/schemas/QuoteDetails" } }, "format": "GetGasRates" }, "GetGasRatesResultWrapper": { "type": "object", "properties": { "GetGasRatesResult": { "$ref": "#/components/schemas/QuoteResult" } }, "format": "GetGasRatesResultWrapper" }, "GetLatestPriceChange": { "type": "object", "properties": { "priceChangeRequest": { "$ref": "#/components/schemas/PriceChangeRequest" } }, "format": "GetLatestPriceChange" }, "GetLatestPriceChangeResultWrapper": { "type": "object", "properties": { "GetLatestPriceChangeResult": { "$ref": "#/components/schemas/PriceChangeResult" } }, "format": "GetLatestPriceChangeResultWrapper" }, "LatestPriceChange": { "type": "object", "properties": { "Supplier": { "type": "string", "example": "British Gas" }, "Utility": { "type": "string", "enum": [ "electric", "gas" ] }, "HalfHourly": { "type": "boolean" }, "Duration": { "type": "integer", "format": "int32" }, "Product": { "type": "string" }, "Description": { "type": "string" }, "Version": { "type": "string" }, "LastPriceChange": { "type": "string", "format": "date" } }, "format": "LatestPriceChange" }, "PingResultWrapper": { "type": "object", "properties": { "PingResult": { "type": "string" } }, "format": "PingResultWrapper" }, "Plan": { "type": "object", "properties": { "Duration": { "type": "integer", "format": "int32", "nullable": true, "description": "Contract length. Values below 6 are treated as years, otherwise months. Specify either Duration or EndDate, not both (neither is required when ReturnAllProducts is true).", "example": 12 }, "EndDate": { "type": "string", "format": "date", "description": "Desired contract end date. Specify either Duration or EndDate, not both. Cannot be combined with a supply-level NewContractEndDate." }, "Pricebook": { "type": "string", "description": "Supplier pricebook/product to quote. Multiple products may be combined with a pipe, e.g. \"Live Pricing|SingleRate\".", "example": "Fixed" }, "IsRenewable": { "type": "boolean", "nullable": true, "description": "Whether a renewable energy product is required. Supplier default applies when omitted." }, "StandingChargeType": { "type": "string", "enum": [ "None", "Low", "Standard" ], "description": "Type of standing charge required (case-insensitive). Supplier default applies when omitted." }, "IncludeMOPCharges": { "type": "boolean", "nullable": true, "description": "Whether Meter Operator (MOP) charges should be included. Supplier default applies when omitted." }, "HalfHourlyNumberOfRates": { "type": "integer", "format": "int32", "nullable": true, "minimum": 1, "maximum": 4, "description": "Number of unit rates for a half-hourly meter (1 (STD), 2 (E7), 3(EWN), or 4(EWE). Supplier default applies when omitted." }, "PaymentMethod": { "type": "string", "description": "Payment method for this plan. Overrides QuoteDetails.PaymentMethod.", "example": "Monthly Direct Debit" }, "ReturnAllProducts": { "type": "boolean", "default": false, "description": "When true, returns every valid product currently in effect for the supplier instead of a single plan. Any other product properties set on the plan (Duration, EndDate, Pricebook, IsRenewable, StandingChargeType, IncludeMOPCharges, HalfHourlyNumberOfRates, PaymentMethod) act as filters on the results. PlanType is ignored. All returned rates share this plan's Id." }, "Uplift": { "type": "number", "format": "decimal", "example": 0.5, "description": "Unit rate uplift (p/kWh). Overrides QuoteDetails.Uplift." }, "StandingChargeUplift": { "type": "number", "format": "decimal", "description": "Standing charge uplift (p/day). Overrides QuoteDetails.StandingChargeUplift." }, "Id": { "type": "integer", "format": "int32", "nullable": true, "description": "Optional identifier, returned on each Rate produced by this plan." } }, "format": "Plan" }, "PriceChangeRequest": { "type": "object", "properties": { "SecurityDetails": { "$ref": "#/components/schemas/SecurityDetails" }, "SupplierName": { "type": "string", "example": "British Gas" }, "IncludeFuture": { "type": "boolean", "default": false } }, "format": "PriceChangeRequest" }, "PriceChangeResult": { "type": "object", "properties": { "PriceChanges": { "type": "array", "items": { "$ref": "#/components/schemas/LatestPriceChange" } } }, "format": "PriceChangeResult" }, "QuoteDefinition": { "type": "object", "properties": { "Supplier": { "type": "string", "example": "British Gas" }, "Plans": { "type": "array", "items": { "$ref": "#/components/schemas/Plan" } } }, "format": "QuoteDefinition" }, "QuoteDetails": { "type": "object", "properties": { "QuoteReference": { "type": "string" }, "SecurityDetails": { "$ref": "#/components/schemas/SecurityDetails" }, "GasSupply": { "$ref": "#/components/schemas/GasSupply" }, "ElectricSupply": { "$ref": "#/components/schemas/ElectricSupply" }, "PostCode": { "type": "string" }, "Renewal": { "type": "boolean", "default": false }, "CurrentSupplier": { "type": "string" }, "COT": { "type": "boolean", "default": false }, "CotDate": { "type": "string" }, "OutOfContract": { "type": "boolean", "default": false }, "Uplift": { "type": "number", "format": "decimal" }, "StandingChargeUplift": { "type": "number", "format": "decimal" }, "PaymentMethod": { "type": "string", "description": "The value must match against possible types: Direct Debit, BACS, or Cash/Cheque. It can also include frequency (Monthly/Quarterly) and amount (Fixed/Variable). The value restricts which prices will return based on the suppliers' rules.", "example": "Monthly Direct Debit" }, "QuoteDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteDefinition" } }, "Settings": { "$ref": "#/components/schemas/Settings" }, "SortByCommission": { "type": "boolean", "default": false }, "BusinessType": { "type": "string" }, "ExistingSupplyId": { "type": "string", "description": "Unique reference for the supply provided by the current supplier. Required by some suppliers for renewal pricing." }, "CurrentRates": { "$ref": "#/components/schemas/CurrentRates" } }, "format": "QuoteDetails" }, "QuoteResult": { "type": "object", "properties": { "Rates": { "type": "array", "items": { "$ref": "#/components/schemas/Rate" } }, "Reference": { "type": "string" }, "FooterNotes": { "type": "string" }, "Error": { "$ref": "#/components/schemas/Error" } }, "format": "QuoteResult" }, "Rate": { "type": "object", "properties": { "Supplier": { "type": "string", "example": "British Gas" }, "Term": { "type": "string", "example": "12" }, "StandingCharge": { "type": "string", "example": "32.00" }, "DayUnitrate": { "type": "string", "example": "13.84" }, "NightUnitrate": { "type": "string", "example": "11.45" }, "WendUnitrate": { "type": "string" }, "Fits": { "type": "string" }, "Stod1": { "type": "string" }, "Stod2": { "type": "string" }, "Stod3": { "type": "string" }, "Stod4": { "type": "string" }, "Stod5": { "type": "string" }, "Stod6": { "type": "string" }, "DirectDebitDiscount": { "type": "string" }, "FlatDirectDebitDiscount": { "type": "number", "format": "decimal" }, "ChequeSurcharge": { "type": "string" }, "ExtraInfo": { "type": "string" }, "FooterMessage": { "type": "string" }, "TariffCode": { "type": "string" }, "AnnualPrice": { "type": "string", "example": "£4,269.23" }, "RawAnnualPrice": { "type": "number", "format": "decimal", "example": 4269.2327985 }, "BaseAnnualPrice": { "type": "string", "example": "£4,269.23" }, "RawBaseAnnualPrice": { "type": "number", "format": "decimal", "example": 4269.2327985 }, "AnnualPriceInclusive": { "type": "string", "example": "£5,415.04" }, "RawAnnualPriceInclusive": { "type": "number", "format": "decimal", "example": 5415.0393582 }, "Ref": { "type": "string" }, "Period": { "type": "string" }, "SC": { "type": "string" }, "CapacityCharge": { "type": "string" }, "ReactiveRate": { "type": "string" }, "ExcessCapacityCharge": { "type": "string" }, "Uplift": { "type": "string", "example": "0.5" }, "FixedFee": { "type": "string" }, "FixedFeeUplift": { "type": "string" }, "FixedFeeSCUplift": { "type": "string" }, "StandingChargeUplift": { "type": "string", "example": "0" }, "Renewal": { "type": "boolean" }, "RawCommission": { "type": "number", "format": "decimal" }, "Commission": { "type": "string" }, "OutsidePricingWindow": { "type": "boolean" }, "NoQuoteReason": { "type": "string" }, "ContractEndDate": { "type": "string" }, "TransportationCharge": { "type": "string" }, "PricebookVersion": { "type": "string" }, "QuoteRateReference": { "type": "string" }, "Id": { "type": "integer", "format": "int32", "description": "The Id of the Plan that produced this rate." }, "PaymentMethod": { "$ref": "#/components/schemas/PaymentMethodDetail" }, "Pricebook": { "type": "string", "description": "Pricebook/product of the returned rate. Multiple products are pipe-separated." }, "IsRenewable": { "type": "boolean", "nullable": true }, "StandingChargeType": { "type": "string", "enum": [ "none", "low", "standard" ] }, "IncludeMOPCharges": { "type": "boolean", "nullable": true }, "HalfHourlyNumberOfRates": { "type": "integer", "format": "int32", "nullable": true }, "SupplierData": { "type": "array", "description": "Bespoke data relevant to this supplier.", "items": { "$ref": "#/components/schemas/KeyValue" } } }, "format": "Rate" }, "SecurityDetails": { "type": "object", "properties": { "LicenceCode": { "type": "string", "example": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA" }, "mascaradeuser": { "type": "string", "example": "Test User" } }, "format": "SecurityDetails" }, "Settings": { "type": "array", "items": { "$ref": "#/components/schemas/Setting" } }, "Setting": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "example": { "key": "ShowNoQuoteReason", "value": "true" } }, "Prompts": { "type": "object", "properties": { "NumberOfPrompts": { "type": "integer", "format": "int32", "example": 2 }, "ThePrompts": { "type": "array", "example": [ "Day", "Night" ], "items": { "type": "string" } }, "Error": { "$ref": "#/components/schemas/Error" } }, "format": "Prompts" }, "PromptsSearch": { "type": "object", "properties": { "MPANTop": { "maxLength": 9, "minLength": 8, "type": "string", "example": "04811661" }, "MPANBottom": { "maxLength": 13, "minLength": 13, "type": "string", "example": "1600000000000" }, "StandardSettlementConfig": { "type": "string", "example": "0316" }, "MhhsMigrated": { "type": "boolean", "nullable": true }, "DuosTariffId": { "type": "string", "example": "661" }, "ProfileClass": { "type": "integer", "format": "int32", "example": 4 }, "MeterTimeswitchClass": { "type": "integer", "format": "int32", "example": 811 }, "LineLossFactorClass": { "maxLength": 3, "minLength": 3, "type": "string", "example": "661" }, "MarketSegment": { "type": "string", "description": "MHHS Market Segment of the meter, e.g. \"A\" = Advanced. Used with ConnectionType to determine half-hourly/advanced status and MeteringSystem.", "example": "A" }, "ConnectionType": { "type": "string", "enum": [ "W", "L", "H", "E" ], "description": "MHHS Connection Type: W = Whole Current, L = LV Current Transformer, H = HV Current Transformer, E = EHV Current Transformer. Used with MarketSegment to determine half-hourly/advanced status and MeteringSystem.", "example": "L" }, "Suppliers": { "type": "array", "example": [ "British Gas", "Opus Energy" ], "items": { "type": "string" } }, "SecurityDetails": { "$ref": "#/components/schemas/SecurityDetails" } }, "format": "PromptsSearch" }, "GetNumberOfPrompts": { "type": "object", "properties": { "promptsSearch": { "$ref": "#/components/schemas/PromptsSearch" } }, "format": "GetNumberOfPrompts" }, "GetNumberOfPromptsResultWrapper": { "type": "object", "properties": { "GetNumberOfPromptsResult": { "$ref": "#/components/schemas/Prompts" } }, "format": "GetNumberOfPromptsResultWrapper" }, "CurrentRates": { "type": "object", "description": "The customer's current rates. Required by some suppliers (e.g. for renewal pricing).", "properties": { "StandingCharge": { "type": "number", "format": "decimal", "nullable": true }, "DayOrUnitRate": { "type": "number", "format": "decimal", "nullable": true }, "NightRate": { "type": "number", "format": "decimal", "nullable": true }, "EveningWeekendRate": { "type": "number", "format": "decimal", "nullable": true }, "CapacityCharge": { "type": "number", "format": "decimal", "nullable": true }, "ReactiveRate": { "type": "number", "format": "decimal", "nullable": true } } }, "PaymentMethodDetail": { "type": "object", "description": "Payment method of the returned rate.", "properties": { "Type": { "type": "string", "example": "Direct Debit" }, "Frequency": { "type": "string", "example": "Monthly" }, "Amount": { "type": "string", "example": "Fixed" }, "DisplayName": { "type": "string", "example": "Monthly Direct Debit" } } }, "KeyValue": { "type": "object", "properties": { "Key": { "type": "string" }, "Value": {} } }, "RateStructureSearch": { "type": "object", "required": [ "MpanBottomLine", "SecurityDetails" ], "properties": { "MpanTopLine": { "maxLength": 9, "minLength": 8, "type": "string", "example": "04811661" }, "MpanBottomLine": { "maxLength": 13, "minLength": 13, "type": "string", "example": "1600000000000" }, "ProfileClass": { "type": "integer", "format": "int32", "nullable": true, "example": 4 }, "MeterTimeswitchClass": { "type": "integer", "format": "int32", "nullable": true, "example": 811 }, "LineLossFactorClass": { "maxLength": 3, "minLength": 0, "type": "string", "example": "661" }, "StandardSettlementConfig": { "type": "string", "example": "0316" }, "DuosTariffId": { "type": "string", "example": "661" }, "MhhsMigrated": { "type": "boolean", "nullable": true }, "MarketSegment": { "type": "string", "description": "MHHS Market Segment of the meter, e.g. \"A\" = Advanced. Used with ConnectionType to determine half-hourly/advanced status and MeteringSystem.", "example": "A" }, "ConnectionType": { "type": "string", "enum": [ "W", "L", "H", "E" ], "description": "MHHS Connection Type: W = Whole Current, L = LV Current Transformer, H = HV Current Transformer, E = EHV Current Transformer. Used with MarketSegment to determine half-hourly/advanced status and MeteringSystem.", "example": "L" }, "Suppliers": { "type": "array", "description": "Optional. Limits the results to these suppliers and returns a SupplierSpecific breakdown for each.", "example": [ "British Gas", "Opus Energy" ], "items": { "type": "string" } }, "SecurityDetails": { "$ref": "#/components/schemas/SecurityDetails" } } }, "RateStructureData": { "type": "object", "properties": { "RateStructure": { "type": "string", "example": "Economy7", "nullable": true, "description": "Rate structure for a non half-hourly meter. Null for half-hourly/advanced meters." }, "RateStructureAndBand": { "type": "string", "nullable": true }, "VoltageType": { "type": "string", "nullable": true, "description": "Voltage type for a half-hourly/advanced meter. Null for non half-hourly meters.", "example": "LV HH Metered Band 1" }, "VoltageTypeAndBand": { "type": "string", "nullable": true }, "BandDescription": { "type": "string", "nullable": true, "example": "Band 1" }, "MeteringSystem": { "type": "string", "enum": [ "WC", "CT" ], "description": "WC = whole current, CT = current transformer.", "nullable": true }, "RateDescriptions": { "type": "array", "items": { "type": "string" }, "example": [ "Day", "Night" ], "description": "Rate names for a non half-hourly meter, e.g. Day/Night. Empty for half-hourly/advanced meters." }, "LegacyHalfHourlyOrAdvanced": { "type": "boolean", "nullable": true } } }, "SupplierRateStructureData": { "type": "object", "properties": { "Key": { "type": "string", "description": "Supplier name", "example": "British Gas" }, "Value": { "$ref": "#/components/schemas/RateStructureData" } } }, "RateStructureLookupResult": { "type": "object", "properties": { "Aggregate": { "$ref": "#/components/schemas/RateStructureData" }, "SupplierSpecific": { "type": "array", "nullable": true, "description": "Present only when Suppliers were specified in the request.", "items": { "$ref": "#/components/schemas/SupplierRateStructureData" } }, "LegacyHalfHourlyOrAdvancedIncluded": { "type": "boolean", "description": "At least one applicable supplier treats the meter as legacy half-hourly/advanced." }, "NonLegacyHalfHourlyOrAdvancedIncluded": { "type": "boolean", "description": "At least one applicable supplier treats the meter as non half-hourly/advanced." }, "CurrentTransformerIncluded": { "type": "boolean", "description": "At least one applicable supplier treats the meter as CT metered." }, "NonCurrentTransformerIncluded": { "type": "boolean", "description": "At least one applicable supplier treats the meter as whole current." }, "AllIncludedRateDescriptions": { "type": "array", "items": { "type": "string" } } } }, "GetRateStructureData": { "type": "object", "properties": { "rateStructureSearch": { "$ref": "#/components/schemas/RateStructureSearch" } } }, "GetRateStructureDataResultWrapper": { "type": "object", "properties": { "GetRateStructureDataResult": { "$ref": "#/components/schemas/RateStructureLookupResult" } } } } } }