agreement
Get an agreement by id.
Arguments
The agreement id.
Returns
AgreementPossible Errors
Allowed Viewers
Rate Limits
| Key | Steps |
|---|---|
user |
['5/s'] |
Query Complexity
1Examples
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 Agreement($id: ID!) {
agreement(id: $id) {
addonRates {
...AddOnRateTypeFragment
}
agreedFrom
agreedTo
id
isRevoked
params
product {
... on ElectricityFitProduct {
...ElectricityFitProductFragment
}
... on ElectricitySingleStepProduct {
...ElectricitySingleStepProductFragment
}
... on ElectricitySteppedProduct {
...ElectricitySteppedProductFragment
}
... on GasTieredProduct {
...GasTieredProductFragment
}
}
ratesAgreedAt
rescissionDeadlineAt
validFrom
validTo
}
}
Variables
{
"id": "52625300"
}
Response
{
"data": {
"agreement": {
"addonRates": [AddOnRateType],
"agreedFrom": "2023-02-22T05:34:38.643734+00:00",
"agreedTo": "1976-04-24T01:23:22.198997+00:00",
"id": 96680607,
"isRevoked": true,
"params": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"product": ElectricityFitProduct,
"ratesAgreedAt": "1986-07-17T14:15:25.402118+00:00",
"rescissionDeadlineAt": "2001-01-06T04:49:40.839111+00:00",
"validFrom": "1985-08-17T10:42:15.310922+00:00",
"validTo": "1970-08-22T10:12:38.009619+00:00"
}
}
}