AgreementType
Any kind of rate which can be charged or credited to a customer.
Fields
Rates of the product that the customer is currently on.
Returns the auto top up amount selected by the user.
Returns the early termination fee in dollars if one exists, else return None.
Returns the date when the early termination fee expires (inclusive) if one exists, else returns None. The date accounts for early switch allowance setting.
Retrieve EFLs based on the product.
Arguments
Retrieve EFLs for the given language.
Returns true if this customer is eligible for self renewal process.
Returns true if this customer has exported any generation (solar) readings during the last seven days.
Outage information based on the service provider that serves the customer.
An electricity product that the customer has signed up for using an agreement.
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.
Get the seasonal rates for a time of use product agreement. Returns null for all other product types.
Arguments
By default this will be set to 1000.00.
Get the day rate for a legacy time of use product agreement. Returns null for all other product types.
Arguments
By default this will be set to 1000.00.
Get the night rate for a legacy time of use product agreement. Returns null for all other product types.
Arguments
By default this will be set to 1000.00.
Get total applicable rate for a default 1000 kWh consumption. Returns null for time of use products.
Arguments
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.
If set to True, it returns the monthly subscription fees as part of rate.
By default this will be set to 1000.00.
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"
}