---
updatedAt: 2026-03-31T12:12:41.000Z
agentTools:
  projectIndex: https://api.net2grid.com/llms.txt
---

# /notification/bill_prediction/{energy_type}

Returns  the bill prediction notification parameters for the user.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "NET2GRID Customer Engagement API",
    "description": "This is the B2C NET2GRID API that can be used by mobile and web apps to manage the accounts and the data that are provided by the NET2GRID Meter Data Analytics Platform.",
    "version": "13.6.0"
  },
  "servers": [
    {
      "url": "http://api.net2grid.docker",
      "description": "API server"
    }
  ],
  "paths": {
    "/v2/notification/bill_prediction/{energy_type}": {
      "get": {
        "tags": [
          "Notifications"
        ],
        "summary": "/notification/bill_prediction/{energy_type}",
        "description": "Returns  the bill prediction notification parameters for the user.",
        "operationId": "v2/getNotificationBillPrediction",
        "parameters": [
          {
            "name": "energy_type",
            "in": "path",
            "description": "The type of energy (electricity or gas)",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "electricity",
                "gas"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetBillPredictionNotificationResponseDTO"
                }
              }
            }
          },
          "400": {
            "description": "Invalid request<br/>258: Bill prediction monitor not found for this energy type<br/>999: Unspecified Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseDTO"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "GetBillPredictionNotificationResponseDTO": {
        "required": [
          "status",
          "data"
        ],
        "properties": {
          "status": {
            "description": "The status of the call, \"ok\" if it was successful, \"error\" if it went wrong",
            "type": "string"
          },
          "data": {
            "$ref": "#/components/schemas/BillPredictionNotificationDataDTO"
          }
        },
        "type": "object"
      },
      "BillPredictionNotificationDataDTO": {
        "required": [
          "energy_type",
          "frequency",
          "relative_threshold_over",
          "relative_threshold_under",
          "absolute_threshold_over",
          "absolute_threshold_under"
        ],
        "properties": {
          "energy_type": {
            "description": "The type of energy (electricity or gas)",
            "type": "string",
            "enum": [
              "electricity",
              "gas"
            ]
          },
          "frequency": {
            "description": "The frequency of bill prediction notifications preferred by the user. 'OFF' is to disable the notification monitoring.",
            "type": "string",
            "enum": [
              "OFF",
              "DAILY",
              "WEEKLY",
              "MONTHLY"
            ]
          },
          "relative_threshold_over": {
            "description": "The alarm threshold that defines the percentage by which the bill prediction should exceed the sum of prepayments for the alarm to be triggered. Percentage as fraction e.g. 5% -> 0.05",
            "type": "number",
            "format": "float",
            "example": 0.2
          },
          "relative_threshold_under": {
            "description": "The alarm threshold that defines the percentage by which the bill prediction should be lower than the sum of prepayments for the alarm to be triggered. Percentage as fraction e.g. 5% -> 0.05",
            "type": "number",
            "format": "float",
            "example": 0.2
          },
          "absolute_threshold_over": {
            "description": "The alarm threshold that defines the absolute money amount by which the bill prediction should exceed the sum of prepayments for the alarm to be triggered.",
            "type": "number",
            "format": "float",
            "example": 45.1
          },
          "absolute_threshold_under": {
            "description": "The alarm threshold that defines the absolute money amount by which the bill prediction should be less than the sum of prepayments for the alarm to be triggered.",
            "type": "number",
            "format": "float",
            "example": 60.2
          }
        },
        "type": "object"
      },
      "ErrorDTO": {
        "properties": {
          "code": {
            "type": "integer"
          },
          "message": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "ErrorResponseDTO": {
        "properties": {
          "status": {
            "type": "string"
          },
          "error": {
            "$ref": "#/components/schemas/ErrorDTO"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "bearerFormat": "JWT",
        "scheme": "bearer"
      }
    }
  },
  "tags": [
    {
      "name": "Notifications"
    }
  ],
  "x-explorer-enabled": false
}
```