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

get

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

Retrieve available tariff rate plans for an account using your providerAccountId.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Retrieve available tariff rate plans for an account using your providerAccountId.

Use this endpoint when you identify accounts with your own IDs. To retrieve available tariff rate plans using the Arcadia-generated account identifier, use Get Available Tariff Rate Plans with accountId.

The account must have a valid address with zip populated, and it must have customerClass set.

Resource URI

GET /rest/v1/accounts/pid/{providerAccountId}/tariffs

Path parameters

Parameter	Type	Description
`providerAccountId`	String	Your unique identifier for the `Account` object. Required.

Common query parameters

Parameter	Type	Description
`effectiveOn`	Date	Only return tariffs effective on this date. Optional.
`openOn`	Date	Only return tariffs open to new customers on this date. Optional.
`populateRates`	Boolean	When `true`, includes rate details for returned tariffs. Defaults to `false`. Optional.
`populateDocuments`	Boolean	When `true`, includes document links for returned tariffs. Defaults to `false`. Optional.
`hasNetMetering`	Boolean	Filter by whether tariffs have net metered rates. Optional.
`hasTimeOfUseRates`	Boolean	Filter by whether tariffs have time-of-use rates. Optional.
`hasTieredRates`	Boolean	Filter by whether tariffs have tiered rates. Optional.
`hasContractedRates`	Boolean	Filter by whether tariffs have contracted rates. Optional.
`filterByApplicability`	Boolean	When `true`, filters results by applicability properties. Optional.
`applicabilityFilters[solarPvEligible]`	Boolean	Filter by the `solarPvEligible` applicability property. Use with `filterByApplicability=true`. Optional.
`fields`	String	Use `min` for minimum fields or `ext` for extended fields. Optional.
`bundleRates`	Boolean	When `true`, returns summarized rates for residential tariffs. Defaults to `false`. Optional.

For the full data model, account tariff workflow, tariff assignment behavior, and detailed examples, see Account Tariffs API.

Example

GET /rest/v1/accounts/pid/api-eg-008/tariffs

A successful response returns a standard response payload with type set to Tariff and results containing available tariff rate plans.

{
  "status": "success",
  "count": 1,
  "type": "Tariff",
  "results": [
    {
      "tariffId": 3155887,
      "masterTariffId": 522,
      "tariffCode": "E-1",
      "tariffName": "Residential",
      "lseId": 734,
      "lseName": "Pacific Gas & Electric Co",
      "customerClass": "RESIDENTIAL",
      "effectiveDate": "2013-01-01",
      "isActive": true
    }
  ]
}

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

Resource URI

Path parameters

Common query parameters

Example

200200