v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Price Groups

Retrieve a list of price groups.

Required scope: price-groups:read </br>Organization authorization: supported

get/api/v1/price-groups

Query parameters

teamIdinteger

Filter by team id. When omitted, returns all price groups owned by the consumer's operator.

type'public' | 'member' | 'sponsored' | 'cost' | 'roaming' | 'reimbursement' | 'member_cost' | 'other'

Filter by price group type. Multiple values supported.

pricingType'kwh' | 'min' | 'spot' | 'tariff' | 'fee'

Filter by pricing type. Multiple values supported.

searchstring

Free-text search filter by price group name. Max 200 characters.

pageinteger

Page number to retrieve (starts with 0)

perPageinteger

Number of items per page (between 1 and 100, default 10)

Response

List of price groups that match the criteria

Example response

{
  "data": [
    {
      "id": 522,
      "teamId": 12,
      "name": "Public Price Group",
      "masterPrice": {
        "id": 1,
        "description": "Starting Fee",
        "master": true,
        "percentage": 10.2,
        "tariffId": 5,
        "updatedAt": "2023-03-16T15:37:23Z",
        "applyAfterMinutes": 30,
        "price": {
          "amount": 12312,
          "currency": {
            "id": 1,
            "master": true,
            "identifier": "DKK",
            "name": "Danish krone",
            "decimals": 2
          },
          "locale": "en"
        },
        "priceMin": {
          "amount": 12312,
          "currency": {
            "id": 1,
            "master": true,
            "identifier": "DKK",
            "name": "Danish krone",
            "decimals": 2
          },
          "locale": "en"
        },
        "priceMax": {
          "amount": 12312,
          "currency": {
            "id": 1,
            "master": true,
            "identifier": "DKK",
            "name": "Danish krone",
            "decimals": 2
          },
          "locale": "en"
        },
        "feePriceMax": {
          "amount": 12312,
          "currency": {
            "id": 1,
            "master": true,
            "identifier": "DKK",
            "name": "Danish krone",
            "decimals": 2
          },
          "locale": "en"
        },
        "additional": [
          {
            "value": {
              "amount": 12312,
              "currency": {
                "id": 1,
                "master": true,
                "identifier": "DKK",
                "name": "Danish krone",
                "decimals": 2
              },
              "locale": "en"
            }
          }
        ],
        "from": "2023-03-16T15:37:23Z",
        "to": "2023-03-16T15:37:23Z",
        "tagId": 109,
        "gracePeriods": [
          {
            "startTime": "09:00:00",
            "endTime": "17:00:00"
          }
        ]
      },
      "tariffs": [
        {
          "id": 1,
          "description": "Starting Fee",
          "master": true,
          "percentage": 10.2,
          "tariffId": 5,
          "updatedAt": "2023-03-16T15:37:23Z",
          "applyAfterMinutes": 30,
          "price": {
            "amount": 12312,
            "currency": {
              "id": 1,
              "master": true,
              "identifier": "DKK",
              "name": "Danish krone",
              "decimals": 2
            },
            "locale": "en"
          },
          "priceMin": {
            "amount": 12312,
            "currency": {
              "id": 1,
              "master": true,
              "identifier": "DKK",
              "name": "Danish krone",
              "decimals": 2
            },
            "locale": "en"
          },
          "priceMax": {
            "amount": 12312,
            "currency": {
              "id": 1,
              "master": true,
              "identifier": "DKK",
              "name": "Danish krone",
              "decimals": 2
            },
            "locale": "en"
          },
          "feePriceMax": {
            "amount": 12312,
            "currency": {
              "id": 1,
              "master": true,
              "identifier": "DKK",
              "name": "Danish krone",
              "decimals": 2
            },
            "locale": "en"
          },
          "additional": [
            {
              "value": {
                "amount": 12312,
                "currency": {
                  "id": 1,
                  "master": true,
                  "identifier": "DKK",
                  "name": "Danish krone",
                  "decimals": 2
                },
                "locale": "en"
              }
            }
          ],
          "from": "2023-03-16T15:37:23Z",
          "to": "2023-03-16T15:37:23Z",
          "tagId": 109,
          "gracePeriods": [
            {
              "startTime": "09:00:00",
              "endTime": "17:00:00"
            }
          ]
        }
      ],
      "fees": [
        {
          "id": 1,
          "description": "Starting Fee",
          "master": true,
          "percentage": 10.2,
          "tariffId": 5,
          "updatedAt": "2023-03-16T15:37:23Z",
          "applyAfterMinutes": 30,
          "price": {
            "amount": 12312,
            "currency": {
              "id": 1,
              "master": true,
              "identifier": "DKK",
              "name": "Danish krone",
              "decimals": 2
            },
            "locale": "en"
          },
          "priceMin": {
            "amount": 12312,
            "currency": {
              "id": 1,
              "master": true,
              "identifier": "DKK",
              "name": "Danish krone",
              "decimals": 2
            },
            "locale": "en"
          },
          "priceMax": {
            "amount": 12312,
            "currency": {
              "id": 1,
              "master": true,
              "identifier": "DKK",
              "name": "Danish krone",
              "decimals": 2
            },
            "locale": "en"
          },
          "feePriceMax": {
            "amount": 12312,
            "currency": {
              "id": 1,
              "master": true,
              "identifier": "DKK",
              "name": "Danish krone",
              "decimals": 2
            },
            "locale": "en"
          },
          "additional": [
            {
              "value": {
                "amount": 12312,
                "currency": {
                  "id": 1,
                  "master": true,
                  "identifier": "DKK",
                  "name": "Danish krone",
                  "decimals": 2
                },
                "locale": "en"
              }
            }
          ],
          "from": "2023-03-16T15:37:23Z",
          "to": "2023-03-16T15:37:23Z",
          "tagId": 109,
          "gracePeriods": [
            {
              "startTime": "09:00:00",
              "endTime": "17:00:00"
            }
          ]
        }
      ],
      "createdAt": "2023-03-16T15:37:23Z",
      "updatedAt": "2023-03-16T15:37:23Z"
    }
  ]
}