get
https://api.genability.com/rest/public/tariffs//history
Return a complete history of tariff revisions for a given {masterTariffId}.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Retrieve the complete revision history for a tariff family by masterTariffId.
Use this endpoint to see when tariff versions changed, when linked riders changed, and when lookup-backed variable rates were updated. This is useful when you need to display tariff history to users or check whether locally stored tariff data is stale.
Resource URI
GET /rest/public/tariffs/{masterTariffId}/historyPath parameters
| Parameter | Type | Description |
|---|---|---|
masterTariffId | String | Unique Arcadia ID that persists across all revisions of a tariff. Required. |
Response data
The response returns a TariffHistory object. It can include:
| Field | Description |
|---|---|
masterTariffId | Unique Arcadia ID that persists across all revisions of the tariff. |
tariffCode | Shortcode that the LSE uses for the tariff. |
tariffName | Name of the tariff as used by the LSE. |
lseId | ID of the load serving entity that owns the tariff. |
serviceType | Service type for the tariff, such as ELECTRICITY, SOLAR_PV, or GAS. |
customerClass | Customer class for the tariff, such as RESIDENTIAL, GENERAL, SPECIAL_USE, or PROPOSED. |
initialEffectiveDate | Effective date of the first tariff version. |
closedDate | Date the tariff closed to new customers, when applicable. |
tariffVersions | List of tariff versions and their rider or lookup variable-rate history. |
For the full data model and response example, see Tariff History.
Example
GET /rest/public/tariffs/81587/historyA successful response returns a standard response payload with type set to TariffHistory and one tariff history object in the results array.