Skip to main content

Update an addon service

PATCH 
/v1/addons/services/:id

Update an existing addon service by ID

Request​

Path Parameters

    id stringrequired

    Addon service ID

Body

required
    name string

    Display name of the service

    description string

    Detailed description for customers

    userType string

    Possible values: [customer, driver, fleet]

    Who is being charged/reimbursed

    isRequired boolean

    Whether this service is mandatory (customer add-ons only)

    globalAttributeId string

    Link to global attribute for OTA mapping

    feeConfig object
    type stringrequired

    Possible values: [amount, percentageSubtotal, percentageTotal, custom]

    How the fee is calculated

    value number

    Default value: 0

    Fee value (amount, percentage, or max limit for custom)

    currency string

    Currency ISO code for amount-based fees

    unit string

    Possible values: [eachTime, each, perPerson, perDay, none]

    Default value: none

    Unit pricing model for amount-based fees

    maxQuantity number

    Default value: 1

    Maximum quantity for "each" unit type

    isUnlimited boolean

    For custom type: allow unlimited driver input

    commissionType string

    Possible values: [percentage, amount]

    Fleet commission type: percentage of addon fee or fixed amount

    commissionValue number

    Default value: 0

    Fleet commission value (percentage 0-100 or fixed amount)

    isApplyTax boolean

    Whether this add-on service will be included in tax calculation

    isItemize boolean

    Default value: true

    List as separate line item in fare breakdown (false = grouped under additional services)

    applicationRules object
    carTypes string[]

    Possible values: Value must match regular expression ^[0-9a-f]{24}$

    Applicable vehicle type IDs (empty = all): Get vehicle types

    serviceTypes string[]

    Possible values: [pointToPoint, fromAirport, toAirport, hourly]

    Applicable booking types (empty = all)

    tripContext object

    Trip context rules

    departure boolean

    Apply when pickup is in a meeting zone (e.g., airport)

    arrival boolean

    Apply when drop-off is in a meeting zone (e.g., airport)

    zones object

    Zone-based rules

    meetingZones string[]

    Possible values: Value must match regular expression ^[0-9a-f]{24}$

    Applicable meeting zone IDs (empty = all): Get meeting zones

    operationZones string[]

    Possible values: Value must match regular expression ^[0-9a-f]{24}$

    Applicable operation zone IDs (empty = all): Get operation zones

    restrictedZones string[]

    Possible values: Value must match regular expression ^[0-9a-f]{24}$

    Applicable restricted zone IDs: Get restricted zones

    bookingChannels string[]

    Possible values: [PWA, passenger, API, CC, partner, Car-hailing, streetSharing]

    Default value: ``

    Applicable booking channels indicating where booking was created from (empty = all)

    allowNoteInput boolean

    Enable drivers to input custom notes and upload receipts for this addon service. When enabled, drivers can provide additional information or documentation related to the service.

    isDriverCapability boolean

    Indicates whether this addon service represents a driver capability or skill requirement. When true, the service is associated with driver qualifications rather than a physical addon.

    isVehicleAttribute boolean

    Indicates whether this addon service represents a vehicle attribute or feature. When true, the service is associated with vehicle characteristics rather than a separate addon item.

Responses​

Addon service updated successfully

Schema
    _id stringrequired

    The ID of the addon service

    fleetId stringrequired

    The fleet ID

    templateId stringrequired

    The template ID

    name stringrequired

    Display name of the service

    description string

    Detailed description for customers

    userType stringrequired

    Who is being charged/reimbursed

    isRequired booleanrequired

    Whether this service is mandatory

    globalAttributeId string

    Link to global attribute for OTA mapping

    feeConfig objectrequired
    type stringrequired

    Possible values: [amount, percentageSubtotal, percentageTotal, custom]

    How the fee is calculated

    value number

    Default value: 0

    Fee value (amount, percentage, or max limit for custom)

    currency string

    Currency ISO code for amount-based fees

    unit string

    Possible values: [eachTime, each, perPerson, perDay, none]

    Default value: none

    Unit pricing model for amount-based fees

    maxQuantity number

    Default value: 1

    Maximum quantity for "each" unit type

    isUnlimited boolean

    For custom type: allow unlimited driver input

    commissionType string

    Possible values: [percentage, amount]

    Fleet commission type: percentage of addon fee or fixed amount

    commissionValue number

    Default value: 0

    Fleet commission value (percentage 0-100 or fixed amount)

    isApplyTax boolean

    Whether this add-on service will be included in tax calculation

    isItemize boolean

    Default value: true

    List as separate line item in fare breakdown (false = grouped under additional services)

    applicationRules object
    carTypes string[]

    Possible values: Value must match regular expression ^[0-9a-f]{24}$

    Applicable vehicle type IDs (empty = all): Get vehicle types

    serviceTypes string[]

    Possible values: [pointToPoint, fromAirport, toAirport, hourly]

    Applicable booking types (empty = all)

    tripContext object

    Trip context rules

    departure boolean

    Apply when pickup is in a meeting zone (e.g., airport)

    arrival boolean

    Apply when drop-off is in a meeting zone (e.g., airport)

    zones object

    Zone-based rules

    meetingZones string[]

    Possible values: Value must match regular expression ^[0-9a-f]{24}$

    Applicable meeting zone IDs (empty = all): Get meeting zones

    operationZones string[]

    Possible values: Value must match regular expression ^[0-9a-f]{24}$

    Applicable operation zone IDs (empty = all): Get operation zones

    restrictedZones string[]

    Possible values: Value must match regular expression ^[0-9a-f]{24}$

    Applicable restricted zone IDs: Get restricted zones

    bookingChannels string[]

    Possible values: [PWA, passenger, API, CC, partner, Car-hailing, streetSharing]

    Default value: ``

    Applicable booking channels indicating where booking was created from (empty = all)

    allowNoteInput booleanrequired

    Enable drivers to input custom notes and upload receipts for this addon service. When enabled, drivers can provide additional information or documentation related to the service.

    isDriverCapability booleanrequired

    Indicates whether this addon service represents a driver capability or skill requirement. When true, the service is associated with driver qualifications rather than a physical addon.

    isVehicleAttribute booleanrequired

    Indicates whether this addon service represents a vehicle attribute or feature. When true, the service is associated with vehicle characteristics rather than a separate addon item.

    createdDate date-timerequired

    Creation date

    latestUpdate date-timerequired

    Last update date

Loading...