Skip to main content

Fields

activeProductRates : RatesType

Rates of the product that the customer is currently on.

agreedAt : DateTime
autoTopUpAmountSelectedByUser : Int

Returns the auto top up amount selected by the user.

earlyTerminationFee : Decimal

Returns the early termination fee in dollars if one exists, else return None.

earlyTerminationFeeExpiration : Date

Returns the date when the early termination fee expires (inclusive) if one exists, else returns None. The date accounts for early switch allowance setting.

efls : [EflType]

Retrieve EFLs based on the product.

Arguments
language : EFLLanguage

Retrieve EFLs for the given language.

id : ID! required
isEligibleForRenewal : Boolean

Returns true if this customer is eligible for self renewal process.

isExportingGenerationReadings : Boolean

Returns true if this customer has exported any generation (solar) readings during the last seven days.

outageInformation : OutageMapOutputType

Outage information based on the service provider that serves the customer.

product : ProductType

An electricity product that the customer has signed up for using an agreement.

quoteRequest : GetQuoteOutputType

Returns the accepted quote request, if it exists. Otherwise, it returns None.Note: only a single quoted product will be returned in the quote request.

ratesAgreedAt : DateTime! required
seasonalRates : [SeasonRatesType]

Get the seasonal rates for a time of use product agreement. Returns null for all other product types.

Arguments
monthlyKwhUsage : Decimal

By default this will be set to 1000.00.

terminatedAt : DateTime
totalApplicableDayRate : Decimal

Get the day rate for a legacy time of use product agreement. Returns null for all other product types.

Arguments
kwhUsage : Decimal

By default this will be set to 1000.00.

totalApplicableNightRate : Decimal

Get the night rate for a legacy time of use product agreement. Returns null for all other product types.

Arguments
kwhUsage : Decimal

By default this will be set to 1000.00.

totalApplicableRate : Decimal

Get total applicable rate for a default 1000 kWh consumption. Returns null for time of use products.

Arguments
includeDeviceConditionalRates : Boolean default: True

If set to True, returns the total applicable rate with inclusion of conditional IO device fees/discounts, if any are configured, based on account's current device(s) connection status.

includeSubscriptionFees : Boolean

If set to True, it returns the monthly subscription fees as part of rate.

kwhUsage : Decimal

By default this will be set to 1000.00.

validFrom : DateTime! required
validTo : DateTime
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

{ "activeProductRates": RatesType, "agreedAt": "1992-09-27T00:32:20.321676+00:00", "autoTopUpAmountSelectedByUser": 35, "earlyTerminationFee": "1.0", "earlyTerminationFeeExpiration": "2001-03-12", "efls": [EflType], "id": "19518233", "isEligibleForRenewal": true, "isExportingGenerationReadings": true, "outageInformation": OutageMapOutputType, "product": ProductType, "quoteRequest": GetQuoteOutputType, "ratesAgreedAt": "2011-04-08T14:00:50.109392+00:00", "seasonalRates": [SeasonRatesType], "terminatedAt": "1971-03-21T17:10:03.548562+00:00", "totalApplicableDayRate": "1.0", "totalApplicableNightRate": "1.0", "totalApplicableRate": "1.0", "validFrom": "1970-07-24T23:49:15.774206+00:00", "validTo": "2012-06-27T05:42:11.132943+00:00" }