HomeGuidesAPI ReferenceChangelog
Log In
API Reference

To see what tariff rates plans are available for a specific account, use one of the Get Available Tariffs endpoints. In order to use this endpoint, the account must have a valid address. Specifically, the zip field must be populated. Also, the account's customerClass property must be populated.

Example

Let's query the example account's tariffs.

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

Here's what we found...

{  
   "status": "success",  
   "count": 17,  
   "type": "Tariff",  
   "results": \[  
      {  
         "tariffId": 3155887,  
         "masterTariffId": 522,  
         "tariffCode": "E-1",  
         "tariffName": "Residential",  
         "lseId": 734,  
         "lseName": "Pacific Gas & Electric Co",  
         "priorTariffId": 3154354,  
         "tariffType": "DEFAULT",  
         "customerClass": "RESIDENTIAL",  
         "customerCount": 3321385,  
         "customerLikelihood": 74.03,  
         "territoryId": 807,  
         "effectiveDate": "2013-01-01",  
         "endDate": null,  
         "timeZone": "US/Pacific",  
         "billingPeriod": "MONTHLY",  
         "currency": "USD",  
         "chargeTypes": "CONSUMPTION_BASED,MINIMUM",  
         "chargePeriod": "DAILY",  
         "hasTimeOfUseRates": true,  
         "hasTieredRates": true,  
         "hasContractedRates": false,  
         "hasRateApplicability": true,  
         "isActive": true  
      },
       /* truncated for space */

  {
     "tariffId": 3155907,
     "masterTariffId": 3153889,
     "tariffCode": "E-7-FERA",
     "tariffName": "Residential - FERA, Time of Use",
     "lseId": 734,
     "lseName": "Pacific Gas & Electric Co",
     "priorTariffId": 3154806,
     "tariffType": "ALTERNATIVE",
     "customerClass": "RESIDENTIAL",
     "customerCount": 1,
     "customerLikelihood": 0,
     "territoryId": 807,
     "effectiveDate": "2013-01-01",
     "endDate": null,
     "timeZone": "US/Pacific",
     "billingPeriod": "MONTHLY",
     "currency": "USD",
     "chargeTypes": "CONSUMPTION_BASED,MINIMUM",
     "chargePeriod": "DAILY",
     "hasTimeOfUseRates": true,
     "hasTieredRates": true,
     "hasContractedRates": false,
     "hasRateApplicability": true,
     "isActive": true
  }
       ]  
}
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!