gbfs-v3/dev.sargunv.mobilitydata.gbfs.v3/PricingPlan

PricingPlan

data class PricingPlan(val planId: String, val url: Url? = null, val name: LocalizedText, val currency: CurrencyCode, val price: Decimal, val isTaxable: Boolean, val description: LocalizedText, val perKmPricing: List<PricingInterval>? = null, val perMinPricing: List<PricingInterval>? = null, val surgePricing: Boolean? = null, val reservationPricePerMin: Decimal? = null, val reservationPriceFlatRate: Decimal? = null, val fareCapping: FareCapping? = null)(source)

A pricing plan for renting vehicles.

Constructors

constructor(planId: String, url: Url? = null, name: LocalizedText, currency: CurrencyCode, price: Decimal, isTaxable: Boolean, description: LocalizedText, perKmPricing: List<PricingInterval>? = null, perMinPricing: List<PricingInterval>? = null, surgePricing: Boolean? = null, reservationPricePerMin: Decimal? = null, reservationPriceFlatRate: Decimal? = null, fareCapping: FareCapping? = null)

Properties

val currency: CurrencyCode

Currency used to pay the fare.

val description: LocalizedText

Customer-readable description of the pricing plan.

@SerialName(value = "fare_capping")

@ExperimentalMobilityDataApi

val fareCapping: FareCapping?

A capped fare once a price threshold has been spent within a timeframe.

@SerialName(value = "is_taxable")

val isTaxable: Boolean

Will additional tax be added to the base price?

val name: LocalizedText

Name of this pricing plan.

@SerialName(value = "per_km_pricing")

val perKmPricing: List<PricingInterval>?

Array of segments when the price is a function of distance traveled, displayed in kilometers.

@SerialName(value = "per_min_pricing")

val perMinPricing: List<PricingInterval>?

Array of segments when the price is a function of time traveled, displayed in minutes.

@SerialName(value = "plan_id")

val planId: String

Identifier for a pricing plan in the system.

val price: Decimal

Fare price, in the unit specified by currency.

reservationPriceFlatRate

@SerialName(value = "reservation_price_flat_rate")

@ExperimentalMobilityDataApi

val reservationPriceFlatRate: Decimal?

The cost, described as a flat rate, to reserve the vehicle prior to beginning a rental.

reservationPricePerMin

@SerialName(value = "reservation_price_per_min")

@ExperimentalMobilityDataApi

val reservationPricePerMin: Decimal?

The cost, described as a per minute rate, to reserve the vehicle prior to beginning a rental.

@SerialName(value = "surge_pricing")

val surgePricing: Boolean?

Is there currently an increase in price in response to increased demand in this pricing plan?

val url: Url?

URL where the customer can learn more about this pricing plan.