Skip to content

Changelog

July 5, 2023

  1. Added documentation for Fan Club, its two queries, and three types.
    • getFanClubDiscount 🔗.
    • getWindPowerProjections 🔗.
    • FanClubDiscountOutput 🔗.
    • FanClubWindPowerProjections 🔗.
    • WindPowerProjection 🔗.

June 1, 2023

  1. Added clarification to the EstimatedMoneyType 🔗in the measurement api docs 🔗.
    • The smaller requested time intervals yield more accurate pricing than larger time intervals.

May 2, 2023

  1. Documented the new EstimatedMoneyType 🔗 in the measurement api.
    • Removed costCurrency field from MeasurementStatisticOutput 🔗
    • Improved the overview description of the measurement api 🔗.
    • Updated the GraphQL query string and response JSON in the measurement api docs 🔗 to reflect the new structure introduced by EstimatedMoneyType.

April 10, 2023

  1. Documented the affiliateLink query 🔗

March 29, 2023

  1. Added documentation for more of the measurement api 🔗. Specifically added:

February 3, 2023

    • Clarified descriptions and corrected obsolete examples in the Measurement interface docs 🔗.
    • The only filter input in the Measurement interface is depreciated. Use typed_only instead.

December 7, 2022

  1. Documented the new customerRevokeFutureAgreements mutation 🔗.
    • This mutation allows customers to self-revoke future agreements provided these agreements have no charges against them.
    • InputType.
    • OutputType.

November 18, 2022

  1. Documented the new accountCheckoutInformation query 🔗.

November 15, 2022

  1. Updated the urls returned in the legalDocuments endpoint 🔗.

    • These urls have been simplified. The response documentation now reflects these changes.

October 27, 2022

  1. Added the price field to IntervalReadingOutput.

    • It allows market price information to be returned with the intervalReadings query for non fixed rate products 🔗.

October 14, 2022

  1. Documented includeFutureActiveAgreements bool that was recently added to the AgreementType.

    • It allows users to query for agreements that will be active in the future.

  2. Documented ledgers endpoint 🔗.

    • It allows users to query for an account's financial activity.

October 7, 2022

Removed note stating OEUS does not support aggregation by 30min in our measurement API 🔗.

  • It is now supported and behaves like the other enumerated intervals.

September 21, 2022

Documented customerAcceptQuote endpoint 🔗

  • Accepts the given quote and creates a new agreement for the customer.

September 19, 2022

  1. Documented createQuote endpoint 🔗

    • Generates a quote using the given postcode.

  2. Documented customerCreateQuote endpoint 🔗

    • Generates a quote for an existing customer.

  3. Documented new aggregation enumerations 🔗

    • Allows aggregation of fifteen minute interval readings by common time intervals.

  4. Documented using these enums in our existing endpoints 🔗

    • Shows python, javascript, and typescript implementation.
    • Shows how to access typed responses with these new enums.

September 12, 2022

  1. Documented typedOnly filter 🔗

    • It provides an interface to filter measurements using typed objects 🔗.

  2. Modified existing measurement responses to include a metaData object.

    • Currently, it returns a typedSource dictionary that contains granular information about the source of the data.

August 31, 2022

Documented payments endpoint 🔗

  • Includes an example of querying for cleared payments applied towards topping up a pre-pay schedule 🔗

August 10, 2022

  1. Moved property and properties queries from the Account module into the Properties module.

    • Link to property page 🔗
    • Link to properties page 🔗

  2. Documented measurements endpoint 🔗

    • It provides a better API to query for interval and daily readings.

July 14, 2022

Documented createAffiliateSession endpoint 🔗

  • It allows affiliates and sales teams to track sessions.

July 13, 2022

  1. Documented totalApplicableRate 🔗

    • It returns the rate based on the product selected by the customer.

  2. Added includeSubscriptionFees 🔗

    • It returns the total applicable rate that includes the monthly subscription fees. This rate should match with the rate on the EFL.

June 21, 2022

  1. Documented property (🔗) and properties (🔗) endpoints.

    • It allows account users or authorized organizations to get information regarding a property/properties.

  2. Added autoTopUpAmountSelectedByUser field to the property (🔗) and properties (🔗) endpoint.

    • It returns the auto top up amount selected by the customer for a pre-pay product.

June 7, 2022

Documented dailyReadings endpoint 🔗

  • It allows account users to retrieve their wholesale pricing history between a given timeframe.

May 23, 2022

Documented intervalReadings endpoint 🔗

  • It allows account users to retrieve their wholesale pricing history for any given day.

May 17, 2022

  1. Documented registerPushNotificationBinding endpoint 🔗

    • It gives account users the ability to enroll in our push notification service.

  2. Added deletePushNotificationBinding endpoint 🔗

    • It gives account users the option to opt-out from receiving any push notifications on their device.

  3. Added uniqueReferenceNumber field to the createAccount endpoint 🔗

    • It allows affiliates to populate this field with a string that can be used to reference a sale between them and our team.

May 2, 2022

Added storeCreditScore endpoint 🔗

April 27, 2022

Added ercotHolidays endpoint.

  • It returns all the holidays recognized by ERCOT and Octopus Energy in a given year 🔗

April 25, 2022

Added consolidatedRates field to the productsWithConciseApplicableRates endpoint.

  • It will allow users to fetch rates for 500 kWh, 1000 kWh, and 2000 kWh in one request instead of multiple requests 🔗

March 28, 2022

Added getAccountCreatedByAffiliate query to allow affiliates to lookup basic information of an account that was created by them 🔗

March 15, 2022

Updated addPropertyToShellAccount mutation to include the effectiveFrom input.

  • Without this input, the mutation will default to the current CST time 🔗

March 9, 2022

  1. Added field term to query productsWithConciseApplicableRates and ProductWithRatesOutput which gives the duration of agreements using a product in months.
  2. Added query examples to return response from productsWithConciseApplicableRates 🔗

March 3, 2022

  1. Added toggleThermostatControl mutation, which sets the thermostat as enabled or disabled , depeneding on given input. 🔗
  2. Added deleteThermostatToken mutation, which permanently deletes a given thermostat's SmartDeviceToken object. 🔗

February 28, 2022

  1. Deprecated signup and promo rewards returned by the referrals query (was added on Feb 23rd, 2022).

    • Signup and Promo rewards will be returned by another query (WIP)

  2. Modified the existing query and examples to return reponse from the referrals query 🔗

  3. Added new fields to the referrals query:

    • referredUserPaymentAmount : Returns the payment amount given to referred user in cents.
    • referringUserPaymentAmount : Returns the payment amount given to referring user in cents.
    • combinedPaymentAmount : Returns the combined payment amount in cents.

  4. Added updateMetadata mutation to create or update account metadata 🔗

February 23, 2022

Added a query to retrieve referral, signup, and promo rewards that are applicable to an account 🔗

February 10, 2022

  1. Added a new faster address lookup endpoint (currently in beta mode) 🔗

  2. Added new fields to the products with concise applicable rates endpoint. These fields will include the subscription fees with the rates and they will match with the rates on the EFLs 🔗

    • totalApplicableRateWithMonthlySubscriptionFees: Returns rate with the subscription fees (postpay and prepay products).
    • totalApplicableDayRateWithMonthlySubscriptionFees: Returns day rate with subscription fees (for EV products).
    • totalApplicableNightRateWithMonthlySubscriptionFees: Returns night rate with subscription fees (for EV products).
Back to top