openapi: 3.1.0
info:
  title: Autopay Accounting Vehicle API
  version: 1.0.0
  description: Autopay is a Norwegian parking payment and management platform that provides APIs for parking operators, landlords, fleet managers, and third-party integrators. The platform exposes several distinct REST APIs covering parking, payment, permits, fleet, booking, customer club, statistics, accounting, vehicle status, and zone status. Authentication is OAuth 2.0 Client Credentials with access tokens minted from the authorization server.
  contact:
    name: Autopay Developer Portal
    url: https://developer.autopay.io
  license:
    name: Autopay API Usage Agreement
    url: https://developer.autopay.io
servers:
- url: https://api.autopay.io
  description: Autopay API production base URL
security:
- OAuth2: []
tags:
- name: Vehicle
  description: Vehicle permit and session lookups
paths:
  /vehicle/v1/permit:
    get:
      tags:
      - Vehicle
      summary: Look up vehicle permit and active session in a zone
      parameters:
      - name: vehicle
        in: query
        required: true
        schema:
          type: string
        description: Vehicle registration / license plate
      - name: zone_id
        in: query
        required: true
        schema:
          type: integer
        description: Parking zone ID (can be repeated for multiple zones)
      responses:
        '200':
          description: Permit and session status
      security:
      - OAuth2: []
components:
  securitySchemes:
    OAuth2:
      type: oauth2
      description: OAuth 2.0 Client Credentials flow. Tokens are minted from the Auth0 token endpoint and used as Bearer tokens with `audience` set to `https://api.autopay.io`. Some endpoints require specific scopes such as `permit_booking`, `customer_club`, or `zone_status`.
      flows:
        clientCredentials:
          tokenUrl: https://api-auth.autopay.io/oauth/token
          scopes:
            permit_booking: Required for Booking API operations
            customer_club: Required for Customer Club API operations
            zone_status: Required for Status API operations