Get total applicable rate

Returns the total applicable rate based on the product selected by the customer.

This output is part of the property type

Authentication Required

Requires account user level access.

Arguments

• accountNumber: String!

Returns

• PropertyType

Code

query getProperties($accountNumber:String!){
    properties(accountNumber:$accountNumber){
        id
        meterPoints{
            agreements{
                totalApplicableRate
            }
        }
    }
}

# Input variables
{
    "input": {
        "accountNumber": "A-12345",
    }
}

Examples

Rate without subscription fees

This rate could be off by a cent when compared with an EFL. To match the rate with an EFL, use the total applicable rate query with the include_subscription_fees flag.

GraphQLResponse

 query getProperties($accountNumber:String!){
    properties(accountNumber:$accountNumber){
        id
        meterPoints{
            agreements{
                totalApplicableRate
            }
        }
    }
}

# Input variables
{
    "input": {
        "accountNumber": "A-12345",
    }
}

{
    "data": {
        "properties": [{
                "meterPoints": [{
                    "agreements": [{
                        "totalApplicableRate": "12.50050"
                    }]
                }]
        }]
    }
}

Rate with monthly subscription fees

GraphQLResponse

 query getTotalApplicableRate($accountNumber:String!, $includeSubscriptionFees:Boolean!){
    properties(accountNumber:$accountNumber){
        meterPoints{
            agreements{
                totalApplicableRate(includeSubscriptionFees:$includeSubscriptionFees)
            }
        }
    }
}

# Input variables
{
    "input": {
        "accountNumber": "A-12345",
        "includeSubscriptionFees": True
    }
}

{
    "data": {
        "properties": [{
                "meterPoints": [{
                    "agreements": [{
                        "totalApplicableRate": "13.50050"
                    }]
                }]
        }]
    }
}