Ride-Share Discounts

Taxi & Private Hire › Products › Pricing › Ride-Share Discounts

Generally available

Multi-load trips charge each passenger individually for their own segment; a Ride-Share Discount reduces each passenger's fare in exchange for the shared ride. Operators configure base discount value, per-additional-segment value, minimum segment threshold, and an optional cap on the maximum discount percentage. An uplift percentage on the original metered price covers the operational complexity of building the shared route. Selection is by decision tree at quote time.

Example request

POST /client/{clientId}/ridesharediscountmodel ▷ Try it

{
  "discountType": "PERCENTAGE",
  "baseDiscountValue": 0,
  "perAdditionalSegmentValue": 0,
  "maxDiscountPercentage": 0,
  "minSegmentsToApply": 0,
  "name": "<string>",
  "priority": 0,
  "decisionTree": {},
  "active": false,
  "upliftPercentage": 0
}

Example shape, derived from the RideShareDiscountModel fields — indicative, not the authoritative schema (that arrives with the API reference).

Endpoints

Method	Path
POST	/client/{clientId}/ridesharediscountmodel · primary	▷ Try it
DELETE	/client/{clientId}/ridesharediscountmodel/{id}	▷ Try it
GET	/client/{clientId}/ridesharediscountmodel/{id}	▷ Try it
GET	/client/{clientId}/ridesharediscountmodel	▷ Try it
POST	/client/{clientId}/ridesharediscountmodel/{id}	▷ Try it

Full request/response schemas and an interactive explorer will live in the API reference (coming soon).

Related

• Single-Priced Discounts
• Multi-Load Trips

Fields

Field	Type	Description
discountType	DiscountValueType · PERCENTAGE | ABSOLUTE
baseDiscountValue	integer
perAdditionalSegmentValue	integer
maxDiscountPercentage	integer
minSegmentsToApply	integer
name	string
priority	integer
decisionTree	JsonStorage
active	bool
upliftPercentage	integer
clientId	bigint	Tenant scope. Every tenant-aware entity carries this; `ClientFilter` enforces row-level isolation on read; the multi-tenancy routing layer (`/client/{clientId}`) sets it at create time. Surfaced only under `admin` / `tripLog` groups — never to end users.
internalKey	string	Optional client-supplied external reference / idempotency key. When present, lets external systems correlate platform-side records back to their own source-of-truth ids. Not persisted to a column — populated by the request handler when the caller sets it.
__objectType	string	Discriminator string (entity class short-name) emitted alongside the id in serialized output. Resolved at read time by `getObjectType()`; lets the FE dispatch entity-specific rendering without inspecting the URL.
id	bigint	Snowflake-style primary key (unsigned BIGINT). Generated by `IdFactory` at create time; surfaced to the FE / API as a `G`-prefixed string and stripped back to plain bigint server-side before Doctrine lookup.
createdDate	integer	Unix timestamp the row was first persisted. Set in the entity's PrePersist hook; never rewritten on subsequent updates.
updatedDate	integer	Unix timestamp the row was last touched. Bumped on every commit that hits the Doctrine UoW for this entity; drives FE invalidation + the listing change cursor.
passiveUpdatedDate	int	Read-through alias for `updatedDate` exposed under different serializer groups. Lets the FE distinguish "real edit" from "background touch" projections without changing the underlying column.
listingUpdatedDate	int	Listing-projection timestamp surfaced only under the `listMode` group. Driven by `TripCache` and other listing-shape refreshers separately from `updatedDate` so a listing rebuild doesn't trigger detail-page invalidation.