List Price Policies
Query Parameters
Page number (minimum: 1)
Items per page (minimum: 1, maximum: 100)
Filter by scope type:
GLOBAL, CITY, or ZONEFilter by city UUID (for CITY-scoped policies)
Filter by zone UUID (for ZONE-scoped policies)
Filter by active status
Free text search by name (case-insensitive)
Response
Returns a paginated list of price policies with metadata.Get Price Policy by ID
Path Parameters
Price policy UUID
Response
Returns the complete price policy including conditions and pricing rules.Create Price Policy
Body Parameters
Policy name (max 140 characters)
Scope type:
GLOBAL, CITY, or ZONECity UUID (required when scopeType is CITY)
Zone UUID (required when scopeType is ZONE)
Whether the policy is active
Policy priority (0-100000). Higher priority policies take precedence
Start date/time for policy validity (ISO 8601 format)
End date/time for policy validity (ISO 8601 format)
IANA timezone for time-based conditions
Conditions for when this policy applies. Supports:
days_of_week: Array of day numbers (1-7, where 1 is Monday)time_ranges: Array of time ranges withstartandendin HH:MM formatdates: Array of specific dates in YYYY-MM-DD formatdate_ranges: Array of date ranges withfromandtodatesexclude_dates: Array of dates to exclude in YYYY-MM-DD format
Pricing structure. Supports:
base_fare: Base fare amountper_km: Price per kilometerper_minute: Price per minuteminimum_fare: Minimum fare amountbooking_fee: Flat booking feenight_surcharge: Additional charge for night ridescap: Maximum fare cap
UUID of the user creating this policy
Scope Coherence Rules
- GLOBAL: Both
cityIdandzoneIdmust be null - CITY:
cityIdmust be provided,zoneIdmust be null - ZONE:
zoneIdmust be provided,cityIdmust be null
Response
Response status
The created price policy object
Error Responses
- 409 Conflict: Scope coherence violation or constraint conflict
- 400 Bad Request: Validation error
Update Price Policy
Path Parameters
Price policy UUID
Body Parameters
All parameters are optional (partial update). See Create Price Policy for parameter details.Policy name
Scope type: GLOBAL, CITY, or ZONE
City UUID
Zone UUID
Whether the policy is active
Policy priority (0-100000)
Start date/time for policy validity
End date/time for policy validity
IANA timezone
Conditions object
Pricing structure
UUID of the user updating this policy
Response
Returns the updated price policy object.Error Responses
- 409 Conflict: Scope coherence violation
- 400 Bad Request: Validation error
Set Active Status
Path Parameters
Price policy UUID
Body Parameters
Set to true to activate, false to deactivate