---
title: "QR Suisse API: versioning and deprecation policy"
description: "How the QR Suisse REST API (v1) is versioned, and how an operation, a parameter or a major version is deprecated before it is withdrawn. This document is generated from the OpenAPI specification of the API, which prevails in case of doubt."
canonical: "https://www.qrsuisse.ch/docs/deprecation"
last-updated: "2026-11-11"
---

# QR Suisse API: versioning and deprecation policy

> How the QR Suisse REST API (v1) is versioned, and how an operation, a parameter or a major version is deprecated before it is withdrawn. This document is generated from the OpenAPI specification of the API, which prevails in case of doubt.

- Current version of the API: 1.3.1 (`info.version` of the specification)
- OpenAPI specification: https://www.qrsuisse.ch/openapi.json
- API documentation, with the "Version history": https://www.qrsuisse.ch/en/api-documentation

## Versioning and deprecation

The major version is part of the address of the API (`/api/v1`). Within v1, minor and patch
versions follow the rules described in "Version history": an integration written for v1 keeps
working. An incompatible change would be released as a new major version, at another address; an
element of v1 is only withdrawn from it after a deprecation, under the rules below.

Each new version is announced in "Version history", with its month of release, its new
features and its changes in behaviour. The current version is the one given in
`info.version` of this specification.

**Deprecation.** An operation, a parameter or a major version is only withdrawn after being
deprecated, with a notice period of at least 6 months between the announcement of the
deprecation and the withdrawal. During this notice period, the deprecated element keeps
working normally, and:
- it is marked `deprecated` in this specification, and the deprecation is announced in
  "Version history", with the withdrawal date and how to migrate;
- the responses of the operation concerned carry the `Deprecation` header (RFC 9745) with
  the date of the deprecation, the `Sunset` header (RFC 8594) with the withdrawal date, and
  a `Link` header with `rel="deprecation"` pointing to the migration documentation.

**Exceptions.** This notice period may only be shortened, or an element withdrawn without
notice, where this is necessary to fix a security vulnerability or protect the data of accounts,
to comply with a legal obligation or a decision of an authority, or because a provider or a
standard on which the element depends (hosting provider, certificate authority, technical
standard) changes or removes it without leaving us this period. We then announce it as soon as
possible in "Version history", and we limit the change to what is necessary. These rules do not
cover an account's access to the API, which depends on its subscription and on the terms and
conditions (end of subscription, suspension, key revocation); they apply within the framework of
the terms and conditions, which prevail in case of conflict.

No operation is deprecated today.

## See also

- [API documentation](https://www.qrsuisse.ch/en/api-documentation)
- [OpenAPI specification (YAML)](https://www.qrsuisse.ch/openapi.yaml)
- [API section index (llms.txt)](https://www.qrsuisse.ch/docs/llms.txt)