Get Cost Rates

Retrieve a paginated list of cost rates within the current mandant. Each item in the response contains uuid, name, description, currency, auto_stop_minutes, and auto_stop_costs.

Request

  • Method: GET

  • Path: /api/dynamic_pricing/cost_rates

Query parameters

Optional:

Name

Type

Description

batch_size

integer

Number of cost rates returned per page. Defaults to 500 and is capped at 500; larger values are clamped.

page

integer

1-based page number. Defaults to 1; values below 1 are clamped to 1.

Example request

curl --location --request GET 'https://example.beenergised.cloud/api/dynamic_pricing/cost_rates?batch_size=100&page=1' \
--header 'x-api-token: <your_token>'

Response (200)

{
  "data": [
    {
      "uuid": "<COST_RATE_UUID>",
      "name": "My cost rate",
      "description": "Optional description",
      "currency": "EUR",
      "auto_stop_minutes": 120,
      "auto_stop_costs": 25.5
    }
  ],
  "last_page": false
}

Pagination

Iterate page starting at 1, incrementing by 1 per request, until the response contains "last_page": true. When last_page is true the current response already contains the final batch; no further request is needed.

Error responses

  • 500: Generic server error.

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