openapi: 3.1.0
info:
  title: SystemPricingPlan
  version: 2.0.0
  description: Schema definition for the SystemPricingPlan entity in the Beckn Mobility
  license:
    name: CC-BY-NC-SA 4.0 International
    url: https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en
  contact:
    name: Beckn Labs
    url: https://beckn.io
components:
  schemas:
    SystemPricingPlan:
      x-iri: https://schema.nfh.global/SystemPricingPlan/v2.0
      type: object
      title: SystemPricingPlan
      description: A pricing plan defined by a shared mobility system, describing
        costs and billing rules for vehicle use.
      x-tags:
        - mobility
        - schema-org
        - ride-hailing
      properties:
        planId:
          description: Unique identifier for the pricing plan
          type: string
        currency:
          description: ISO 4217 currency code
          type: string
        isTaxable:
          description: Whether tax is applied to this pricing plan
          type: boolean
        perMinuteChargingRate:
          description: Charge per minute of vehicle use
          type: number
        perKmChargingRate:
          description: Charge per kilometre of vehicle use
          type: number
        perTripStartingFee:
          description: Flat fee charged at the start of each trip
          type: number
        id:
          description: Unique identifier for the offer
          type: string
        descriptor:
          description: Human-readable description of the offer
          $ref: https://schema.nfh.global/Descriptor/v2.0/attributes.yaml#/components/schemas/Descriptor
        price:
          description: Price specification for this offer
          $ref: https://schema.nfh.global/PriceSpecification/v2.1/attributes.yaml#/components/schemas/PriceSpecification
        validity:
          description: Validity period of the offer
          $ref: https://schema.nfh.global/TimePeriod/v2.0/attributes.yaml#/components/schemas/TimePeriod
        tags:
          description: Tags or labels associated with the offer
          type: string
      additionalProperties: false