Delete a customer policy
DELETE/v1/rates/customer-policies/:id
Delete a customer policy
Request
Path Parameters
id stringrequired
Customer policy ID
Responses
- 200
- 400
- 404
- 409
- 500
Customer policy deleted
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
_id stringrequired
name stringrequired
isDefault boolean
Whether the customer policy is the default policy
reservation object
freeTime number
Default value: 0
freeTimeUnit string
Possible values: [minute, hour]
penaltyActive boolean
fieldExclusions string[]
penaltyTiers object[]
fareType string
Default value: percent
commissionType string
Default value: commission
rangeStart number
rangeEnd number
penaltyPercent number
commissionPercent number
penaltyFee number
Default value: 0
commissionFee number
Default value: 0
penaltyType string
Possible values: [amount, percent]
penaltyFee number
Default value: 0
onDemand object
freeTime number
Default value: 0
freeTimeUnit string
Possible values: [minute, hour]
penaltyType string
Possible values: [amount, percent]
commissionType string
Possible values: [commission, fixed]
fieldExclusions string[]
penaltyFee number
Default value: 0
commissionFee number
Default value: 0
noShow object
penaltyType string
Possible values: [amount, percent, basedOnPayout]
commissionType string
Possible values: [commission, fixed]
fieldExclusions string[]
penaltyFee number
Default value: 0
commissionFee number
Default value: 0
createdDate date-time
latestUpdate date-time
{
"_id": "string",
"name": "Standard Customer Policy",
"isDefault": false,
"reservation": {
"freeTime": 0,
"freeTimeUnit": "minute",
"penaltyActive": true,
"fieldExclusions": [
"string"
],
"penaltyTiers": [
{
"fareType": "percent",
"commissionType": "commission",
"rangeStart": 0,
"rangeEnd": 0,
"penaltyPercent": 0,
"commissionPercent": 0,
"penaltyFee": 0,
"commissionFee": 0
}
],
"penaltyType": "amount",
"penaltyFee": 0
},
"onDemand": {
"freeTime": 0,
"freeTimeUnit": "minute",
"penaltyType": "amount",
"commissionType": "commission",
"fieldExclusions": [
"string"
],
"penaltyFee": 0,
"commissionFee": 0
},
"noShow": {
"penaltyType": "amount",
"commissionType": "commission",
"fieldExclusions": [
"string"
],
"penaltyFee": 0,
"commissionFee": 0
},
"createdDate": "2024-07-29T15:51:28.071Z",
"latestUpdate": "2024-07-29T15:51:28.071Z"
}
Invalid input data
Customer policy not found
Customer policy already exists
Internal server error
Loading...