Sign in

v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Price Groups

Update a fee in a price group

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

put/api/v1/price-groups/{id}/fees/{feeId}

Path parameters

idinteger required
feeIdinteger required

Request body

descriptionstring nullable

Name of the pricing. It is null when it's the master price

type'kwh' | 'min' | 'spot' | 'tariff' | 'starting' | 'charging' | 'idle' | 'minute' required
endAtFullyChargedboolean required

Used by the Minute fee. True means it will stop charging the fee when the charge is complete. False means it will stop charging the fee when the cable is unplugged

vatboolean required

Used by Spot Price. True means it will add 25% VAT in the price calculations

percentagenumber nullable

Used by Spot Price. It will multiply the fallback price by this percentage

tariffIdinteger nullable

The id of the selected Tariff

tagIdinteger nullable

The id of the selected charge pricing tag

applyAfterMinutesinteger nullable

Used by Charging, Minute and Idle Fees. After how many minutes the fee should start being applied.

pricenumber required

The price of this Fee or Master price, </br>Note: the master price cannot be a negative value

priceMinnumber nullable

Used by spot price. The minimum that the raw spot price can be. This will be used in calculations if spot price is lower than this

priceMaxnumber nullable

Used by spot price. The maximum that the raw spot price can be. This will be used in calculations if spot price is higher than this

feePriceMaxnumber nullable

Used by Idle fee. The maximum the user will be charged for the idle fee

fromstring date-time nullable

DateTime "from" time to which this pricing should apply from

tostring date-time nullable

DateTime "to" time to which this pricing should apply to

interval'hourly' | 'quarterHourly'

Example request

{
  "description": "Starting Fee",
  "percentage": 10.2,
  "tariffId": 5,
  "tagId": 10,
  "applyAfterMinutes": 30,
  "from": "2023-03-16T15:37:23Z",
  "to": "2023-03-16T15:37:23Z",
  "gracePeriods": [
    {
      "startTime": "09:00:00",
      "endTime": "17:00:00"
    }
  ]
}

Response

Fee successfully updated, returns the updated price group

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