Get a rate templates by ID

GET 
/v1/rates/templates/:id

Retrieve a single rate templates by its ID

Request

Path Parameters

id stringrequired

Rate templates ID

Responses

200

Rate templates found successfully

application/json

Schema

Schema

_id stringrequired

The ID of the rate template

name stringrequired

The name of the rate template

corporateId stringrequired

The corporate ID

isDefault booleanrequired

Whether the rate template is the default rate template

vehicleTypeRates object[]required
The vehicle type rates
Array [
vehicleType string
The vehicle type name
vehicleTypeId string
The vehicle type ID
rates object[]
The rates for the vehicle type
Array [
rateId stringrequired
The rate ID
zoneId string
The operation zone ID
rateType stringrequired
Possible values: [Hourly, Regular, Flat, Sharing, Intercity]
The type of rate
rateActive boolean
Default value: true
Whether the rate is active for the vehicle type
]
]
isCorpCustomPricing booleanrequired

Whether the rate template is corporate custom pricing

latestUpdate date-timerequired

The latest update date

Example (from schema)

{
  "_id": "672d07188234567890123456",
  "name": "Standard Rate Template",
  "corporateId": "672d07188234567890123456",
  "isDefault": true,
  "vehicleTypeRates": [
    {
      "vehicleType": "Car",
      "vehicleTypeId": "672d07188234567890123456",
      "rates": [
        {
          "rateId": "672d07188234567890123456",
          "zoneId": "672d07188234567890123456",
          "rateType": "Regular",
          "rateActive": true
        }
      ]
    }
  ],
  "isCorpCustomPricing": true,
  "latestUpdate": "2025-01-01"
}

404

Rate templates not found

500

Internal server error

Loading...