Get Available Tariff Rate Plans for an Account with {providerAccountId}

get

https://api.genability.com/rest/v1/accounts/pid/{providerAccountId}/tariffs

Query available tariff rate plans for an account using the corresponding {providerAccountId}. In order to use this endpoint, the account must have a valid address. Specifically, the account's zip field and customerClass property must be populated.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

providerAccountId

string

required

This is your unique identifier chosen to represent the Account object.

Query Params

effectiveOn

date

Only tariffs that are effective on this date.

openOn

date

Only tariffs that were open (i.e. were not closed to new customers) on this date.

populateRates

boolean

Defaults to false

Populates the rate details for the returned tariffs. Note this incurs unique tariff usage per MTID in the response when true.

populateDocuments

boolean

Defaults to false

Populates the document links for the returned tariffs. Note this incurs unique tariff usage per MTID in the response when true.

hasNetMetering

boolean

Return tariffs which have or do not have any net metered tariff rates.

hasTimeOfUseRates

boolean

Return tariffs which have or do not have any time-of-use rates.

hasTieredRates

boolean

Return tariffs which have or do not have any tiered rates.

hasContractedRates

boolean

Return tariffs which have or do not have any contracted rates.

filterByApplicability

boolean

Applies a rule that results should also be filtered by applicability (i.e., additional eligibility properties).

applicabilityFilters[solarPvEligible]

boolean

The APPLICABILITY typed property you want to filter by (example [solarPvEligible]). Note this must be used in concert with filterByApplicability=true.

fields

string

Controls the granularity of returned response fields. Blank returns the most common fields needed for key actions. Supplying a value of min will only return a subset of fields, and ext will return all publicly available fields.

bundleRates

boolean

When true (false by default) the returned rates are summarized (bundled). Note that this only works for tariffs with a customerClass of RESIDENTIAL.

Response

200200