Update a surcharge policy

PATCH 
/v1/rates/surcharge-policies/:id

Update an existing surcharge policy by ID

Request

Path Parameters

id stringrequired

Surcharge policy ID

application/json

Body

required

name string

The name of the surcharge policy

surchargeItems object[]
The surcharge items of the surcharge policy
Array [
surchargeName string
The name of the surcharge item
bookingType string[]
Possible values: [Now, Reservation]
The booking type of the surcharge item
startTime string
The start date of the surcharge item
endTime string
days number[]
repeat string
Possible values: [single, yearly, weekly]
bookingTimeCoverage number
Default value: 0
surchargeFee number
Default value: 0
surchargeType string
Possible values: [amount, percent]
bookingLeadTime object[]
Array [
rangeStart number
Default value: 0
rangeEnd number
Default value: 0
fee number
Default value: 0
fareType string
Possible values: [amount, percent]
]
distanceTier object[]
Array [
fareType string
Possible values: [perKm, fixAmount]
rangeStart number
rangeEnd number
fee number
Default value: 0
isFeePerSeatActive boolean
]
zoneIds string[]
bookingLeadTimeActive boolean
]

Responses

200

Surcharge policy updated successfully

application/json

Schema

Schema

_id stringrequired

The ID of the surcharge policy

name stringrequired

The name of the surcharge policy

surchargeItems object[]required
Array [
surchargeName string
The name of the surcharge item
bookingType string[]
Possible values: [Now, Reservation]
The booking type of the surcharge item
startTime string
The start date of the surcharge item
endTime string
days number[]
repeat string
Possible values: [single, yearly, weekly]
bookingTimeCoverage number
Default value: 0
surchargeFee number
Default value: 0
surchargeType string
Possible values: [amount, percent]
bookingLeadTime object[]
Array [
rangeStart number
Default value: 0
rangeEnd number
Default value: 0
fee number
Default value: 0
fareType string
Possible values: [amount, percent]
]
distanceTier object[]
Array [
fareType string
Possible values: [perKm, fixAmount]
rangeStart number
rangeEnd number
fee number
Default value: 0
isFeePerSeatActive boolean
]
zoneIds string[]
bookingLeadTimeActive boolean
]
latestUpdate date-timerequired

The latest update date of the surcharge policy

Example (from schema)

{
  "_id": "string",
  "name": "Standard Surcharge Policy",
  "surchargeItems": [
    {
      "surchargeName": "Weekend Surcharge",
      "bookingType": [
        "Now"
      ],
      "startTime": "string",
      "endTime": "string",
      "days": [
        0
      ],
      "repeat": "single",
      "bookingTimeCoverage": 0,
      "surchargeFee": 0,
      "surchargeType": "amount",
      "bookingLeadTime": [
        {
          "rangeStart": 0,
          "rangeEnd": 0,
          "fee": 0,
          "fareType": "amount"
        }
      ],
      "distanceTier": [
        {
          "fareType": "perKm",
          "rangeStart": 0,
          "rangeEnd": 0,
          "fee": 0,
          "isFeePerSeatActive": false
        }
      ],
      "zoneIds": [
        "string"
      ],
      "bookingLeadTimeActive": false
    }
  ],
  "latestUpdate": "2025-01-01T00:00:00.000Z"
}

400

Invalid input data

404

Surcharge policy not found

500

Internal server error

Loading...