Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Price Groups

Apply price group to charge points, sites or team members

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

put/api/v1/price-groups/{id}/apply

Path parameters

idinteger required

Request body

selectedChargePointIdsinteger[] nullable

List of charge point ids

selectedSiteIdsinteger[] nullable

List of site ids

selectedTeamMemberIdsinteger[] nullable

List of team member ids

resetCostboolean nullable

Flag to indicate if costs should be reset

Response

Price group successfully applied to the selected entities

idinteger required

Id of the price group

teamIdinteger nullable

Id of the team for which this price group belongs

namestring required

Name of the price group

defaultboolean
type'public' | 'member' | 'sponsored' | 'cost' | 'roaming' | 'reimbursement' | 'member_cost' | 'other' required
teamMemberCountinteger nullable

To how many team members the price group has been applied to

chargePointCountinteger nullable

To how many charge points the price group has been applied to

createdAtstring date-time required

When the price group was created

updatedAtstring date-time nullable

When the price group was updated

Example response

{
  "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"
}