Get Cost Rate Session Fee

Retrieve the session fee configuration for a cost rate.

If the cost rate uses dynamic pricing schedules, the session fee can be retrieved for a specific schedule by providing rate_cost_schedule_id.

The schedule identifier can be either the internal numeric ID or the schedule UUID.

Request

  • Method: GET

  • Path: /api/dynamic_pricing/cost_rate_session_fee/{uuid}

Path parameters

Name

Type

Description

uuid

string

UUID of the cost rate.

Query parameters

Optional:

Name

Type

Description

rate_cost_schedule_id

string|integer|null

Optional identifier of the schedule configuration. Can be a numeric internal ID or UUID.

Example request

curl --location --request GET \
'https://example.beenergised.cloud/api/dynamic_pricing/cost_rate_session_fee/<COST_RATE_UUID>?rate_cost_schedule_id=<SCHEDULE_UUID>' \
--header 'x-api-token: <your_token>'

Response (200)

{
  "data": {
    "amount": "1.30",
    "grace_period": "50",
    "energy_threshold": 600
  }
}

Error responses

  • 404: Cost rate not found.

{
  "status": "error",
  "message": "Cost rate not found"
}
  • 400: Invalid schedule identifier.

{
  "status": "error",
  "message": "Invalid rate_cost_schedule_id format"
}
  • 500: Generic server error.

{
  "status": "error",
  "message": "Internal Server Error"
}