products

Get all available electricity products.

Arguments

availableAt : DateTime

Filters products that are available until the given time.

If the available_at argument is not provided, it defaults to the current localtime (America/Chicago).

basedOnTimeOfUse : Boolean

Get products that have the Time of Use flag.

displayName : String

Name of the product. For example: 30-Day Wholesale Rate.

id : ID

ID of the product.

prepay : Boolean

Get products that have the Prepay flag.

Returns

[ProductType]

Fetch products that are available.

A Product models a group of rates for electricity available during a fixed term (number of months).

Products require an availableAt input to filter products that are available until the given datetime. If no input is given, it defaults to the current local time.

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 Products(
  $availableAt: DateTime,
  $basedOnTimeOfUse: Boolean,
  $displayName: String,
  $id: ID,
  $prepay: Boolean
) {
  products(
    availableAt: $availableAt,
    basedOnTimeOfUse: $basedOnTimeOfUse,
    displayName: $displayName,
    id: $id,
    prepay: $prepay
  ) {
    autoTopUpDefaultAmount
    autoTopUpMinimumAmount
    availabilityStatus
    availableFrom
    availableTo
    basedOnTimeOfUse
    code
    description
    displayName
    endsAt
    fullName
    generationCredit
    id
    ioDiscountEnabled
    isWholesale
    marketName
    notes
    prepay
    rates {
      ...RatesTypeFragment
    }
    term
    termsContractType
  }
}

{
  "availableAt": "2011-03-09T22:52:27.979147+00:00",
  "basedOnTimeOfUse": true,
  "displayName": "staff-describe-look-above-answer",
  "id": "26952177",
  "prepay": true
}

{
  "data": {
    "products": [
      {
        "autoTopUpDefaultAmount": 66,
        "autoTopUpMinimumAmount": 50,
        "availabilityStatus": "PUBLIC",
        "availableFrom": "1974-01-07T09:37:36.079883+00:00",
        "availableTo": "2001-05-08T17:15:50.530352+00:00",
        "basedOnTimeOfUse": true,
        "code": "campaign-focus-hit-training-prove",
        "description": "certainly-either-east-represent-happy",
        "displayName": "pay-security-feeling-measure-suddenly",
        "endsAt": "1989-06-25T04:15:01.615639+00:00",
        "fullName": "writer-change-marriage-stage-allow",
        "generationCredit": true,
        "id": "62478603",
        "ioDiscountEnabled": true,
        "isWholesale": true,
        "marketName": "pretty-understand-same-student-daughter",
        "notes": "range-rest-head-late-interesting",
        "prepay": true,
        "rates": RatesType,
        "term": 64,
        "termsContractType": "consumer-reach-degree-control-rule"
      }
    ]
  }
}