Skip to content

Create quote

Returns a quote request with quoted products that are available in the given postcode.

Authentication required

Requires CAN_CREATE_ELECTRICITY_QUOTE permission.

Arguments

Returns

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
mutation createQuote($input:CreateQuoteInput!){
    createQuote(input:$input){
        quote{
            quoteId
            code
            quotedProducts{
                product{
                        code
                        displayName
                        description
                        fullName
                        id
                        term

                    }
                estimatedDetails{
                    kwhUsage
                    dayPercentage
                    nightPercentage
                    usagePeriod
                    monthlyCostEstimate
                    annualCostEstimate
                    applicableRates{
                        totalApplicableRate
                        totalApplicableRateWithMonthlySubscriptionFees
                        kwhUsage
                        serviceProvider
                        serviceProviderConsumptionRate
                        serviceProviderStandingRate
                        loadZone
                        totalApplicableDayRate
                        totalApplicableNightRate
                        totalApplicableDayRateWithMonthlySubscriptionFees
                        totalApplicableNightRateWithMonthlySubscriptionFees
                        loadZoneDayTimeConsumptionRate
                        loadZoneNightTimeConsumptionRate
                        loadZoneConsumptionRate
                        serviceProviderStandingRateUnitType
                        serviceProviderConsumptionRateUnitType
                        loadZoneDayTimeRateUnitType
                        loadZoneNightTimeRateUnitType
                        loadZoneConsumptionRateUnitType
                        __typename
                    }
                }
                expiresAt
                loadZone
                serviceProvider
            }
        }
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Input variables
{
    "input": {
        "postCode": STRING,
        "paymentMethod": PaymentMethods,
        "extraCriteria": {
            "kwhConsumption": DECIMAL,
            "kwhUsagePeriod": ESTIMATION_INTERVAL
        }
    }
}

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
mutation createQuote($input:CreateQuoteInput!){
    createQuote(input:$input){
        quote{
            quoteId
            code
            quotedProducts{
                product{
                        code
                        displayName
                        description
                        fullName
                        id
                        term

                    }
                estimatedDetails{
                    kwhUsage
                    dayPercentage
                    nightPercentage
                    usagePeriod
                    monthlyCostEstimate
                    annualCostEstimate
                    applicableRates{
                        totalApplicableRate
                        totalApplicableRateWithMonthlySubscriptionFees
                        kwhUsage
                        serviceProvider
                        serviceProviderConsumptionRate
                        serviceProviderStandingRate
                        loadZone
                        totalApplicableDayRate
                        totalApplicableNightRate
                        totalApplicableDayRateWithMonthlySubscriptionFees
                        totalApplicableNightRateWithMonthlySubscriptionFees
                        loadZoneDayTimeConsumptionRate
                        loadZoneNightTimeConsumptionRate
                        loadZoneConsumptionRate
                        serviceProviderStandingRateUnitType
                        serviceProviderConsumptionRateUnitType
                        loadZoneDayTimeRateUnitType
                        loadZoneNightTimeRateUnitType
                        loadZoneConsumptionRateUnitType
                        __typename
                    }
                }
                expiresAt
                loadZone
                serviceProvider
            }
        }
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Input variables
{
    "input": {
        "postCode": "77005",
        "paymentMethod": "DIRECT_DEBIT",
        "extraCriteria": {
            "kwhConsumption": 1000,
            "kwhUsagePeriod": "ANNUALLY"
        }
    }
}

{
  "data": {
    "createQuote": {
      "quote": {
        "quoteId": "1",
        "code": "f1361234d4-23144-4501-9d1f-27rrasver2a69ef",
        "quotedProducts": [
          {
            "product": {
              "code": "INTELLIGENT-OCTOPUS-12M",
              "displayName": "Intelligent Octopus 12",
              "description": "This product is based on a 1 cent discount from Octoplus 12M. Customers are offered this discounted rate when adding a smart device (ECOBEE smart thermostat) to their Octopus energy app and allowing Octopus Energy to pause their central heating/ cooling system.",
              "fullName": "Octo 12 with Intelligent Octopus",
              "id": "40",
              "term": 12
            },
            "estimatedDetails": {
              "kwhUsage": "1000",
              "dayPercentage": null,
              "nightPercentage": null,
              "usagePeriod": "ANNUALLY",
              "monthlyCostEstimate": "1750.3167",
              "annualCostEstimate": "21003.8000",
              "applicableRates": {
                "totalApplicableRate": "20.00380",
                "totalApplicableRateWithMonthlySubscriptionFees": "21.00380",
                "kwhUsage": "1000",
                "serviceProvider": "CENTERPOINT",
                "serviceProviderConsumptionRate": "4.94540",
                "serviceProviderStandingRate": "439.00000",
                "loadZone": "LZ_HOUSTON",
                "totalApplicableDayRate": null,
                "totalApplicableNightRate": null,
                "totalApplicableDayRateWithMonthlySubscriptionFees": null,
                "totalApplicableNightRateWithMonthlySubscriptionFees": null,
                "loadZoneDayTimeConsumptionRate": null,
                "loadZoneNightTimeConsumptionRate": null,
                "loadZoneConsumptionRate": "14.61940",
                "serviceProviderStandingRateUnitType": "MONTHS_ON_SUPPLY",
                "serviceProviderConsumptionRateUnitType": "KWH_CONSUMPTION",
                "loadZoneDayTimeRateUnitType": null,
                "loadZoneNightTimeRateUnitType": null,
                "loadZoneConsumptionRateUnitType": "KWH_CONSUMPTION",
                "__typename": "ConciseRatesOutput"
              }
            },
            "expiresAt": "2022-09-20T14:04:34.438000-05:00",
            "loadZone": "LZ_HOUSTON",
            "serviceProvider": "CENTERPOINT"
          },
          {
            "product": {
              "code": "OCTOGO-MTM-FIXED",
              "displayName": "OctoGo MTM",
              "description": "Month-to-month fixed rate",
              "fullName": "OctoGo MTM",
              "id": "34",
              "term": null
            },
            "estimatedDetails": {
              "kwhUsage": "1000",
              "dayPercentage": null,
              "nightPercentage": null,
              "usagePeriod": "ANNUALLY",
              "monthlyCostEstimate": "2328.7833",
              "annualCostEstimate": "27945.4000",
              "applicableRates": {
                "totalApplicableRate": "26.94540",
                "totalApplicableRateWithMonthlySubscriptionFees": "27.94540",
                "kwhUsage": "1000",
                "serviceProvider": "CENTERPOINT",
                "serviceProviderConsumptionRate": "4.94540",
                "serviceProviderStandingRate": "439.00000",
                "loadZone": "LZ_HOUSTON",
                "totalApplicableDayRate": null,
                "totalApplicableNightRate": null,
                "totalApplicableDayRateWithMonthlySubscriptionFees": null,
                "totalApplicableNightRateWithMonthlySubscriptionFees": null,
                "loadZoneDayTimeConsumptionRate": null,
                "loadZoneNightTimeConsumptionRate": null,
                "loadZoneConsumptionRate": "21.56100",
                "serviceProviderStandingRateUnitType": "MONTHS_ON_SUPPLY",
                "serviceProviderConsumptionRateUnitType": "KWH_CONSUMPTION",
                "loadZoneDayTimeRateUnitType": null,
                "loadZoneNightTimeRateUnitType": null,
                "loadZoneConsumptionRateUnitType": "KWH_CONSUMPTION",
                "__typename": "ConciseRatesOutput"
              }
            },
            "expiresAt": "2022-09-20T14:04:34.438000-05:00",
            "loadZone": "LZ_HOUSTON",
            "serviceProvider": "CENTERPOINT"
          },
          {
            "product": {
              "code": "OCTOGO-12M",
              "displayName": "OctoPrepay 12",
              "description": "Prepaid 12 Month Fixed Rate with no exit fees.",
              "fullName": "OctoPrepay 12",
              "id": "39",
              "term": 12
            },
            "estimatedDetails": {
              "kwhUsage": "1000",
              "dayPercentage": null,
              "nightPercentage": null,
              "usagePeriod": "ANNUALLY",
              "monthlyCostEstimate": "1978.7833",
              "annualCostEstimate": "23745.4000",
              "applicableRates": {
                "totalApplicableRate": "22.74540",
                "totalApplicableRateWithMonthlySubscriptionFees": "23.74540",
                "kwhUsage": "1000",
                "serviceProvider": "CENTERPOINT",
                "serviceProviderConsumptionRate": "4.94540",
                "serviceProviderStandingRate": "439.00000",
                "loadZone": "LZ_HOUSTON",
                "totalApplicableDayRate": null,
                "totalApplicableNightRate": null,
                "totalApplicableDayRateWithMonthlySubscriptionFees": null,
                "totalApplicableNightRateWithMonthlySubscriptionFees": null,
                "loadZoneDayTimeConsumptionRate": null,
                "loadZoneNightTimeConsumptionRate": null,
                "loadZoneConsumptionRate": "17.36100",
                "serviceProviderStandingRateUnitType": "MONTHS_ON_SUPPLY",
                "serviceProviderConsumptionRateUnitType": "KWH_CONSUMPTION",
                "loadZoneDayTimeRateUnitType": null,
                "loadZoneNightTimeRateUnitType": null,
                "loadZoneConsumptionRateUnitType": "KWH_CONSUMPTION",
                "__typename": "ConciseRatesOutput"
              }
            },
            "expiresAt": "2022-09-20T14:04:34.438000-05:00",
            "loadZone": "LZ_HOUSTON",
            "serviceProvider": "CENTERPOINT"
          },
          {
            "product": {
              "code": "OCTOPLUS-36M",
              "displayName": "Octo 36",
              "description": "36 Month Fixed Rate with no exit fees.",
              "fullName": "Octo 36",
              "id": "37",
              "term": 36
            },
            "estimatedDetails": {
              "kwhUsage": "1000",
              "dayPercentage": null,
              "nightPercentage": null,
              "usagePeriod": "ANNUALLY",
              "monthlyCostEstimate": "1850.3167",
              "annualCostEstimate": "22203.8000",
              "applicableRates": {
                "totalApplicableRate": "21.20380",
                "totalApplicableRateWithMonthlySubscriptionFees": "22.20380",
                "kwhUsage": "1000",
                "serviceProvider": "CENTERPOINT",
                "serviceProviderConsumptionRate": "4.94540",
                "serviceProviderStandingRate": "439.00000",
                "loadZone": "LZ_HOUSTON",
                "totalApplicableDayRate": null,
                "totalApplicableNightRate": null,
                "totalApplicableDayRateWithMonthlySubscriptionFees": null,
                "totalApplicableNightRateWithMonthlySubscriptionFees": null,
                "loadZoneDayTimeConsumptionRate": null,
                "loadZoneNightTimeConsumptionRate": null,
                "loadZoneConsumptionRate": "15.81940",
                "serviceProviderStandingRateUnitType": "MONTHS_ON_SUPPLY",
                "serviceProviderConsumptionRateUnitType": "KWH_CONSUMPTION",
                "loadZoneDayTimeRateUnitType": null,
                "loadZoneNightTimeRateUnitType": null,
                "loadZoneConsumptionRateUnitType": "KWH_CONSUMPTION",
                "__typename": "ConciseRatesOutput"
              }
            },
            "expiresAt": "2022-09-20T14:04:34.438000-05:00",
            "loadZone": "LZ_HOUSTON",
            "serviceProvider": "CENTERPOINT"
          },
          {
            "product": {
              "code": "OCTOPUS-DRIVE-365-DAY-FIXED",
              "displayName": "OctoDrive 12",
              "description": "12 month Time-of-Use fixed rate",
              "fullName": "OctoDrive 12",
              "id": "22",
              "term": 12
            },
            "estimatedDetails": {
              "kwhUsage": "1000",
              "dayPercentage": "0.90000000000000002220446049250313080847263336181640625",
              "nightPercentage": "0.1000000000000000055511151231257827021181583404541015625",
              "usagePeriod": "ANNUALLY",
              "monthlyCostEstimate": "1847.7833",
              "annualCostEstimate": "22173.4000",
              "applicableRates": {
                "totalApplicableRate": "0",
                "totalApplicableRateWithMonthlySubscriptionFees": "0",
                "kwhUsage": "1000",
                "serviceProvider": "CENTERPOINT",
                "serviceProviderConsumptionRate": "4.94540",
                "serviceProviderStandingRate": "439.00000",
                "loadZone": "LZ_HOUSTON",
                "totalApplicableDayRate": "21.20340",
                "totalApplicableNightRate": "20.90340",
                "totalApplicableDayRateWithMonthlySubscriptionFees": "22.20340",
                "totalApplicableNightRateWithMonthlySubscriptionFees": "21.90340",
                "loadZoneDayTimeConsumptionRate": "15.81900",
                "loadZoneNightTimeConsumptionRate": "15.51900",
                "loadZoneConsumptionRate": null,
                "serviceProviderStandingRateUnitType": "MONTHS_ON_SUPPLY",
                "serviceProviderConsumptionRateUnitType": "KWH_CONSUMPTION",
                "loadZoneDayTimeRateUnitType": "KWH_CONSUMPTION",
                "loadZoneNightTimeRateUnitType": "KWH_CONSUMPTION",
                "loadZoneConsumptionRateUnitType": null,
                "__typename": "ConciseRatesOutput"
              }
            },
            "expiresAt": "2022-09-20T14:04:34.438000-05:00",
            "loadZone": "LZ_HOUSTON",
            "serviceProvider": "CENTERPOINT"
          },
          {
            "product": {
              "code": "OCTOPLUS-12M",
              "displayName": "Octo 12",
              "description": "12 Month Fixed Rate with no exit fees.",
              "fullName": "Octo 12",
              "id": "38",
              "term": 12
            },
            "estimatedDetails": {
              "kwhUsage": "1000",
              "dayPercentage": null,
              "nightPercentage": null,
              "usagePeriod": "ANNUALLY",
              "monthlyCostEstimate": "1978.7833",
              "annualCostEstimate": "23745.4000",
              "applicableRates": {
                "totalApplicableRate": "22.74540",
                "totalApplicableRateWithMonthlySubscriptionFees": "23.74540",
                "kwhUsage": "1000",
                "serviceProvider": "CENTERPOINT",
                "serviceProviderConsumptionRate": "4.94540",
                "serviceProviderStandingRate": "439.00000",
                "loadZone": "LZ_HOUSTON",
                "totalApplicableDayRate": null,
                "totalApplicableNightRate": null,
                "totalApplicableDayRateWithMonthlySubscriptionFees": null,
                "totalApplicableNightRateWithMonthlySubscriptionFees": null,
                "loadZoneDayTimeConsumptionRate": null,
                "loadZoneNightTimeConsumptionRate": null,
                "loadZoneConsumptionRate": "17.36100",
                "serviceProviderStandingRateUnitType": "MONTHS_ON_SUPPLY",
                "serviceProviderConsumptionRateUnitType": "KWH_CONSUMPTION",
                "loadZoneDayTimeRateUnitType": null,
                "loadZoneNightTimeRateUnitType": null,
                "loadZoneConsumptionRateUnitType": "KWH_CONSUMPTION",
                "__typename": "ConciseRatesOutput"
              }
            },
            "expiresAt": "2022-09-20T14:04:34.438000-05:00",
            "loadZone": "LZ_HOUSTON",
            "serviceProvider": "CENTERPOINT"
          },
          {
            "product": {
              "code": "OCTOPUS-MONTH-TO-MONTH",
              "displayName": "Octopus Energy MTM",
              "description": "Postpay Month-to-month rates, no contract",
              "fullName": "Octopus Energy MTM",
              "id": "16",
              "term": null
            },
            "estimatedDetails": {
              "kwhUsage": "1000",
              "dayPercentage": null,
              "nightPercentage": null,
              "usagePeriod": "ANNUALLY",
              "monthlyCostEstimate": "2237.1167",
              "annualCostEstimate": "26845.4000",
              "applicableRates": {
                "totalApplicableRate": "25.84540",
                "totalApplicableRateWithMonthlySubscriptionFees": "26.84540",
                "kwhUsage": "1000",
                "serviceProvider": "CENTERPOINT",
                "serviceProviderConsumptionRate": "4.94540",
                "serviceProviderStandingRate": "439.00000",
                "loadZone": "LZ_HOUSTON",
                "totalApplicableDayRate": null,
                "totalApplicableNightRate": null,
                "totalApplicableDayRateWithMonthlySubscriptionFees": null,
                "totalApplicableNightRateWithMonthlySubscriptionFees": null,
                "loadZoneDayTimeConsumptionRate": null,
                "loadZoneNightTimeConsumptionRate": null,
                "loadZoneConsumptionRate": "20.46100",
                "serviceProviderStandingRateUnitType": "MONTHS_ON_SUPPLY",
                "serviceProviderConsumptionRateUnitType": "KWH_CONSUMPTION",
                "loadZoneDayTimeRateUnitType": null,
                "loadZoneNightTimeRateUnitType": null,
                "loadZoneConsumptionRateUnitType": "KWH_CONSUMPTION",
                "__typename": "ConciseRatesOutput"
              }
            },
            "expiresAt": "2022-09-20T14:04:34.438000-05:00",
            "loadZone": "LZ_HOUSTON",
            "serviceProvider": "CENTERPOINT"
          }
        ]
      }
    }
  }
}
Back to top