> ## Documentation Index > Fetch the complete documentation index at: https://docs.lexio.rent/llms.txt > Use this file to discover all available pages before exploring further. # Lister les forfaits kilométriques > **Accès** : `catalog.read` · Fonctionnalité d’abonnement : `mileage.basic` ([plans](https://docs.lexio.rent/authentification)) Liste les forfaits kilométriques de l’organisation. Tri : `displayOrder`, `name`, puis `id`. `isActive` filtre (`true` ou `false`, omis : tous). ## OpenAPI ````yaml /openapi.json get /mileage-packages openapi: 3.1.0 info: title: API Lexio version: 1.0.1 description: >- # API Lexio v1 L’API Lexio permet à un loueur de véhicules, ou à une plateforme partenaire autorisée par lui, de chiffrer, réserver, suivre et administrer ses locations depuis un serveur. Chaque appel agit sur l’organisation Lexio d’un seul loueur. - **Adresse de base** : `https://api.lexio.rent/api/external/v1` - **Authentification** : `Authorization: Bearer lck_…`, une clé créée par le loueur dans Lexio. - **Format** : JSON en UTF-8 ; erreurs RFC 9457 avec un `code` stable. - **Spécification OpenAPI 3.1** : [https://docs.lexio.rent/openapi.json](https://docs.lexio.rent/openapi.json), à importer dans votre client HTTP ou à utiliser pour générer un client. - **Contact** (support technique, demande d’accès, organisation de test) : contact@lexio.rent. Vocabulaire : une **location** (`/rentals`) est un contrat de location d’un véhicule ; un **lieu** (`/locations`) est une adresse de départ ou de retour. ## Guides 1. [Démarrage rapide](https://docs.lexio.rent/demarrage-rapide) : de la recherche d’un véhicule à l’annulation. 2. [Authentification et scopes](https://docs.lexio.rent/authentification) : clés du loueur et clés partenaires, scopes, plans. 3. [Montants et TVA](https://docs.lexio.rent/montants-et-tva) : HT, TTC, devises, caution et franchise. 4. [Cycle de vie d’une location](https://docs.lexio.rent/cycle-de-vie) : statuts et actions possibles. 5. [Limites de débit](https://docs.lexio.rent/limites), [Pagination](https://docs.lexio.rent/pagination), [Idempotence et reprise](https://docs.lexio.rent/idempotence). 6. [Synchronisation par événements](https://docs.lexio.rent/synchronisation) : suivre les changements sans webhook. 7. [Versions et évolutions](https://docs.lexio.rent/versions), [Erreurs](https://docs.lexio.rent/erreurs). 8. [Intégration d’une plateforme de réservation](https://docs.lexio.rent/integration-broker) : parcours partenaire, paiement. 9. [Ce qui se gère dans Lexio](https://docs.lexio.rent/ce-qui-se-gere-dans-lexio) et [Historique des versions](https://docs.lexio.rent/historique). contact: name: Support Lexio email: contact@lexio.rent url: https://docs.lexio.rent servers: - url: https://api.lexio.rent/api/external/v1 description: Production security: - ApiKey: [] tags: - name: Organisation description: >- Réglages de l’organisation liée à la clé : devise, fuseau, TVA, horaires, règles de réservation. - name: Offre description: >- Disponibilités et devis : ce qui est réservable, à quel prix, avant de créer une location. - name: Locations description: >- Les contrats de location : création, lecture, modification de notes, suppression. - name: Modifications description: >- Changer les dates, le véhicule, la protection, le titulaire ou les options d’une location, ou l’annuler. - name: Départ et retour description: >- Remise des clés et retour du véhicule : kilométrage, carburant, photos, état des lieux. - name: Paiements description: Encaissements, cautions et remboursements enregistrés sur une location. - name: Événements description: >- Flux des changements à relire pour synchroniser votre système, sans webhook. - name: Clients description: Fiches des clients particuliers et entreprises. - name: Flotte description: Véhicules, leur archivage et leurs indisponibilités. - name: Catalogue description: >- Catégories, lieux, options, franchises, cautions et forfaits kilométriques proposés à la location. - name: Tarification description: Saisons, remises de durée, paliers de délai et réglages de prix. - name: Entretien description: Alertes et historique d’entretien des véhicules. paths: /mileage-packages: get: tags: - Catalogue summary: Lister les forfaits kilométriques description: >- **Accès** : `catalog.read` · Fonctionnalité d’abonnement : `mileage.basic` ([plans](https://docs.lexio.rent/authentification)) Liste les forfaits kilométriques de l’organisation. Tri : `displayOrder`, `name`, puis `id`. `isActive` filtre (`true` ou `false`, omis : tous). operationId: listMileagePackages parameters: - in: query name: limit schema: type: integer minimum: 1 maximum: 100 default: 50 description: Taille de la page, de 1 à 100 ; 50 par défaut. - in: query name: cursor schema: type: string minLength: 1 maxLength: 4096 description: >- Valeur `nextCursor` de la page précédente ; omis pour la première page. - in: query name: isActive schema: description: >- `true` : actifs seulement ; `false` : inactifs seulement ; omis : tous. type: string enum: - 'true' - 'false' description: >- `true` : actifs seulement ; `false` : inactifs seulement ; omis : tous. responses: '200': description: Lister les forfaits kilométriques headers: X-Request-Id: $ref: '#/components/headers/XRequestId' RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' content: application/json: schema: type: object properties: data: maxItems: 100 type: array items: $ref: '#/components/schemas/MileagePackage' nextCursor: description: >- Curseur de la page suivante, à passer tel quel en `cursor` ; null en fin de liste. Voir [Pagination](https://docs.lexio.rent/pagination). examples: - eyJpZCI6IjljMmQ3ZTRhIn0 anyOf: - type: string minLength: 1 - type: 'null' required: - data - nextCursor '400': description: '`VALIDATION_FAILED`' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' content: application/problem+json: schema: $ref: '#/components/schemas/ValidationFailedProblem' '401': description: >- `API_KEY_DISABLED`, `API_KEY_EXPIRED`, `API_KEY_INVALID`, `API_KEY_MISSING`, `API_KEY_REVOKED` headers: X-Request-Id: $ref: '#/components/headers/XRequestId' RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' WWW-Authenticate: $ref: '#/components/headers/WwwAuthenticate' content: application/problem+json: schema: oneOf: - $ref: '#/components/schemas/ApiKeyDisabledProblem' - $ref: '#/components/schemas/ApiKeyExpiredProblem' - $ref: '#/components/schemas/ApiKeyInvalidProblem' - $ref: '#/components/schemas/ApiKeyMissingProblem' - $ref: '#/components/schemas/ApiKeyRevokedProblem' '403': description: >- `FEATURE_NOT_AVAILABLE`, `INSUFFICIENT_SCOPE`, `ORGANIZATION_SUSPENDED` headers: X-Request-Id: $ref: '#/components/headers/XRequestId' RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' content: application/problem+json: schema: oneOf: - $ref: '#/components/schemas/FeatureNotAvailableProblem' - $ref: '#/components/schemas/InsufficientScopeProblem' - $ref: '#/components/schemas/OrganizationSuspendedProblem' '429': description: '`RATE_LIMITED`' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/problem+json: schema: $ref: '#/components/schemas/RateLimitedProblem' '500': description: '`INTERNAL_ERROR`' headers: X-Request-Id: $ref: '#/components/headers/XRequestId' RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' content: application/problem+json: schema: $ref: '#/components/schemas/InternalErrorProblem' security: - ApiKey: [] components: headers: XRequestId: description: Identifiant de la requête, à communiquer au support. schema: type: string RateLimitLimit: description: Plafond du seau de débit qui s’applique à la requête. schema: type: integer minimum: 0 RateLimitRemaining: description: Requêtes encore permises dans la fenêtre en cours. schema: type: integer minimum: 0 RateLimitReset: description: Secondes avant la remise à zéro de la fenêtre. schema: type: integer minimum: 0 WwwAuthenticate: description: >- Schéma d’authentification attendu (`Bearer`), avec `error="invalid_token"` pour une clé refusée. schema: type: string RetryAfter: description: Secondes à attendre avant de rejouer la requête. schema: type: integer minimum: 0 schemas: MileagePackage: examples: - id: 5b7c9d1e-2f3a-4b5c-8d6e-7f8091a2b3c4 currency: EUR name: 200 km/jour description: Kilométrage illimité à partir de 30 jours price: mode: FIXED_PER_DAY amountHT: 0 tiers: - fromDay: 1 dailyKm: 200 - fromDay: 30 dailyKm: null isDefault: true isActive: true displayOrder: 0 updatedAt: '2026-10-21T11:36:52+02:00' type: object properties: id: description: Identifiant du forfait kilométrique. type: string format: uuid currency: description: >- Devise ISO 4217 : tous les montants de la ressource sont dans cette devise. examples: - EUR type: string enum: - EUR - XPF - CHF - CAD - GBP - USD - XOF name: description: Nom affiché au client. type: string minLength: 1 maxLength: 100 description: description: Description libre ; null si absente. anyOf: - type: string maxLength: 500 - type: 'null' price: description: Prix HT du forfait pour le client. oneOf: - type: object properties: mode: description: Prix fixe par jour facturé. type: string const: FIXED_PER_DAY amountHT: description: 'Prix HT par jour facturé ; 0 : offert.' type: number required: - mode - amountHT - type: object properties: mode: description: Pourcentage du prix de location du véhicule. type: string const: PERCENT_OF_RENTAL percent: description: >- Pourcentage du prix HT de location du véhicule, hors options. Au plus 2 décimales. type: number minimum: 0.01 maximum: 100 required: - mode - percent type: object tiers: description: >- Kilomètres inclus par jour selon la durée : s’applique le palier de plus grand `fromDay` atteint par les jours facturés. Le palier du jour 1 est obligatoire, un palier par jour. minItems: 1 maxItems: 20 type: array items: type: object properties: fromDay: description: >- Le palier vaut pour une location d’au moins ce nombre de jours facturés. type: integer minimum: 1 dailyKm: description: >- Kilomètres inclus par jour facturé ; null : kilométrage illimité. anyOf: - type: integer minimum: 0 - type: 'null' required: - fromDay - dailyKm isDefault: description: >- Forfait retenu quand une offre omet `mileagePackageId`. Au plus un par organisation : en désigner un autre retire ce statut à l’ancien ; un forfait par défaut est toujours actif. type: boolean isActive: description: 'false : forfait retiré de la vente.' type: boolean displayOrder: description: Rang d’affichage ; ordre de la liste. type: integer minimum: 0 updatedAt: examples: - '2026-11-10T10:00:00+01:00' description: Dernière modification. type: string format: date-time required: - id - currency - name - description - price - tiers - isDefault - isActive - displayOrder - updatedAt ValidationFailedProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/validation-failed title: type: string const: Requête invalide status: type: number const: 400 code: type: string const: VALIDATION_FAILED detail: type: string instance: type: string requestId: type: string errors: minItems: 1 maxItems: 100 type: array items: type: object properties: pointer: type: string code: type: string enum: - required - invalid_type - invalid_format - invalid_value - too_small - too_big - too_many_decimals - out_of_range - unknown_field - null_not_allowed - empty_string - empty_patch - mutually_exclusive - not_applicable - duplicate - end_before_start - date_in_past - nonexistent_local_time - offset_not_allowed - offset_required - upload_expired - upload_incomplete - upload_conflict detail: type: string required: - pointer - code - detail required: - type - title - status - code - detail - instance - requestId - errors ApiKeyDisabledProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/api-key-disabled title: type: string const: Clé API désactivée status: type: number const: 401 code: type: string const: API_KEY_DISABLED detail: type: string instance: type: string requestId: type: string required: - type - title - status - code - detail - instance - requestId ApiKeyExpiredProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/api-key-expired title: type: string const: Clé API expirée status: type: number const: 401 code: type: string const: API_KEY_EXPIRED detail: type: string instance: type: string requestId: type: string required: - type - title - status - code - detail - instance - requestId ApiKeyInvalidProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/api-key-invalid title: type: string const: Clé API invalide status: type: number const: 401 code: type: string const: API_KEY_INVALID detail: type: string instance: type: string requestId: type: string required: - type - title - status - code - detail - instance - requestId ApiKeyMissingProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/api-key-missing title: type: string const: Clé API absente status: type: number const: 401 code: type: string const: API_KEY_MISSING detail: type: string instance: type: string requestId: type: string required: - type - title - status - code - detail - instance - requestId ApiKeyRevokedProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/api-key-revoked title: type: string const: Clé API révoquée status: type: number const: 401 code: type: string const: API_KEY_REVOKED detail: type: string instance: type: string requestId: type: string required: - type - title - status - code - detail - instance - requestId FeatureNotAvailableProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/feature-not-available title: type: string const: Fonctionnalité non incluse status: type: number const: 403 code: type: string const: FEATURE_NOT_AVAILABLE detail: type: string instance: type: string requestId: type: string feature: type: string minLength: 1 required: - type - title - status - code - detail - instance - requestId - feature InsufficientScopeProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/insufficient-scope title: type: string const: Scope insuffisant status: type: number const: 403 code: type: string const: INSUFFICIENT_SCOPE detail: type: string instance: type: string requestId: type: string requiredScopes: minItems: 1 maxItems: 20 type: array items: type: string enum: - offers.read - quotes.write - rentals.read - rentals.write - rentals.operate - rentals.delete - payments.write - payments.refund - customers.read - customers.write - customers.delete - vehicles.read - vehicles.write - vehicles.delete - catalog.read - catalog.write - pricing.read - pricing.write - maintenance.read - maintenance.write required: - type - title - status - code - detail - instance - requestId - requiredScopes OrganizationSuspendedProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/organization-suspended title: type: string const: Organisation suspendue status: type: number const: 403 code: type: string const: ORGANIZATION_SUSPENDED detail: type: string instance: type: string requestId: type: string required: - type - title - status - code - detail - instance - requestId RateLimitedProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/rate-limited title: type: string const: Trop de requêtes status: type: number const: 429 code: type: string const: RATE_LIMITED detail: type: string instance: type: string requestId: type: string limit: type: string enum: - PRE_AUTH - PER_KEY - WRITE - QUOTE windowSeconds: type: integer minimum: 1 retryAfter: type: integer minimum: 0 required: - type - title - status - code - detail - instance - requestId - limit - windowSeconds - retryAfter InternalErrorProblem: type: object properties: type: type: string const: https://api.lexio.rent/errors/internal-error title: type: string const: Erreur interne status: type: number const: 500 code: type: string const: INTERNAL_ERROR detail: type: string instance: type: string requestId: type: string required: - type - title - status - code - detail - instance - requestId securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: lck_… description: >- Clé API `lck_…` créée dans Lexio (Paramètres → Développeur), envoyée en `Authorization: Bearer`. Voir [Authentification](https://docs.lexio.rent/authentification). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.