Single-Priced Discounts
Taxi & Private Hire › Products › Pricing › Single-Priced Discounts
Generally available
For trips priced as a single total (not per-segment) — a Single-Priced Discount controls how the trip total is shared back across the passengers. Strategies: EQUAL_SPLIT (the total divided equally), WEIGHTED_BY_DISTANCE (each passenger pays for their own leg as a share of the trip total). Uplift percentage on the original metered price covers shared-ride operational cost. Selection is decision-tree based at quote time.
Example request
POST /client/{clientId}/singlepricedsharediscountmodel
{
"shareStrategy": "EQUAL_SPLIT",
"name": "<string>",
"priority": 0,
"decisionTree": {},
"active": false,
"upliftPercentage": 0
}
Example shape, derived from the SinglePricedShareDiscountModel fields — indicative,
not the authoritative schema (that arrives with the API reference).
Endpoints
| Method | Path | |
|---|---|---|
POST | /client/{clientId}/singlepricedsharediscountmodel · primary | |
DELETE | /client/{clientId}/singlepricedsharediscountmodel/{id} | |
GET | /client/{clientId}/singlepricedsharediscountmodel/{id} | |
GET | /client/{clientId}/singlepricedsharediscountmodel | |
POST | /client/{clientId}/singlepricedsharediscountmodel/{id} |
Full request/response schemas and an interactive explorer will live in the API reference (coming soon).
Related
Fields
| Field | Type | Description |
|---|---|---|
shareStrategy | SinglePricedShareStrategy · EQUAL_SPLIT | WEIGHTED_BY_DISTANCE | |
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. |