Retrieve available tariff rate plans for an account using the Arcadia-generated accountId.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Retrieve available tariff rate plans for an account using the Arcadia-generated accountId.
Use this endpoint when you store and reference the Arcadia accountId for an account. To retrieve available tariff rate plans using your own account identifier, use Get Available Tariff Rate Plans with providerAccountId.
The account must have a valid address with zip populated, and it must have customerClass set.
Resource URI
GET /rest/v1/accounts/{accountId}/tariffsPath parameters
| Parameter | Type | Description |
|---|---|---|
accountId | String | Arcadia UUID of 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/1c06e306-bbb0-473a-973c-93d947f0761b/tariffsA 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
}
]
}