Get a hourly rate by ID
GET/v1/rates/hourly/:id
Retrieve a single hourly rate by its ID
Request
Path Parameters
id stringrequired
Hourly rate ID
Responses
- 200
- 400
- 404
- 500
Hourly rate found successfully
- application/json
- Schema
- Example (from schema)
Schema
_id stringrequired
The ID of the hourly rate
rateName stringrequired
The name of the hourly rate
isActive booleanrequired
Whether the hourly rate is active
calculationMode numberrequired
The calculation mode of the hourly rate
feePerStop numberrequired
The fee per stop of the hourly rate
priceAdjustment objectrequired
isActive boolean
minimumPercent number
maximumPercent number
value number
Default value: 0
startDate stringrequired
The start date of the hourly rate
endDate stringrequired
The end date of the hourly rate
startTime stringrequired
The start time of the hourly rate
endTime stringrequired
The end time of the hourly rate
currencyISO stringrequired
The currency ISO of the hourly rate
currencySymbol stringrequired
The currency symbol of the hourly rate
isFeePerSeatActive booleanrequired
Whether the fee per seat is active
applyGeniusDiscount objectrequired
enable boolean
value number
Default value: 5
minSeat numberrequired
The minimum seat of the hourly rate
dropOffZoneIds string[]required
The drop off zone IDs of the hourly rate
latestUpdate date-timerequired
The latest update date of the hourly rate
{
"_id": "672d07188234567890123456",
"rateName": "Standard Hourly Rate",
"isActive": true,
"calculationMode": 1,
"feePerStop": 10,
"priceAdjustment": {
"isActive": false,
"minimumPercent": 0,
"maximumPercent": 0,
"value": 0
},
"startDate": "2025-01-01",
"endDate": "2025-01-01",
"startTime": "00:00",
"endTime": "23:59",
"currencyISO": "USD",
"currencySymbol": "$",
"isFeePerSeatActive": true,
"applyGeniusDiscount": {
"enable": false,
"value": 5
},
"minSeat": 1,
"dropOffZoneIds": [
"672d07188234567890123456"
],
"latestUpdate": "2025-01-01T00:00:00.000Z"
}
Invalid input data
Hourly rate not found
Internal server error
Loading...