Link Search Menu Expand Document

💲 Prices are calculated on a per-minute basis and unfinished minutes are rounded up to the next integer. For example 5 min 36 sec would count as 6 minutes.

Get the pricing information for a zone

❗ Retrieving the pricing from a zone will deprecated on the 01.10.2021. Getting the price will need to be done via the Get the pricing information for a vehicle below.

This endpoint returns the pricing for a certain zone.

The currency is a 3-letter ISO 4217 code.

rentalStartPrice is the price for unlocking a vehicle to start a rental, rentalRunningPricePerMinute is the price to pay for each started minute and rentalPausedPricePerMinute is the price to pay for each started minute in which the rental has been paused (i.e. when the vehicle has been parked & locked).

Note that the zoneId is case-sensitive!

HTTP Request

GET https://platform.tier-services.io/v1/pricing?zoneId=BERLIN

Query Parameters

Parameter Description
zoneId The zone identifier
curl "https://platform.tier-services.io/v1/pricing?zoneId=BERLIN"
  -H "x-api-key: TIER API KEY"

Click to expand JSON data response
    {
      "data": {
        "type": "pricing",
        "id": "d62ee238-6fe3-4a9a-9db7-7f235e39e1fc",
        "attributes": {
          "currency": "EUR",
          "rentalStartPrice": "1.00",
          "rentalRunningPricePerMinute": "1.00",
          "rentalPausedPricePerMinute": "1.00",
          "zoneId": "BERLIN"
        }
      }
    }

Get the pricing information for a vehicle

This endpoint returns the pricing for a certain vehicle.

❗ Note that this is a v2 endpoint which is required for all new integrations

The currency is a 3-letter ISO 4217 code.

rentalStartPrice is the price for unlocking a scooter to start a rental, rentalRunningPricePerMinute is the price to pay for each started minute and rentalPausedPricePerMinute is the price to pay for each started minute in which the vehicle has been paused (“parked”).

HTTP Request

GET https://platform.tier-services.io/v2/pricing?vehicleId=52911ecb-60a4-2535-2875-fb443eb5409f

Query Parameters

Parameter Description
vehicleId The vehicle identifier
curl "https://platform.tier-services.io/v2/pricing?vehicleId=52911ecb-60a4-2535-2875-fb443eb5409f"
  -H "x-api-key: TIER API KEY"

Click to expand JSON data response
    {
        "data": {
            "type": "pricing",
            "id": "76ee75ae-e2b0-48b5-aaea-3756ce09f502",
            "attributes": {
                "vehicleId": "52911ecb-60a4-2535-2875-fb443eb5409f",
                "currency": "EUR",
                "rentalStartPrice": "1.00",
                "rentalRunningPricePerMinute": "0.15",
                "rentalPausedPricePerMinute": "0.15"
            }
        }
    }

Pricing-specific error codes

The TIER API (v1) can respond with the following pricing specific error code:

Error Codes

Error Code Meaning Code
404 Pricing not set for that zone, TIER is not actively operating here yet not_found

The TIER API (v2) can respond with the following pricing specific error code:

Error Codes

Error Code Meaning Code
404 Pricing not set for that vehicle. It’s likely that there are some configuration issues PricingNotFound
404 Vehicle with the id does not exist. VehicleNotFound

Please find the specific responses in the shell.

The command to get the pricing information of a zone

curl "https://platform.tier-services.io/v1/pricing?zoneId=BERLIN"
  -H "x-api-key: TIER API KEY"

  • returns a JSON structured like this if the pricing information is not set. Click ▶ button
Click to expand JSON data response
    {
      "errors": [
        {
          "source": {
              "pointer": "/data/attributes/detail"
          },
          "status": "404",
          "title": "Not found.",
          "code": "not_found"
        }
      ]
    }

The command to get the pricing information of a vehicle

curl "https://platform.tier-services.io/v2/pricing?vehicleId=52911ecb-60a4-2535-2875-fb443eb5409f"
  -H "x-api-key: TIER API KEY"

  • returns a JSON structured like this if the pricing information is not set
Click to expand JSON data response
    {
      "errors": [
        {
          "source": {
              "pointer": "/data"
          },
          "status": "404",
          "title": "Pricing for this vehicle does not exist.",
          "code": "PricingNotFound"
        }
      ]
    }