Skip to main content

Update a regular rate

PATCH 

/v1/rates/regular/:id

Update an existing regular rate by ID

Request

Path Parameters

    id stringrequired

    Regular rate ID

Body

required
    rateName string

    Name of the regular rate

    isActive boolean

    Status of the regular rate

    serviceType string

    Possible values: [transport, delivery]

    order number

    Default value: -1

    distanceTier object[]
  • Array [
  • fareType string

    Possible values: [perKm, fixAmount]

    rangeStart number
    rangeEnd number
    fee number

    Default value: 0

    isFeePerSeatActive boolean
  • ]
  • calculationMode number

    Default value: 0

    priceAdjustment object
    isActive boolean
    minimumPercent number
    maximumPercent number
    value number

    Default value: 0

    baseFare number

    Default value: 0

    perKmPrice number

    Default value: 0

    perMinPrice number

    Default value: 0

    currencyISO string
    currencySymbol string
    feePerStop number

    Default value: 0

    Fee per Additional Stops

    extraWaitTimeFee number

    Default value: 0

    Extra Wait Time Fee

    feePerMinute number

    Fee per Minute

    minimumFee number

    Minimum Fee

    startingFee number

    Starting Fee

    minSeat number

    The minimum number of seats to charge for a booking

Responses

Regular rate updated successfully

Schema
    _id stringrequired

    The ID of the regular rate

    rateName stringrequired

    The name of the regular rate

    isActive booleanrequired

    Whether the regular rate is active

    serviceType stringrequired

    The service type of the regular rate

    calculationMode numberrequired

    The calculation mode of the regular rate

    feePerStop numberrequired

    The fee per stop of the regular rate

    extraWaitTimeFee numberrequired

    The extra wait time fee of the regular rate

    priceAdjustment objectrequired
    isActive boolean
    minimumPercent number
    maximumPercent number
    value number

    Default value: 0

    startingFee numberrequired

    The starting fee of the regular rate

    minimumFee numberrequired

    The minimum fee of the regular rate

    feePerMinute numberrequired

    The fee per minute of the regular rate

    feePerDistance numberrequired

    The fee per distance of the regular rate

    speedThreshold numberrequired

    The speed threshold of the regular rate

    fareMode stringrequired

    The fare mode of the regular rate

    distanceTier string[]required

    The distance tier of the regular rate

    startDate stringrequired

    The start date of the regular rate

    endDate stringrequired

    The end date of the regular rate

    startTime stringrequired

    The start time of the regular rate

    endTime stringrequired

    The end time of the regular rate

    currencyISO stringrequired

    The currency ISO of the regular rate

    currencySymbol stringrequired

    The currency symbol of the regular 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 regular rate

    dropOffZoneIds string[]required

    The drop off zone IDs of the regular rate

    createdDate date-timerequired

    The created date of the regular rate

    latestUpdate date-timerequired

    The latest update date of the regular rate

Loading...