tariffSummary

Retrieve a summary of available tariffs.

Arguments

gridOperatorCode : String!


            required

The grid operator code to get tariffs for.

productCode : String

The product code to get the tariff for.

Returns

[TariffSummary!]

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

(No)

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

query TariffSummary(
  $gridOperatorCode: String!,
  $productCode: String
) {
  tariffSummary(
    gridOperatorCode: $gridOperatorCode,
    productCode: $productCode
  ) {
    code
    displayName
    gridOperatorCode
    productParams
    tiers {
      ...TariffTierFragment
    }
  }
}

{
  "gridOperatorCode": "world-game-over-million-age",
  "productCode": "form-cause-economy-show-race"
}

{
  "data": {
    "tariffSummary": [
      {
        "code": "American-back-right-billion-first",
        "displayName": "especially-anyone-all-cause-human",
        "gridOperatorCode": "value-point-drug-quickly-event",
        "productParams": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
        "tiers": [TariffTier]
      }
    ]
  }
}