PPv2: Handle payment execution/capture calls properly even if no captures are present yet.

* reduce default RecentAuthenticationRequiredMixin timeout to 15 min
* never cache pages with RecentAuthenticationRequiredMixin
* show emergency codes only once after generating

.clabot

@@ -1,5 +1,5 @@
 {
   "contributors": "https://crm.rami.io/cla/check/?project=pretix&checkContributor=",
-  "message": "Hey there! :) Thank you very much for offering a contribution to pretix! For legal reasons, we need you to sign a Contributor License Agreement in order to be able to merge the code. Sorry for the hassle :( Please download the agreement from https://pretix.eu/about/en/cla and send a signed copy to support@pretix.eu. Feel free to also contact us there or via comments here if you have any questions!",
+  "message": "Hey there! :) Thank you very much for offering a contribution to pretix! For legal reasons, we need you to sign a Contributor License Agreement in order to be able to merge the code. Sorry for the hassle :( Please download the agreement from https://pretix.eu/about/en/cla and send a signed copy to support@pretix.eu. Feel free to also contact us there or via comments here if you have any questions!\n\nFeel free to ignore me on documentation changes, translations, and trivial PRs like typo fixes (and similar single-line changes) – we can merge these without a CLA as well.",
   "label": "cla-signed"
 }

.github/dependabot.yml

@@ -10,7 +10,9 @@ updates:
     schedule:
       interval: "daily"
     versioning-strategy: increase
+    open-pull-requests-limit: 10
   - package-ecosystem: "npm"
     directory: "/src/pretix/static/npm_dir"
     schedule:
       interval: "monthly"
+    open-pull-requests-limit: 5

.github/workflows/build.yml

@@ -26,19 +26,19 @@ jobs:
       matrix:
         python-version: ["3.11"]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - uses: actions/cache@v1
+      - uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system dependencies
-        run: sudo apt update && sudo apt install gettext unzip
+        run: sudo apt update && sudo apt install -y gettext unzip
       - name: Install Python dependencies
         run: pip3 install -U setuptools build pip check-manifest
       - name: Run check-manifest

.github/workflows/docs.yml

@@ -25,19 +25,19 @@ jobs:
     name: Spellcheck
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python 3.11
-        uses: actions/setup-python@v1
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.13
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.11
-      - uses: actions/cache@v1
+          python-version: 3.13
+      - uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system packages
-        run: sudo apt update && sudo apt install enchant-2 hunspell aspell-en
+        run: sudo apt update && sudo apt install -y enchant-2 hunspell aspell-en
       - name: Install Dependencies
         run: pip3 install -Ur requirements.txt
         working-directory: ./doc

.github/workflows/strings.yml

@@ -23,21 +23,21 @@ jobs:
     runs-on: ubuntu-22.04
     name: Check gettext syntax
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python 3.11
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
           python-version: 3.11
-      - uses: actions/cache@v1
+      - uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system packages
-        run: sudo apt update && sudo apt install gettext
+        run: sudo apt update && sudo apt -y install gettext
       - name: Install Dependencies
-        run: pip3 install -e ".[dev]"
+        run: pip3 install uv && uv pip install --system -e ".[dev]"
       - name: Compile messages
         run: python manage.py compilemessages
         working-directory: ./src
@@ -48,12 +48,12 @@ jobs:
     runs-on: ubuntu-22.04
     name: Spellcheck
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python 3.11
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
           python-version: 3.11
-      - uses: actions/cache@v1
+      - uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
@@ -62,7 +62,7 @@ jobs:
       - name: Install system packages
         run: sudo apt update && sudo apt install enchant-2 hunspell hunspell-de-de aspell-en aspell-de
       - name: Install Dependencies
-        run: pip3 install -e ".[dev]"
+        run: pip3 install uv && uv pip install --system -e ".[dev]"
       - name: Spellcheck translations
         run: potypo
         working-directory: ./src

.github/workflows/style.yml

@@ -23,19 +23,19 @@ jobs:
     name: isort
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python 3.11
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
           python-version: 3.11
-      - uses: actions/cache@v1
+      - uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install Dependencies
-        run: pip3 install -e ".[dev]" psycopg2-binary
+        run: pip3 install uv && uv pip install --system -e ".[dev]" psycopg2-binary
       - name: Run isort
         run: isort -c .
         working-directory: ./src
@@ -43,19 +43,19 @@ jobs:
     name: flake8
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python 3.11
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
           python-version: 3.11
-      - uses: actions/cache@v1
+      - uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install Dependencies
-        run: pip3 install -e ".[dev]" psycopg2-binary
+        run: pip3 install uv && uv pip install --system -e ".[dev]" psycopg2-binary
       - name: Run flake8
         run: flake8 .
         working-directory: ./src
@@ -63,9 +63,9 @@ jobs:
     name: licenseheaders
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python 3.11
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
           python-version: 3.11
       - name: Install Dependencies

.github/workflows/tests.yml

@@ -5,7 +5,6 @@ on:
     branches: [ master ]
     paths-ignore:
       - 'doc/**'
-      - 'src/pretix/locale/**'
   pull_request:
     branches: [ master ]
     paths-ignore:
@@ -24,36 +23,42 @@ jobs:
     name: Tests
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.10", "3.11", "3.13"]
         database: [sqlite, postgres]
         exclude:
-          - database: sqlite
-            python-version: "3.9"
           - database: sqlite
             python-version: "3.10"
+          - database: sqlite
+            python-version: "3.11"
+    services:
+      postgres:
+        image: postgres:15
+        env:
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: pretix
+        options: >-
+          --health-cmd "pg_isready -U postgres -d pretix"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
     steps:
-      - uses: actions/checkout@v2
-      - uses: harmon758/postgresql-action@v1
-        with:
-          postgresql version: '11'
-          postgresql db: 'pretix'
-          postgresql user: 'postgres'
-          postgresql password: 'postgres'
-        if: matrix.database == 'postgres'
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - uses: actions/cache@v1
+      - uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system dependencies
-        run: sudo apt update && sudo apt install gettext
+        run: sudo apt update && sudo apt install -y gettext
       - name: Install Python dependencies
-        run: pip3 install --ignore-requires-python -e ".[dev]" psycopg2-binary  # We ignore that flake8 needs newer python as we don't run flake8 during tests
+        run: pip3 install uv && uv pip install --system -e ".[dev]" psycopg2-binary
       - name: Run checks
         run: python manage.py check
         working-directory: ./src
@@ -65,11 +70,15 @@ jobs:
         run: make all compress
       - name: Run tests
         working-directory: ./src
-        run: PRETIX_CONFIG_FILE=tests/travis_${{ matrix.database }}.cfg py.test -n 3 -p no:sugar --cov=./ --cov-report=xml --reruns 3 tests --maxfail=100
+        run: PRETIX_CONFIG_FILE=tests/ci_${{ matrix.database }}.cfg py.test -n 3 -p no:sugar --cov=./ --cov-report=xml tests --maxfail=100
+      - name: Run concurrency tests
+        working-directory: ./src
+        run: PRETIX_CONFIG_FILE=tests/ci_${{ matrix.database }}.cfg py.test tests/concurrency_tests/ --reuse-db
+        if: matrix.database == 'postgres'
       - name: Upload coverage
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v4
         with:
           file: src/coverage.xml
           token: ${{ secrets.CODECOV_TOKEN }}
-          fail_ci_if_error: true
+          fail_ci_if_error: false
         if: matrix.database == 'postgres' && matrix.python-version == '3.11'

.gitlab-ci.yml

@@ -1,29 +1,30 @@
-before_script:
 tests:
+    image:
+        name: pretix/ci-image
     stage: test
+    before_script:
+        - pip install -U pip uv
+        - uv pip install --system -U wheel setuptools
     script:
-        - virtualenv env
-        - source env/bin/activate
-        - pip install -U pip wheel setuptools
-        - XDG_CACHE_HOME=/cache pip3 install -e ".[dev]"
+        - uv pip install --system -e ".[dev]"
         - cd src
         - python manage.py check
         - make all compress
-        - py.test --reruns 3 -n 3 tests
-    tags:
-        - python3
+        - PRETIX_CONFIG_FILE=tests/ci_sqlite.cfg py.test -n 3 tests --maxfail=100
     except:
         - pypi
 pypi:
     stage: release
+    image:
+        name: pretix/ci-image
+    before_script:
+        - cat $PYPIRC > ~/.pypirc
+        - pip install -U pip uv
+        - uv pip install --system -U wheel setuptools twine build pretix-plugin-build check-manifest
     script:
-        - cp /keys/.pypirc ~/.pypirc
-        - virtualenv env
-        - source env/bin/activate
-        - pip install -U pip wheel setuptools check-manifest twine
-        - XDG_CACHE_HOME=/cache pip3 install -e ".[dev]"
+        - uv pip install --system -e ".[dev]"
         - python setup.py sdist
-        - pip install dist/pretix-*.tar.gz
+        - uv pip install --system dist/pretix-*.tar.gz
         - python -m pretix migrate
         - python -m pretix check
         - cd src
@@ -33,13 +34,12 @@ pypi:
         - python -m build
         - twine check dist/*
         - twine upload dist/*
-    tags:
-        - python3
     only:
         - pypi
     artifacts:
         paths:
             - src/dist/
+
 stages:
     - test
     - build

.licenseheader

@@ -1,7 +1,7 @@
 This file is part of pretix (Community Edition).
 
-Copyright (C) 2014-2020 Raphael Michel and contributors
-Copyright (C) 2020-2021 rami.io GmbH and contributors
+Copyright (C) 2014-2020  Raphael Michel and contributors
+Copyright (C) 2020-today pretix GmbH and contributors
 
 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General
 Public License as published by the Free Software Foundation in version 3 of the License.

.node-version

@@ -0,0 +1 @@
+17

CODE_OF_CONDUCT.md

@@ -1,5 +1,5 @@
 Code of Conduct
 ===============
 
-We have a [Code of Conduct](https://docs.pretix.eu/en/latest/development/contribution/codeofconduct.html)
+We have a [Code of Conduct](https://docs.pretix.eu/dev/development/contribution/codeofconduct.html)
 in place that applies to all project contributions, including issues, pull requests, etc.

CONTRIBUTING.md

@@ -3,9 +3,9 @@ Contributing to pretix
 
 Hey there and welcome to pretix!
 
-* We've got a contributors guide in [our documentation](https://docs.pretix.eu/en/latest/development/contribution/) together with notes on the [development setup](https://docs.pretix.eu/en/latest/development/setup.html).
+* We've got a contributors guide in [our documentation](https://docs.pretix.eu/dev/development/contribution/) together with notes on the [development setup](https://docs.pretix.eu/dev/development/setup.html).
 
-* Please note that we have a [Code of Conduct](https://docs.pretix.eu/en/latest/development/contribution/codeofconduct.html) in place that applies to all project contributions, including issues, pull requests, etc.
+* Please note that we have a [Code of Conduct](https://docs.pretix.eu/dev/development/contribution/codeofconduct.html) in place that applies to all project contributions, including issues, pull requests, etc.
 
-* Before we can accept a PR from you we'll need you to sign [our CLA](https://pretix.eu/about/en/cla). You can find more information about the how and why in our [License FAQ](https://docs.pretix.eu/en/latest/license/faq.html#) and in our [license change blog post](https://pretix.eu/about/en/blog/20210412-license/).
+* Before we can accept a PR from you we'll need you to sign [our CLA](https://pretix.eu/about/en/cla). You can find more information about the how and why in our [License FAQ](https://docs.pretix.eu/trust/licensing/faq/) and in our [license change blog post](https://pretix.eu/about/en/blog/20210412-license/).
 

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.11-bullseye
+FROM python:3.11-bookworm
 
 RUN apt-get update && \
     apt-get install -y --no-install-recommends \
@@ -20,20 +20,20 @@ RUN apt-get update && \
             supervisor \
             libmaxminddb0 \
             libmaxminddb-dev \
-            zlib1g-dev && \
+            zlib1g-dev \
+            nodejs  \
+            npm && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/* && \
-    dpkg-reconfigure locales && \
-	locale-gen C.UTF-8 && \
-	/usr/sbin/update-locale LANG=C.UTF-8 && \
+    dpkg-reconfigure locales &&  \
+    locale-gen C.UTF-8 &&  \
+    /usr/sbin/update-locale LANG=C.UTF-8 && \
     mkdir /etc/pretix && \
     mkdir /data && \
     useradd -ms /bin/bash -d /pretix -u 15371 pretixuser && \
     echo 'pretixuser ALL=(ALL) NOPASSWD:SETENV: /usr/bin/supervisord' >> /etc/sudoers && \
     mkdir /static && \
-    mkdir /etc/supervisord && \
-	curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash - && \
-    apt-get install -y nodejs
+    mkdir /etc/supervisord
 
 
 ENV LC_ALL=C.UTF-8 \
@@ -63,10 +63,10 @@ RUN pip3 install -U \
 RUN chmod +x /usr/local/bin/pretix && \
     rm /etc/nginx/sites-enabled/default && \
     cd /pretix/src && \
-    rm -f pretix.cfg && \
-	mkdir -p data && \
-    chown -R pretixuser:pretixuser /pretix /data data && \
-	sudo -u pretixuser make production
+    rm -f pretix.cfg &&  \
+    mkdir -p data && \
+    chown -R pretixuser:pretixuser /pretix /data data &&  \
+    sudo -u pretixuser make production
 
 USER pretixuser
 VOLUME ["/etc/pretix", "/data"]

MANIFEST.in

@@ -10,6 +10,8 @@ recursive-include src/pretix/helpers/locale *
 recursive-include src/pretix/base/templates *
 recursive-include src/pretix/control/templates *
 recursive-include src/pretix/presale/templates *
+recursive-include src/pretix/plugins/autocheckin/templates *
+recursive-include src/pretix/plugins/autocheckin/static *
 recursive-include src/pretix/plugins/banktransfer/templates *
 recursive-include src/pretix/plugins/banktransfer/static *
 recursive-include src/pretix/plugins/manualpayment/templates *

README.rst

@@ -5,9 +5,10 @@ pretix
    :target: https://pypi.python.org/pypi/pretix
 
 .. image:: https://github.com/pretix/pretix/workflows/Documentation/badge.svg
-   :target: https://docs.pretix.eu/en/latest/
+   :target: https://docs.pretix.eu/
 
 .. image:: https://github.com/pretix/pretix/workflows/Tests/badge.svg
+   :target: https://github.com/pretix/pretix/actions/workflows/tests.yml
 
 .. image:: https://codecov.io/gh/pretix/pretix/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/pretix/pretix
@@ -56,8 +57,8 @@ License
 The code in this repository is covered by different licenses. Most of it is available to everyone under the terms of
 the GNU AGPL license v3 with additional terms. See the LICENSE file for the complete license details.
 
-.. _installation guide: https://docs.pretix.eu/en/latest/admin/installation/index.html
-.. _developer documentation: https://docs.pretix.eu/en/latest/development/index.html
-.. _Code of Conduct: https://docs.pretix.eu/en/latest/development/contribution/codeofconduct.html
+.. _installation guide: https://docs.pretix.eu/self-hosting/installation/general/
+.. _developer documentation: https://docs.pretix.eu/dev/development/index.html
+.. _Code of Conduct: https://docs.pretix.eu/dev/development/contribution/codeofconduct.html
 .. _pretix.eu: https://pretix.eu
 .. _blog: https://pretix.eu/about/en/blog/

SECURITY.md

@@ -2,11 +2,11 @@
 
 ## Reporting a vulnerability
 
-If you discover a vulnerability with our software or server systems, please report it to us in private. Do not to attempt to harm our users, customer's data or our system's availability when looking for vulneratbilities.
+If you discover a vulnerability with our software or server systems, please report it to us in private. Do not to attempt to harm our users, customer's data or our system's availability when looking for vulnerabilities.
 
 Please contact us at security@pretix.eu with full details and steps to reproduce and allow reasonable time for us to resolve the issue before publishing your findings. If you wish to encrypt your email, you can find our GPG key [here](https://pretix.eu/.well-known/security@pretix.eu.asc).
 
-We're not large enough to run a formal bug bounty program, but if you find a serious vulnerability in our service, we will find a way to show our gratitude. 
+Please also see our [Responsible disclosure policy](https://docs.pretix.eu/trust/security/disclosure/).
 
 ## Version support
 
@@ -18,3 +18,5 @@ subscribe to our [newsletter](https://pretix.eu/about/en/blog/) in the "News abo
 category, we will also send you an email on security issues. 
 
 Past security issues are listed [on our website](https://pretix.eu/about/en/security).
+
+Please also see our [Release cycle](https://docs.pretix.eu/trust/lifecycle/release-cycle/) documentation.

deployment/docker/nginx.conf

@@ -60,6 +60,14 @@ http {
             deny all;
             return 404;
         }
+        location /static/staticfiles.json {
+            deny all;
+            return 404;
+        }
+        location /static/CACHE/manifest.json {
+            deny all;
+            return 404;
+        }
         location /static/ {
             alias /pretix/src/pretix/static.dist/;
             access_log off;

deployment/docker/pretix.bash

@@ -5,7 +5,7 @@ export DATA_DIR=/data/
 export HOME=/pretix
 
 AUTOMIGRATE=${AUTOMIGRATE:-yes}
-NUM_WORKERS_DEFAULT=$((2 * $(nproc --all)))
+NUM_WORKERS_DEFAULT=$((2 * $(nproc)))
 export NUM_WORKERS=${NUM_WORKERS:-$NUM_WORKERS_DEFAULT}
 
 if [ ! -d /data/logs ]; then
@@ -47,7 +47,7 @@ if [ "$1" == "taskworker" ]; then
 fi
 
 if [ "$1" == "upgrade" ]; then
-    exec python3 -m pretix updatestyles
+    exec python3 -m pretix updateassets
 fi
 
 exec python3 -m pretix "$@"

deployment/docker/production_settings.py

@@ -1,4 +1,4 @@
 from pretix.settings import *
 
 LOGGING['handlers']['mail_admins']['include_html'] = True
-STATICFILES_STORAGE = 'django.contrib.staticfiles.storage.ManifestStaticFilesStorage'
+STORAGES["staticfiles"]["BACKEND"] = 'django.contrib.staticfiles.storage.ManifestStaticFilesStorage'

doc/_templates/index.html

@@ -1,43 +1,16 @@
 {% extends "layout.html" %}
 {% set title = 'Overview' %}
 {% block body %}
-    <h1>Welcome to pretix' documentation!</h1>
+    <h1>Welcome to our developer documentation!</h1>
     <p>
-        We work hard to make this website contain all information that you need to use, run, understand, and improve
-        pretix. Of course, this documentation will never be perfect or complete, but if there is anything unclear
+        We work hard to make this website contain all information that you need to work with our API or source code.
+        Of course, this documentation will never be perfect or complete, but if there is anything unclear
         or anything specific that you miss here, that's a bug and we'd be happy if you'd
         <a href="https://github.com/pretix/pretix/issues/new">let us know</a>.
     </p>
 
-    <h2>Documentation structure</h2>
+    <h2>What you can find here</h2>
 
-    <div class="sectionbox">
-        <div class="icon">
-            <a href="user/index.html">
-                <span class="fa fa-user fa-fw"></span>
-            </a>
-        </div>
-        <div class="text">
-            <a href="user/index.html">
-                <strong>User Guide</strong>
-            </a>
-            <p>Go here to find information on how to configure and use pretix as an event organizer.</p>
-        </div>
-    </div>
-    <div class="sectionbox">
-        <div class="icon">
-            <a href="admin/index.html">
-                <span class="fa fa-server fa-fw"></span>
-            </a>
-        </div>
-        <div class="text">
-            <a href="admin/index.html">
-                <strong>Administrator docs</strong>
-            </a>
-            <p>Find out how to install pretix on your own server and how to maintain an installation of pretix.</p>
-        </div>
-    </div>
-    <div class="clearfix"></div>
     <div class="sectionbox">
         <div class="icon">
             <a href="api/index.html">
@@ -69,30 +42,33 @@
         </div>
     </div>
     <div class="clearfix"></div>
+
+
+    <h2>Other sources of documentation</h2>
     <div class="sectionbox">
         <div class="icon">
-            <a href="plugins/index.html">
-                <span class="fa fa-puzzle-piece fa-fw"></span>
+            <a href="https://docs.pretix.eu" target="_blank">
+                <span class="fa fa-user fa-fw"></span>
             </a>
         </div>
         <div class="text">
-            <a href="plugins/index.html">
-                <strong>Plugin docs</strong>
+            <a href="https://docs.pretix.eu" target="_blank">
+                <strong>User docs</strong>
             </a>
-            <p>Documentation and details on plugins that ship with pretix or are officially supported.</p>
+            <p>Go here to find information on how to configure and use pretix as an event organizer.</p>
         </div>
     </div>
     <div class="sectionbox">
         <div class="icon">
-            <a href="contents.html">
-                <span class="fa fa-list fa-fw"></span>
+            <a href="https://docs.pretix.eu/self-hosting/">
+                <span class="fa fa-server fa-fw"></span>
             </a>
         </div>
         <div class="text">
-            <a href="contents.html">
-                <strong>Table of contents</strong>
+            <a href="https://docs.pretix.eu/self-hosting/">
+                <strong>Administrator docs</strong>
             </a>
-            <p>Detailled overview of everything contained in this documentation.</p>
+            <p>Find out how to install pretix on your own server and how to maintain an installation of pretix.</p>
         </div>
     </div>
     <div class="clearfix"></div>
@@ -142,19 +118,6 @@
                 general news on pretix as a project.</p>
         </div>
     </div>
-    <div class="sectionbox">
-        <div class="icon">
-            <a href="https://twitter.com/pretixeu" target="_blank">
-                <span class="fa fa-twitter fa-fw"></span>
-            </a>
-        </div>
-        <div class="text">
-            <a href="https://twitter.com/pretixeu" target="_blank">
-                <strong>Twitter</strong>
-            </a>
-            <p>Keep in touch and stay up to date by following our project account on Twitter.</p>
-        </div>
-    </div>
     <div class="clearfix"></div>
 
 {% endblock %}

doc/_themes/pretix_theme/layout.html

@@ -6,10 +6,14 @@
 {%- else %}
   {%- set titlesuffix = "" %}
 {%- endif %}
+{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %}
+
+{# Build sphinx_version_info tuple from sphinx_version string in pure Jinja #}
+{%- set (_ver_major, _ver_minor) = (sphinx_version.split('.') | list)[:2] | map('int') -%}
+{%- set sphinx_version_info = (_ver_major, _ver_minor, -1) -%}
 
 <!DOCTYPE html>
-<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
-<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<html class="writer-html5" lang="{{ lang_attr }}"{% if sphinx_version_info >= (7, 2) %} data-content_root="{{ content_root }}"{% endif %}>
 <head>
   <meta charset="utf-8">
   {{ metatags }}
@@ -18,59 +22,50 @@
   <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
   {% endblock %}
 
-
-  {#- CSS #}
-  {%- for css in css_files %}
-    {%- if css|attr("rel") %}
-      <link rel="{{ css.rel }}" href="{{ pathto(css.filename, 1) }}" type="text/css"{% if css.title is not none %} title="{{ css.title }}"{% endif %} />
+    {#- CSS #}
+    {%- for css_file in css_files %}
+    {%- if css_file|attr("filename") %}
+    {{ css_tag(css_file) }}
     {%- else %}
-      <link rel="stylesheet" href="{{ pathto(css, 1) }}" type="text/css" />
+    <link rel="stylesheet" href="{{ pathto(css_file, 1)|escape }}" type="text/css" />
     {%- endif %}
-  {%- endfor %}
+    {%- endfor %}
 
-  {%- for cssfile in extra_css_files %}
-    <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
-  {%- endfor -%}
+    {#- FAVICON #}
+    {%- if favicon_url %}
+    <link rel="shortcut icon" href="{{ favicon_url }}"/>
+    {%- endif %}
 
-  {#- FAVICON
-      favicon_url is the only context var necessary since Sphinx 4.
-      In Sphinx<4, we use favicon but need to prepend path info.
-  #}
-  {%- set _favicon_url = favicon_url | default(pathto('_static/' + (favicon or ""), 1)) %}
-  {%- if favicon_url or favicon %}
-    <link rel="shortcut icon" href="{{ _favicon_url }}"/>
-  {%- endif %}
-
-  {#- CANONICAL URL (deprecated) #}
-  {%- if theme_canonical_url and not pageurl %}
+    {#- CANONICAL URL (deprecated) #}
+    {%- if theme_canonical_url and not pageurl %}
     <link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
-  {%- endif -%}
+    {%- endif -%}
 
-  {#- CANONICAL URL #}
-  {%- if pageurl %}
+    {#- CANONICAL URL #}
+    {%- if pageurl %}
     <link rel="canonical" href="{{ pageurl|e }}" />
-  {%- endif -%}
+    {%- endif -%}
 
-  {#- JAVASCRIPTS #}
-  {%- block scripts %}
-  <!--[if lt IE 9]>
-    <script src="{{ pathto('_static/js/html5shiv.min.js', 1) }}"></script>
-  <![endif]-->
-  {%- if not embedded %}
-  {# XXX Sphinx 1.8.0 made this an external js-file, quick fix until we refactor the template to inherert more blocks directly from sphinx #}
-      {%- for scriptfile in script_files %}
-        {{ js_tag(scriptfile) }}
-      {%- endfor %}
+    {#- JAVASCRIPTS #}
+    {%- block scripts %}
+    {%- if not embedded %}
+    {%- for scriptfile in script_files %}
+    {{ js_tag(scriptfile) }}
+    {%- endfor %}
     <script src="{{ pathto('_static/js/theme.js', 1) }}"></script>
 
+    {%- if READTHEDOCS or DEBUG %}
+    <script src="{{ pathto('_static/js/versions.js', 1) }}"></script>
+    {%- endif %}
+
     {#- OPENSEARCH #}
     {%- if use_opensearch %}
     <link rel="search" type="application/opensearchdescription+xml"
           title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
           href="{{ pathto('_static/opensearch.xml', 1) }}"/>
     {%- endif %}
-  {%- endif %}
-  {%- endblock %}
+    {%- endif %}
+    {%- endblock %}
 
   {%- block linktags %}
     {%- if hasdoc('about') %}
@@ -115,6 +110,7 @@
             {%- if logo or logo_url %}
               <img src="{{ _logo_url }}" class="logo" alt="{{ _('Logo') }}"/>
             {%- endif %}
+            Developer Documentation
           </a>
 
           {% include "searchbox.html" %}
@@ -122,23 +118,23 @@
           {% endblock %}
         </div>
 
-        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
-          {% block menu %}
-            {#
-              The singlehtml builder doesn't handle this toctree call when the
-              toctree is empty. Skip building this for now.
-            #}
-            {% if 'singlehtml' not in builder %}
-              {% set global_toc = toctree(maxdepth=theme_navigation_depth|int, collapse=theme_collapse_navigation, includehidden=True) %}
-            {% endif %}
-            {% if global_toc %}
-              {{ global_toc }}
-            {% else %}
+          {%- block navigation %}
+          {#- Translators: This is an ARIA section label for the main navigation menu -#}
+          <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="{{ _('Navigation menu') }}">
+              {%- block menu %}
+              {%- set toctree = toctree(maxdepth=theme_navigation_depth|int,
+              collapse=theme_collapse_navigation|tobool,
+              includehidden=theme_includehidden|tobool,
+              titles_only=theme_titles_only|tobool) %}
+              {%- if toctree %}
+              {{ toctree }}
+              {%- else %}
               <!-- Local TOC -->
               <div class="local-toc">{{ toc }}</div>
-            {% endif %}
-          {% endblock %}
-        </div>
+              {%- endif %}
+              {%- endblock %}
+          </div>
+          {%- endblock %}
 
           {% if theme_display_version %}
               {%- set nav_version = version %}
@@ -157,53 +153,42 @@
     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 
       {# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
-      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
-        {% block mobile_nav %}
-          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="{{ pathto('index') }}">{{ project }}</a>
-        {% endblock %}
-      </nav>
+        <nav class="wy-nav-top" aria-label="{{ _('Mobile navigation menu') }}" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}>
+            {%- block mobile_nav %}
+            <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+            <a href="{{ pathto(master_doc) }}">{{ project }}</a>
+            {%- endblock %}
+        </nav>
 
-
-      {# PAGE CONTENT #}
-      <div class="wy-nav-content">
-        <div class="rst-content">
-          {% include "breadcrumbs.html" %}
-          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
-           <div itemprop="articleBody" class="section">
-            {% block body %}{% endblock %}
-           </div>
-           <div class="articleComments">
-            {% block comments %}{% endblock %}
-           </div>
-          </div>
-          {% include "footer.html" %}
+        <div class="wy-nav-content">
+            {%- block content %}
+            {%- if theme_style_external_links|tobool %}
+            <div class="rst-content style-external-links">
+            {%- else %}
+            <div class="rst-content">
+            {%- endif %}
+            {% include "breadcrumbs.html" %}
+            <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+                {%- block document %}
+                <div itemprop="articleBody">
+                    {% block body %}{% endblock %}
+                </div>
+                {%- if self.comments()|trim %}
+                <div class="articleComments">
+                    {%- block comments %}{% endblock %}
+                </div>
+                {%- endif%}
+            </div>
+            {%- endblock %}
+            {% include "footer.html" %}
+        </div>
+        {%- endblock %}
         </div>
-      </div>
-
     </section>
 
   </div>
   {% include "versions.html" %}
 
-  {% if not embedded %}
-
-    <script type="text/javascript">
-        var DOCUMENTATION_OPTIONS = {
-            URL_ROOT:'{{ url_root }}',
-            VERSION:'{{ release|e }}',
-            COLLAPSE_INDEX:false,
-            FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
-            HAS_SOURCE:  {{ has_source|lower }},
-            SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
-        };
-    </script>
-    {%- for scriptfile in script_files %}
-      <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
-    {%- endfor %}
-
-  {% endif %}
-
   {# RTD hosts this file, so just load on non RTD builds #}
   {% if not READTHEDOCS %}
     <script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>
@@ -213,7 +198,7 @@
   {% if theme_sticky_navigation %}
   <script type="text/javascript">
       jQuery(function () {
-          SphinxRtdTheme.StickyNav.enable();
+          SphinxRtdTheme.Navigation.enable({{ 'true' if theme_sticky_navigation|tobool else 'false' }});
       });
   </script>
   {% endif %}

doc/_themes/pretix_theme/layout_old.html

@@ -1,136 +1,86 @@
-{#
-    basic/layout.html
-    ~~~~~~~~~~~~~~~~~
-
-    Master layout template for Sphinx themes.
-
-    :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-#}
-{%- block doctype -%}
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-{%- endblock %}
-{%- set reldelim1 = reldelim1 is not defined and ' &raquo;' or reldelim1 %}
-{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %}
-{%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and
-                         (sidebars != []) %}
+{# TEMPLATE VAR SETTINGS #}
 {%- set url_root = pathto('', 1) %}
-{# XXX necessary? #}
 {%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
 {%- if not embedded and docstitle %}
   {%- set titlesuffix = " &mdash; "|safe + docstitle|e %}
 {%- else %}
   {%- set titlesuffix = "" %}
 {%- endif %}
+{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %}
 
-{%- macro relbar() %}
-    <div class="related">
-      <h3>{{ _('Navigation') }}</h3>
-      <ul>
-        {%- for rellink in rellinks %}
-        <li class="right" {% if loop.first %}style="margin-right: 10px"{% endif %}>
-          <a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags|e }}"
-             {{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>
-          {%- if not loop.first %}{{ reldelim2 }}{% endif %}</li>
-        {%- endfor %}
-        {%- block rootrellink %}
-        <li><a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>{{ reldelim1 }}</li>
-        {%- endblock %}
-        {%- for parent in parents %}
-          <li><a href="{{ parent.link|e }}" {% if loop.last %}{{ accesskey("U") }}{% endif %}>{{ parent.title }}</a>{{ reldelim1 }}</li>
-        {%- endfor %}
-        {%- block relbaritems %} {% endblock %}
-      </ul>
-    </div>
-{%- endmacro %}
+{# Build sphinx_version_info tuple from sphinx_version string in pure Jinja #}
+{%- set (_ver_major, _ver_minor) = (sphinx_version.split('.') | list)[:2] | map('int') -%}
+{%- set sphinx_version_info = (_ver_major, _ver_minor, -1) -%}
 
-{%- macro sidebar() %}
-      {%- if render_sidebar %}
-      <div class="sphinxsidebar">
-        <div class="sphinxsidebarwrapper">
-          {%- block sidebarlogo %}
-          {%- if logo %}
-            <p class="logo"><a href="{{ pathto(master_doc) }}">
-              <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
-            </a></p>
-          {%- endif %}
-          {%- endblock %}
-          {%- if sidebars != None %}
-            {#- new style sidebar: explicitly include/exclude templates #}
-            {%- for sidebartemplate in sidebars %}
-            {%- include sidebartemplate %}
-            {%- endfor %}
-          {%- else %}
-            {#- old style sidebars: using blocks -- should be deprecated #}
-            {%- block sidebartoc %}
-            {%- include "localtoc.html" %}
-            {%- endblock %}
-            {%- block sidebarrel %}
-            {%- include "relations.html" %}
-            {%- endblock %}
-            {%- block sidebarsourcelink %}
-            {%- include "sourcelink.html" %}
-            {%- endblock %}
-            {%- if customsidebar %}
-            {%- include customsidebar %}
-            {%- endif %}
-            {%- block sidebarsearch %}
-            {%- include "searchbox.html" %}
-            {%- endblock %}
-          {%- endif %}
-        </div>
-      </div>
-      {%- endif %}
-{%- endmacro %}
+<!DOCTYPE html>
+<html class="writer-html5" lang="{{ lang_attr }}"{% if sphinx_version_info >= (7, 2) %} data-content_root="{{ content_root }}"{% endif %}>
+<head>
+  <meta charset="utf-8" />
+  {%- if READTHEDOCS and not embedded %}
+  <meta name="readthedocs-addons-api-version" content="1">
+  {%- endif %}
+  {{- metatags }}
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  {%- block htmltitle %}
+  <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
+  {%- endblock -%}
 
-{%- macro script() %}
-    <script type="text/javascript">
-      var DOCUMENTATION_OPTIONS = {
-        URL_ROOT:    '{{ url_root }}',
-        VERSION:     '{{ release|e }}',
-        COLLAPSE_INDEX: false,
-        FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}',
-        HAS_SOURCE:  {{ has_source|lower }},
-        SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
-      };
-    </script>
+  {#- CSS #}
+  {%- for css_file in css_files %}
+    {%- if css_file|attr("filename") %}
+      {{ css_tag(css_file) }}
+    {%- else %}
+      <link rel="stylesheet" href="{{ pathto(css_file, 1)|escape }}" type="text/css" />
+    {%- endif %}
+  {%- endfor %}
+
+  {#
+      "extra_css_files" is an undocumented Read the Docs theme specific option.
+      There is no need to check for ``|attr("filename")`` here because it's always a string.
+      Note that this option should be removed in favor of regular ``html_css_files``:
+      https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_css_files
+  #}
+  {%- for css_file in extra_css_files %}
+    <link rel="stylesheet" href="{{ pathto(css_file, 1)|escape }}" type="text/css" />
+  {%- endfor -%}
+
+  {#- FAVICON #}
+  {%- if favicon_url %}
+    <link rel="shortcut icon" href="{{ favicon_url }}"/>
+  {%- endif %}
+
+  {#- CANONICAL URL (deprecated) #}
+  {%- if theme_canonical_url and not pageurl %}
+    <link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
+  {%- endif -%}
+
+  {#- CANONICAL URL #}
+  {%- if pageurl %}
+    <link rel="canonical" href="{{ pageurl|e }}" />
+  {%- endif -%}
+
+  {#- JAVASCRIPTS #}
+  {%- block scripts %}
+  {%- if not embedded %}
     {%- for scriptfile in script_files %}
-    <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
+      {{ js_tag(scriptfile) }}
     {%- endfor %}
-{%- endmacro %}
+    <script src="{{ pathto('_static/js/theme.js', 1) }}"></script>
 
-{%- macro css() %}
-    <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
-    <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
-    {%- for cssfile in css_files %}
-    <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
-    {%- endfor %}
-{%- endmacro %}
+    {%- if READTHEDOCS or DEBUG %}
+    <script src="{{ pathto('_static/js/versions.js', 1) }}"></script>
+    {%- endif %}
 
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset={{ encoding }}" />
-    {{ metatags }}
-    {%- block htmltitle %}
-    <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
-    {%- endblock %}
-    {{ css() }}
-    {%- if not embedded %}
-    {{ script() }}
+    {#- OPENSEARCH #}
     {%- if use_opensearch %}
     <link rel="search" type="application/opensearchdescription+xml"
           title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
           href="{{ pathto('_static/opensearch.xml', 1) }}"/>
     {%- endif %}
-    {%- if favicon %}
-    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
-    {%- endif %}
-    {%- if theme_canonical_url %}
-    <link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
-    {%- endif %}
-    {%- endif %}
-{%- block linktags %}
+  {%- endif %}
+  {%- endblock %}
+
+  {%- block linktags %}
     {%- if hasdoc('about') %}
     <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
     {%- endif %}
@@ -143,67 +93,135 @@
     {%- if hasdoc('copyright') %}
     <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
     {%- endif %}
-    <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" />
-    {%- if parents %}
-    <link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}" />
-    {%- endif %}
     {%- if next %}
     <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
     {%- endif %}
     {%- if prev %}
     <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
     {%- endif %}
-{%- endblock %}
-{%- block extrahead %} {% endblock %}
-  </head>
-  <body>
-{%- block header %}{% endblock %}
-
-{%- block relbar1 %}{{ relbar() }}{% endblock %}
-
-{%- block content %}
-  {%- block sidebar1 %} {# possible location for sidebar #} {% endblock %}
-
-    <div class="document">
-  {%- block document %}
-      <div class="documentwrapper">
-      {%- if render_sidebar %}
-        <div class="bodywrapper">
-      {%- endif %}
-          <div class="body">
-            {% block body %} {% endblock %}
-          </div>
-      {%- if render_sidebar %}
-        </div>
-      {%- endif %}
-      </div>
   {%- endblock %}
+  {%- block extrahead %} {% endblock %}
+</head>
 
-  {%- block sidebar2 %}{{ sidebar() }}{% endblock %}
-      <div class="clearer"></div>
-    </div>
-{%- endblock %}
+<body class="wy-body-for-nav">
 
-{%- block relbar2 %}{{ relbar() }}{% endblock %}
+  {%- block extrabody %} {% endblock %}
+  <div class="wy-grid-for-nav">
+    {#- SIDE NAV, TOGGLES ON MOBILE #}
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}>
+          {%- block sidebartitle %}
+
+          {# the logo helper function was removed in Sphinx 6 and deprecated since Sphinx 4 #}
+          {# the master_doc variable was renamed to root_doc in Sphinx 4 (master_doc still exists in later Sphinx versions) #}
+          {%- set _logo_url = logo_url|default(pathto('_static/' + (logo or ""), 1)) %}
+          {%- set _root_doc = root_doc|default(master_doc) %}
+          <a href="{{ pathto(_root_doc) }}"{% if not theme_logo_only %} class="icon icon-home"{% endif %}>
+            {% if not theme_logo_only %}{{ project }}{% endif %}
+            {%- if logo or logo_url %}
+              <img src="{{ _logo_url }}" class="logo" alt="{{ _('Logo') }}"/>
+            {%- endif %}
+          </a>
+
+          {%- if READTHEDOCS or DEBUG %}
+            {%- if theme_version_selector or theme_language_selector %}
+              <div class="switch-menus">
+                <div class="version-switch"></div>
+                <div class="language-switch"></div>
+              </div>
+            {%- endif %}
+          {%- endif %}
+
+          {%- include "searchbox.html" %}
+
+          {%- endblock %}
+        </div>
+
+        {%- block navigation %}
+        {#- Translators: This is an ARIA section label for the main navigation menu -#}
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="{{ _('Navigation menu') }}">
+          {%- block menu %}
+            {%- set toctree = toctree(maxdepth=theme_navigation_depth|int,
+                                      collapse=theme_collapse_navigation|tobool,
+                                      includehidden=theme_includehidden|tobool,
+                                      titles_only=theme_titles_only|tobool) %}
+            {%- if toctree %}
+              {{ toctree }}
+            {%- else %}
+              <!-- Local TOC -->
+              <div class="local-toc">{{ toc }}</div>
+            {%- endif %}
+          {%- endblock %}
+        </div>
+        {%- endblock %}
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+      {#- MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
+      {#- Translators: This is an ARIA section label for the navigation menu that is visible when viewing the page on mobile devices -#}
+      <nav class="wy-nav-top" aria-label="{{ _('Mobile navigation menu') }}" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}>
+        {%- block mobile_nav %}
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="{{ pathto(master_doc) }}">{{ project }}</a>
+        {%- endblock %}
+      </nav>
+
+      <div class="wy-nav-content">
+      {%- block content %}
+        {%- if theme_style_external_links|tobool %}
+        <div class="rst-content style-external-links">
+        {%- else %}
+        <div class="rst-content">
+        {%- endif %}
+          {% include "breadcrumbs.html" %}
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+          {%- block document %}
+           <div itemprop="articleBody">
+             {% block body %}{% endblock %}
+           </div>
+           {%- if self.comments()|trim %}
+             <div class="articleComments">
+               {%- block comments %}{% endblock %}
+             </div>
+           {%- endif%}
+          </div>
+          {%- endblock %}
+          {% include "footer.html" %}
+        </div>
+      {%- endblock %}
+      </div>
+    </section>
+  </div>
+  {% include "versions.html" -%}
+
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable({{ 'true' if theme_sticky_navigation|tobool else 'false' }});
+      });
+  </script>
+
+  {#- Do not conflict with RTD insertion of analytics script #}
+  {%- if not READTHEDOCS %}
+    {%- if theme_analytics_id %}
+    <!-- Theme Analytics -->
+    <script async src="https://www.googletagmanager.com/gtag/js?id={{ theme_analytics_id }}"></script>
+    <script>
+      window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+
+      gtag('config', '{{ theme_analytics_id }}', {
+          'anonymize_ip': {{ 'true' if theme_analytics_anonymize_ip|tobool else 'false' }},
+      });
+    </script>
 
-{%- block footer %}
-    <div class="footer">
-    {%- if show_copyright %}
-      {%- if hasdoc('copyright') %}
-        {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
-      {%- else %}
-        {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
-      {%- endif %}
     {%- endif %}
-    {%- if last_updated %}
-      {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
-    {%- endif %}
-    {%- if show_sphinx %}
-      {% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx-doc.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
-    {%- endif %}
-    </div>
-    <p>asdf asdf asdf asdf 22</p>
-{%- endblock %}
-  </body>
-</html>
+  {%- endif %}
 
+  {%- block footer %} {% endblock %}
+
+</body>
+</html>

doc/_themes/pretix_theme/static/css/pretix.css

@@ -5183,7 +5183,7 @@ div[class^='highlight'] pre {
 
 .wy-side-nav-search > a img.logo, .wy-side-nav-search .wy-dropdown > a img.logo {
     display: block;
-    margin: 0 auto;
+    margin: 0 auto 10px;
     height: 50px;
     width: auto;
     border-radius: 0;

doc/admin/config.rst

@@ -1,521 +0,0 @@
-.. highlight:: ini
-
-.. _`config`:
-
-.. spelling:word-list:: Galera
-
-Configuration file
-==================
-
-Pretix reads its configuration from a configuration file. It tries to find this file
-at the following locations. It will try to read the file from the specified paths in
-the following order. The file that is found *last* will override the settings from
-the files found before.
-
-1. ``PRETIX_CONFIG_FILE`` environment variable
-2. ``/etc/pretix/pretix.cfg``
-3. ``~/.pretix.cfg``
-4. ``pretix.cfg`` in the current working directory
-
-The file is expected to be in the INI format as specified in the `Python documentation`_.
-
-The config file may contain the following sections (all settings are optional and have
-default values). We suggest that you start from the examples given in one of the
-installation tutorials.
-
-.. note::
-
-    The configuration file is the recommended way to configure pretix. However, you can
-    also set them through environment variables. In this case, the syntax is
-    ``PRETIX_SECTION_CONFIG``. For example, to configure the setting ``password_reset``
-    from the ``[pretix]`` section, set ``PRETIX_PRETIX_PASSWORD_RESET=off`` in your
-    environment.
-
-pretix settings
----------------
-
-Example::
-
-    [pretix]
-    instance_name=pretix.de
-    url=http://localhost
-    currency=EUR
-    datadir=/data
-    plugins_default=pretix.plugins.sendmail,pretix.plugins.statistics
-    cookie_domain=.pretix.de
-
-``instance_name``
-    The name of this installation. Default: ``pretix.de``
-
-``url``
-    The installation's full URL, without a trailing slash.
-
-``currency``
-    The default currency as a three-letter code. Defaults to ``EUR``.
-
-``datadir``
-    The local path to a data directory that will be used for storing user uploads and similar
-    data. Defaults to the value of the environment variable ``DATA_DIR`` or ``data``.
-
-``plugins_default``
-    A comma-separated list of plugins that are enabled by default for all new events.
-    Defaults to ``pretix.plugins.sendmail,pretix.plugins.statistics``.
-
-``plugins_exclude``
-    A comma-separated list of plugins that are not available even though they are installed.
-    Defaults to an empty string.
-
-``plugins_show_meta``
-    Whether to show authors and versions of plugins, defaults to ``on``.
-
-``auth_backends``
-    A comma-separated list of available auth backends. Defaults to ``pretix.base.auth.NativeAuthBackend``.
-
-``cookie_domain``
-    The cookie domain to be set. Defaults to ``None``.
-
-``registration``
-    Enables or disables the registration of new admin users. Defaults to ``on``.
-
-``password_reset``
-    Enables or disables password reset. Defaults to ``on``.
-
-``long_sessions``
-    Enables or disables the "keep me logged in" button. Defaults to ``on``.
-
-``ecb_rates``
-    By default, pretix periodically downloads currency rates from the European Central Bank as well as other authorities
-    that are used to print tax amounts in the customer currency on invoices for some currencies. Set to ``off`` to
-    disable this feature. Defaults to ``on``.
-
-``audit_comments``
-    Enables or disables nagging staff users for leaving comments on their sessions for auditability.
-    Defaults to ``off``.
-
-``obligatory_2fa``
-    Enables or disables obligatory usage of Two-Factor Authentication for users of the pretix backend.
-    Defaults to ``False``
-
-``trust_x_forwarded_for``
-    Specifies whether the ``X-Forwarded-For`` header can be trusted. Only set to ``on`` if you have a reverse
-    proxy that actively removes and re-adds the header to make sure the correct client IP is the first value.
-    Defaults to ``off``.
-
-``trust_x_forwarded_proto``
-    Specifies whether the ``X-Forwarded-Proto`` header can be trusted. Only set to ``on`` if you have a reverse
-    proxy that actively removes and re-adds the header to make sure the correct value is set.
-    Defaults to ``off``.
-
-``trust_x_forwarded_host``
-    Specifies whether the ``X-Forwarded-Host`` header can be trusted. Only set to ``on`` if you have a reverse
-    proxy that actively removes and re-adds the header to make sure the correct value is set.
-    Defaults to ``off``.
-
-``csp_log``
-    Log violations of the Content Security Policy (CSP). Defaults to ``on``.
-
-``csp_additional_header``
-    Specifies a CSP header that will be **merged** with pretix's default header. For example, if you set this
-    to ``script-src https://mycdn.com``, pretix will add ``https://mycdn.com`` as an **additional** allowed source
-    to all CSP headers. Empty by default.
-
-``loglevel``
-    Set console and file log level (``DEBUG``, ``INFO``, ``WARNING``, ``ERROR`` or ``CRITICAL``). Defaults to ``INFO``.
-
-``request_id_header``
-    Specifies the name of a header that should be used for logging request IDs. Off by default.
-
-Locale settings
----------------
-
-Example::
-
-    [locale]
-    default=de
-    timezone=Europe/Berlin
-
-``default``
-    The system's default locale. Default: ``en``
-
-``timezone``
-    The system's default timezone as a ``pytz`` name. Default: ``UTC``
-
-Database settings
------------------
-
-Example::
-
-    [database]
-    backend=postgresql
-    name=pretix
-    user=pretix
-    password=abcd
-    host=localhost
-    port=3306
-    sslmode=require
-    sslrootcert=/etc/pretix/postgresql-ca.crt
-    sslcert=/etc/pretix/postgresql-client-crt.crt
-    sslkey=/etc/pretix/postgresql-client-key.key
-
-``backend``
-    One of ``sqlite3`` and ``postgresql``.
-    Default: ``sqlite3``.
-
-``name``
-    The database's name. Default: ``db.sqlite3``.
-
-``user``, ``password``, ``host``, ``port``
-    Connection details for the database connection. Empty by default.
-
-``sslmode``, ``sslrootcert``
-    Connection TLS details for the PostgreSQL database connection. Possible values of ``sslmode`` are ``disable``, ``allow``, ``prefer``, ``require``, ``verify-ca``, and ``verify-full``. ``sslrootcert`` should be the accessible path of the ca certificate. Both values are empty by default.
-
-``sslcert``, ``sslkey``
-    Connection mTLS details for the PostgreSQL database connection. It's also necessary to specify ``sslmode`` and ``sslrootcert`` parameters, please check the correct values from the TLS part. ``sslcert`` should be the accessible path of the client certificate.  ``sslkey`` should be the accessible path of the client key. All values are empty by default.
-.. _`config-replica`:
-
-Database replica settings
--------------------------
-
-If you use a replicated database setup, pretix expects that the default database connection always points to the primary database node.
-Routing read queries to a replica on database layer is **strongly** discouraged since this can lead to inaccurate such as more tickets
-being sold than are actually available.
-
-However, pretix can still make use of a database replica to keep some expensive queries with that can tolerate some latency from your
-primary database, such as backend search queries. The ``replica`` configuration section can have the same settings as the ``database``
-section (except for the ``backend`` setting) and will default back to the ``database`` settings for all values that are not given. This
-way, you just need to specify the settings that are different for the replica.
-
-Example::
-
-    [replica]
-    host=192.168.0.2
-
-.. _`config-urls`:
-
-URLs
-----
-
-Example::
-
-    [urls]
-    media=/media/
-    static=/static/
-
-``media``
-    The URL to be used to serve user-uploaded content. You should not need to modify
-    this. Default: ``/media/``
-
-``static``
-    The URL to be used to serve static files. You should not need to modify
-    this. Default: ``/static/``
-
-.. _`mail-settings`:
-
-Email
------
-
-Example::
-
-    [mail]
-    from=hello@localhost
-    host=127.0.0.71
-    user=pretix
-    password=foobar
-    port=1025
-    tls=on
-    ssl=off
-
-``host``, ``port``
-    The SMTP Host to connect to. Defaults to ``localhost`` and ``25``.
-
-``user``, ``password``
-    The SMTP user data to use for the connection. Empty by default.
-
-``tls``, ``ssl``
-    Use STARTTLS or SSL for the SMTP connection. Off by default.
-
-``from``
-    The email address to set as ``From`` header in outgoing emails by the system.
-    Default: ``pretix@localhost``
-
-``from_notifications``
-    The email address to set as ``From`` header in admin notification emails by the system.
-    Defaults to the value of ``from``.
-
-``from_organizers``
-    The email address to set as ``From`` header in outgoing emails by the system sent on behalf of organizers.
-    Defaults to the value of ``from``.
-
-``custom_sender_verification_required``
-    If this is on (the default), organizers need to verify email addresses they want to use as senders in their event.
-
-``custom_sender_spf_string``
-    If this is set to a valid SPF string, pretix will show a warning if organizers use a sender address from a domain
-    that does not include this value.
-
-``custom_smtp_allow_private_networks``
-    If this is off (the default), custom SMTP servers cannot be private network addresses.
-
-``admins``
-    Comma-separated list of email addresses that should receive a report about every error code 500 thrown by pretix.
-
-.. _`django-settings`:
-
-Django settings
----------------
-
-Example::
-
-    [django]
-    secret=j1kjps5a5&4ilpn912s7a1!e2h!duz^i3&idu@_907s$wrz@x-
-    debug=off
-
-``secret``
-    The secret to be used by Django for signing and verification purposes. If this
-    setting is not provided, pretix will generate a random secret on the first start
-    and will store it in the filesystem for later usage.
-
-``debug``
-    Whether or not to run in debug mode. Default is ``False``.
-
-    .. WARNING:: Never set this to ``True`` in production!
-
-``profile``
-    Enable code profiling for a random subset of requests. Disabled by default, see
-    :ref:`perf-monitoring` for details.
-
-.. _`metrics-settings`:
-
-Metrics
--------
-
-If you want to fetch internally collected prometheus-style metrics you need to configure the credentials for the
-metrics endpoint and enable it::
-
-    [metrics]
-    enabled=true
-    user=your_user
-    passphrase=mysupersecretpassphrase
-
-Currently, metrics-collection requires a redis server to be available.
-
-
-Memcached
----------
-
-You can use an existing memcached server as pretix's caching backend::
-
-    [memcached]
-    location=127.0.0.1:11211
-
-``location``
-    The location of memcached, either a host:port combination or a socket file.
-
-If no memcached is configured, pretix will use redis for caching. If neither is configured, pretix will not use any caching.
-
-.. note:: If you use memcached and you deploy pretix across multiple servers, you should use *one*
-          shared memcached instance, not multiple ones, because cache invalidations would not be
-          propagated otherwise.
-
-Redis
------
-
-If a redis server is configured, pretix can use it for locking, caching and session storage
-to speed up various operations::
-
-    [redis]
-    location=redis://127.0.0.1:6379/1
-    sessions=false
-    sentinels=[
-            ["sentinel_host_1", 26379],
-            ["sentinel_host_2", 26379],
-            ["sentinel_host_3", 26379]
-        ]
-    password=password
-    ssl_cert_reqs=required
-    ssl_ca_certs=/etc/pretix/redis-ca.pem
-    ssl_keyfile=/etc/pretix/redis-client-crt.pem
-    ssl_certfile=/etc/pretix/redis-client-key.key
-
-``location``
-    The location of redis, as a URL of the form ``redis://[:password]@localhost:6379/0``
-    or ``unix://[:password]@/path/to/socket.sock?db=0``
-
-``session``
-    When this is set to ``True``, redis will be used as the session storage.
-
-``sentinels``
-    Configures redis sentinels to use.
-    If you don't want to use redis sentinels, you should omit this option.
-    If this is set, redis via sentinels will be used instead of plain redis.
-    In this case the location should be of the form ``redis://my_master/0``.
-    The ``sentinels`` variable should be a json serialized list of sentinels,
-    each being a list with the two elements hostname and port.
-    You cannot provide a password within the location when using sentinels.
-    Note that the configuration format requires you to either place the entire
-    value on one line or make sure all values are indented by at least one space.
-
-``password``
-    If your redis setup doesn't require a password or you already specified it in the location you can omit this option.
-    If this is set it will be passed to redis as the connection option PASSWORD.
-
-``ssl_cert_reqs``
-    If this is set it will be passed to redis as the connection option ``SSL_CERT_REQS``.
-    Possible values are ``none``, ``optional``, and ``required``.
-
-``ssl_ca_certs``
-    If your redis setup doesn't require TLS you can omit this option.
-    If this is set it will be passed to redis as the connection option ``SSL_CA_CERTS``. Possible value is the ca path.
-
-``ssl_keyfile``
-    If your redis setup doesn't require mTLS you can omit this option.
-    If this is set it will be passed to redis as the connection option ``SSL_KEYFILE``. Possible value is the keyfile path.
-
-``ssl_certfile``
-    If your redis setup doesn't require mTLS you can omit this option.
-    If this is set it will be passed to redis as the connection option ``SSL_CERTFILE``. Possible value is the certfile path.
-
-If redis is not configured, pretix will store sessions and locks in the database. If memcached
-is configured, memcached will be used for caching instead of redis.
-
-Translations
-------------
-
-pretix comes with a number of translations. All languages are enabled by default. If you want to limit
-the languages available in your installation, you can enable a set of languages like this::
-
-    [languages]
-    enabled=en,de
-
-Some of the languages them are marked as "incubating", which means
-they can usually only be selected in development mode. If you want to use them nevertheless, you
-can activate them like this::
-
-    [languages]
-    allow_incubating=pt-br,da
-
-You can also tell pretix about additional paths where it will search for translations::
-
-    [languages]
-    path=/path/to/my/translations
-
-For a given language (e.g. ``pt-br``), pretix will then look in the
-specific sub-folder, e.g. ``/path/to/my/translations/pt_BR/LC_MESSAGES/django.po``.
-
-Celery task queue
------------------
-
-For processing long-running tasks asynchronously, pretix requires the celery task queue.
-For communication between the web server and the task workers in both direction, a messaging
-queue and a result backend is needed. You can use a redis database for both directions, or
-an AMQP server (e.g. RabbitMQ) as a broker and redis or your database as a result backend::
-
-    [celery]
-    broker=amqp://guest:guest@localhost:5672//
-    backend=redis://localhost/0
-    broker_transport_options="{}"
-    backend_transport_options="{}"
-
-RabbitMQ might be the better choice if you have a complex, multi-server, high-performance setup,
-but as you already should have a redis instance ready for session and lock storage, we recommend
-redis for convenience. See the `Celery documentation`_ for more details.
-
-The two ``transport_options`` entries can be omitted in most cases.
-If they are present they need to be a valid JSON dictionary.
-For possible entries in that dictionary see the `Celery documentation`_.
-
-It is possible the use Redis with TLS/mTLS for the broker or the backend. To do so, it is necessary to specify the TLS identifier ``rediss``, the ssl mode ``ssl_cert_reqs`` and optionally specify the CA (TLS) ``ssl_ca_certs``, cert ``ssl_certfile`` and key ``ssl_keyfile`` (mTLS) path as encoded string. the following uri describes the format and possible parameters ``rediss://0.0.0.0:6379/1?ssl_cert_reqs=required&ssl_ca_certs=%2Fetc%2Fpretix%2Fredis-ca.pem&ssl_certfile=%2Fetc%2Fpretix%2Fredis-client-crt.pem&ssl_keyfile=%2Fetc%2Fpretix%2Fredis-client-key.key``
-
-To use redis with sentinels set the broker or backend to ``sentinel://sentinel_host_1:26379;sentinel_host_2:26379/0``
-and the respective transport_options to ``{"master_name":"mymaster"}``.
-If your redis instances behind the sentinel have a password use ``sentinel://:my_password@sentinel_host_1:26379;sentinel_host_2:26379/0``.
-If your redis sentinels themselves have a password set the transport_options to ``{"master_name":"mymaster","sentinel_kwargs":{"password":"my_password"}}``.
-
-Sentry
-------
-
-pretix has native support for sentry, a tool that you can use to track errors in the
-application. If you want to use sentry, you need to set a DSN in the configuration file::
-
-    [sentry]
-    dsn=https://<key>:<secret>@sentry.io/<project>
-    traces_sample_rate=0.5
-    traces_sample_token=xyz
-
-``dsn``
-    You will be given this value by your sentry installation.
-
-``traces_sample_rate``
-    Sample rate for performance monitoring.
-
-``traces_sample_token``
-    If this token is found in a query string, a trace will always be sampled.
-
-
-Caching
--------
-
-You can adjust some caching settings to control how much storage pretix uses::
-
-    [cache]
-    tickets=48  ; Number of hours tickets (PDF, passbook, …) are cached
-
-
-Secret length
--------------
-
-If you are really paranoid, you can increase the length of random strings pretix uses in
-various places like order codes, secrets in the ticket QR codes, etc. Example::
-
-    [entropy]
-    ; Order code needs to be < 16 characters, default is 5
-    order_code=5
-    ; Ticket secret needs to be < 64 characters, default is 32
-    ticket_secret=32
-    ; Voucher code needs to be < 255 characters, default is 16
-    voucher_code=16
-
-External tools
---------------
-
-pretix can make use of some external tools if they are installed. Currently, they are all optional. Example::
-
-    [tools]
-    pdftk=/usr/bin/pdftk
-
-.. _Python documentation: https://docs.python.org/3/library/configparser.html?highlight=configparser#supported-ini-file-structure
-.. _Celery documentation: http://docs.celeryproject.org/en/latest/userguide/configuration.html
-
-Maximum upload file sizes
--------------------------
-
-You can configure the maximum file size for uploading various files::
-
-    [pretix_file_upload]
-    ; Max upload size for images in MiB, defaults to 10 MiB
-    max_size_image = 12
-    ; Max upload size for favicons in MiB, defaults to 1 MiB
-    max_size_favicon = 2
-    ; Max upload size for email attachments of manually sent emails in MiB, defaults to 10 MiB
-    max_size_email_attachment = 15
-    ; Max upload size for email attachments of automatically sent emails in MiB, defaults to 1 MiB
-    max_size_email_auto_attachment = 2
-    ; Max upload size for other files in MiB, defaults to 10 MiB
-    ; This includes all file upload type order questions
-    max_size_other = 100
-
-
-GeoIP
------
-
-pretix can optionally make use of a GeoIP database for some features. It needs a file in ``mmdb`` format, for example
-`GeoLite2`_ or `GeoAcumen`_::
-
-    [geoip]
-    path=/var/geoipdata/
-    filename_country=GeoLite2-Country.mmdb
-
-
-.. _GeoAcumen: https://github.com/geoacumen/geoacumen-country
-.. _GeoLite2: https://dev.maxmind.com/geoip/geolite2-free-geolocation-data

doc/admin/errors.rst

@@ -1,40 +0,0 @@
-.. _`admin-errors`:
-
-Dealing with errors
-===================
-
-If you encounter an error in pretix, please follow the following steps to debug it:
-
-* If the error message is shown on a **white page** and the last line of the error includes "nginx", the error is not with pretix
-  directly but with your nginx webserver. This might mean that pretix is not running, but it could also be something else.
-  Please first check your nginx error log. The default location is ``/var/log/nginx/error.log``.
-
-  * If it turns out pretix is not running, check the output of ``docker logs pretix`` for a docker installation and
-    ``journalctl -u pretix-web.service`` for a manual installation.
-
-* If the error message is an "**Internal Server Error**" in purple pretix design, please check pretix' log file which by default is at
-  ``/var/pretix-data/logs/pretix.log`` if you installed with docker and ``/var/pretix/data/logs/pretix.log`` otherwise. If you don't
-  know how to interpret it, open a discussion on GitHub with the relevant parts of the log file.
-
-  * If the error message includes ``/usr/bin/env: ‘node’: No such file or directory``, you forgot to install ``node.js``
-
-  * If the error message includes ``OfflineGenerationError``, you might have forgot to run the ``rebuild`` step after a pretix update
-    or plugin installation.
-
-  * If the error message mentions your database server or redis server, make sure these are running and accessible.
-
-* If pretix loads fine but certain actions (creating carts, orders, or exports, downloading tickets, sending emails) **take forever**,
-  ``pretix-worker`` is not running. Check the output of ``docker logs pretix`` for a docker installation and
-  ``journalctl -u pretix-worker.service`` for a manual installation.
-
-* If the page loads but all **styles are missing**, you probably forgot to update your nginx configuration file after an upgrade of your
-  operating system's python version.
-
-
-If you are unable to debug the issue any further, please open a **discussion** on GitHub in our `Q&A Forum`_. Do **not** open an issue
-right away, since most things turn out not to be a bug in pretix but a mistake in your server configuration. Make sure to include
-relevant log excerpts in your question.
-
-If you're a pretix Enterprise customer, you can also reach out to support@pretix.eu with your issue right away.
-
-.. _Q&A Forum: https://github.com/pretix/pretix/discussions/categories/q-a

doc/admin/index.rst

@@ -1,18 +0,0 @@
-.. _`admindocs`:
-
-Administrator documentation
-===========================
-
-This documentation is for everyone who wants to install pretix on a server.
-
-.. toctree::
-   :maxdepth: 2
-
-   installation/index
-   updates
-   config
-   maintainance
-   scaling
-   errors
-   mysql2postgres
-   indexes

doc/admin/indexes.rst

@@ -1,83 +0,0 @@
-Additional database indices
-===========================
-
-If you have a large pretix database, some features such as search for orders or events might turn pretty slow.
-For PostgreSQL, we have compiled a list of additional database indexes that you can add to speed things up.
-Just like any index, they in turn make write operations insignificantly slower and cause the database to use
-more disk space.
-
-The indexes aren't automatically created by pretix since Django does not allow us to do so only on PostgreSQL
-(and they won't work on other databases). Also, they're really not necessary if you're not having tens of
-thousands of records in your database.
-
-However, this also means they won't automatically adapt if some of the referred fields change in future updates of pretix
-and you might need to re-check this page and change them manually.
-
-Here is the currently recommended set of commands::
-
-    CREATE EXTENSION pg_trgm;
-
-    CREATE INDEX CONCURRENTLY pretix_addidx_event_slug
-        ON pretixbase_event
-        USING gin (upper("slug") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_event_name
-        ON pretixbase_event
-        USING gin (upper("name") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_order_code
-        ON pretixbase_order
-        USING gin (upper("code") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_voucher_code
-        ON pretixbase_voucher
-        USING gin (upper("code") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_invoice_nu1
-        ON "pretixbase_invoice" (UPPER("invoice_no"));
-    CREATE INDEX CONCURRENTLY pretix_addidx_invoice_nu2
-        ON "pretixbase_invoice" (UPPER("full_invoice_no"));
-    CREATE INDEX CONCURRENTLY pretix_addidx_organizer_name
-        ON pretixbase_organizer
-        USING gin (upper("name") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_organizer_slug
-        ON pretixbase_organizer
-        USING gin (upper("slug") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_order_email
-        ON pretixbase_order
-        USING gin (upper("email") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_order_comment
-        ON pretixbase_order
-        USING gin (upper("comment") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_order_event_date_id
-        ON public.pretixbase_order (event_id, datetime, id);
-    CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_name
-        ON pretixbase_orderposition
-        USING gin (upper("attendee_name_cached") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_secret
-        ON pretixbase_orderposition
-        USING gin (upper("secret") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_email
-        ON pretixbase_orderposition
-        USING gin (upper("attendee_email") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_ia_name
-        ON pretixbase_invoiceaddress
-        USING gin (upper("name_cached") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_ia_company
-        ON pretixbase_invoiceaddress
-        USING gin (upper("company") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_email_upper
-        ON public.pretixbase_orderposition (upper((attendee_email)::text));
-    CREATE INDEX CONCURRENTLY pretix_addidx_voucher_code_upper
-        ON public.pretixbase_voucher (upper((code)::text));
-    CREATE INDEX CONCURRENTLY pretix_addidx_logentry_event_date_id
-        ON public.pretixbase_logentry (event_id, datetime, id);
-    CREATE INDEX CONCURRENTLY pretix_addidx_logentry_event_cid_date_id
-        ON public.pretixbase_logentry (event_id, content_type_id, datetime, id);
-
-
-Also, if you use our ``pretix-shipping`` plugin::
-
-    CREATE INDEX CONCURRENTLY pretix_addidx_sa_name
-        ON pretix_shipping_shippingaddress
-        USING gin (upper("name") gin_trgm_ops);
-    CREATE INDEX CONCURRENTLY pretix_addidx_sa_company
-        ON pretix_shipping_shippingaddress
-        USING gin (upper("company") gin_trgm_ops);
-

doc/admin/installation/dev_version.rst

@@ -1,37 +0,0 @@
-.. highlight:: none
-
-Installing a development version
-================================
-
-If you want to use a feature of pretix that is not yet contained in the last monthly release, you can also
-install a development version with pretix.
-
-.. warning:: When in production, we strongly recommend only installing released versions. Development versions might
-             be broken, incompatible to plugins, or in rare cases incompatible to upgrade later on.
-
-
-Manual installation
--------------------
-
-You can use ``pip`` to update pretix directly to the development branch. Then, upgrade as usual::
-
-    $ source /var/pretix/venv/bin/activate
-    (venv)$ pip3 install -U "git+https://github.com/pretix/pretix.git#egg=pretix"
-    (venv)$ python -m pretix migrate
-    (venv)$ python -m pretix rebuild
-    (venv)$ python -m pretix updatestyles
-    # systemctl restart pretix-web pretix-worker
-
-Docker installation
--------------------
-
-To use the latest development version with Docker, first pull it from Docker Hub::
-
-    $ docker pull pretix/standalone:latest
-
-
-Then change your ``/etc/systemd/system/pretix.service`` file to use the ``:latest`` tag instead of ``:stable`` as well
-and upgrade as usual::
-
-    $ systemctl restart pretix.service
-    $ docker exec -it pretix.service pretix upgrade

doc/admin/installation/docker_smallscale.rst

@@ -1,333 +0,0 @@
-.. highlight:: none
-
-.. _`dockersmallscale`:
-
-Small-scale deployment with Docker
-==================================
-
-This guide describes the installation of a small-scale installation of pretix using docker. By small-scale, we mean
-that everything is being run on one host and you don't expect thousands of participants trying to get a ticket within
-a few minutes. In this setup, as many parts of pretix as possible are hidden away in one single docker container.
-This has some trade-offs in terms of performance and isolation but allows a rather easy installation.
-
-.. warning:: Even though we try to make it straightforward to run pretix, it still requires some Linux experience to
-             get it right. If you're not feeling comfortable managing a Linux server, check out our hosting and service
-             offers at `pretix.eu`_.
-
-We tested this guide on the Linux distribution **Debian 11.0** but it should work very similar on other
-modern distributions, especially on all systemd-based ones.
-
-Requirements
-------------
-
-Please set up the following systems beforehand, we'll not explain them here (but see these links for external
-installation guides):
-
-* `Docker`_
-* A SMTP server to send out mails, e.g. `Postfix`_ on your machine or some third-party server you have credentials for
-* A HTTP reverse proxy, e.g. `nginx`_ or Apache to allow HTTPS connections
-* A `PostgreSQL`_ 11+ database server
-* A `redis`_ server
-
-We also recommend that you use a firewall, although this is not a pretix-specific recommendation. If you're new to
-Linux and firewalls, we recommend that you start with `ufw`_.
-
-.. note:: Please, do not run pretix without HTTPS encryption. You'll handle user data and thanks to `Let's Encrypt`_
-          SSL certificates can be obtained for free these days. We also *do not* provide support for HTTP-only
-          installations except for evaluation purposes.
-
-.. warning:: By default, using `ufw` in conjunction will not have any effect. Please make sure to either bind the exposed
-             ports of your docker container explicitly to 127.0.0.1 or configure docker to respect any set up firewall
-             rules.
-
-On this guide
--------------
-
-All code lines prepended with a ``#`` symbol are commands that you need to execute on your server as ``root`` user;
-all lines prepended with a ``$`` symbol can also be run by an unprivileged user.
-
-Data files
-----------
-
-First of all, you need to create a directory on your server that pretix can use to store data files and make that
-directory writable to the user that runs pretix inside the docker container::
-
-    # mkdir /var/pretix-data
-    # chown -R 15371:15371 /var/pretix-data
-
-Database
---------
-
-Next, we need a database and a database user. We can create these with any kind of database managing tool or directly on
-our database's shell. Please make sure that UTF8 is used as encoding for the best compatibility. You can check this with
-the following command::
-
-    # sudo -u postgres psql -c 'SHOW SERVER_ENCODING'
-
-For PostgreSQL database creation, we would do::
-
-    # sudo -u postgres createuser -P pretix
-    # sudo -u postgres createdb -O pretix pretix
-
-Make sure that your database listens on the network. If PostgreSQL on the same same host as docker, but not inside a docker container, we recommend that you just listen on the Docker interface by changing the following line in ``/etc/postgresql/<version>/main/postgresql.conf``::
-
-    listen_addresses = 'localhost,172.17.0.1'
-
-You also need to add a new line to ``/etc/postgresql/<version>/main/pg_hba.conf`` to allow network connections to this user and database::
-
-    host    pretix          pretix          172.17.0.1/16           md5
-
-Restart PostgreSQL after you changed these files::
-
-    # systemctl restart postgresql
-
-If you have a firewall running, you should also make sure that port 5432 is reachable from the ``172.17.0.1/16`` subnet.
-
-Redis
------
-
-For caching and messaging in small-scale setups, pretix recommends using redis. In this small-scale setup we assume a
-redis instance to be running on the same host. To avoid the hassle with network configurations and firewalls, we
-recommend connecting to redis via a unix socket. To enable redis on unix sockets, add the following to your
-``/etc/redis/redis.conf``::
-
-    unixsocket /var/run/redis/redis.sock
-    unixsocketperm 777
-
-Now restart redis-server::
-
-    # systemctl restart redis-server
-
-In this setup, systemd will delete ``/var/run/redis`` on every redis restart, which will cause issues with pretix. To
-prevent this, you can execute::
-
-   # systemctl edit redis-server
-
-And insert the following::
-
-    [Service]
-    # Keep the directory around so that pretix.service in docker does not need to be
-    # restarted when redis is restarted.
-    RuntimeDirectoryPreserve=yes
-
-.. warning:: Setting the socket permissions to 777 is a possible security problem. If you have untrusted users on your
-             system or have high security requirements, please don't do this and let redis listen to a TCP socket
-             instead. We recommend the socket approach because the TCP socket in combination with docker's networking
-             can easily become an even worse security hole when configured slightly wrong. Read more about security
-             on the `redis website`_.
-
-             Another possible solution is to run `redis in docker`_ and link the containers using docker's networking
-             features.
-
-Config file
------------
-
-We now create a config directory and config file for pretix::
-
-    # mkdir /etc/pretix
-    # touch /etc/pretix/pretix.cfg
-    # chown -R 15371:15371 /etc/pretix/
-    # chmod 0700 /etc/pretix/pretix.cfg
-
-Fill the configuration file ``/etc/pretix/pretix.cfg`` with the following content (adjusted to your environment)::
-
-    [pretix]
-    instance_name=My pretix installation
-    url=https://pretix.mydomain.com
-    currency=EUR
-    ; DO NOT change the following value, it has to be set to the location of the
-    ; directory *inside* the docker container
-    datadir=/data
-    trust_x_forwarded_for=on
-    trust_x_forwarded_proto=on
-
-    [database]
-    backend=postgresql
-    name=pretix
-    user=pretix
-    ; Replace with the password you chose above
-    password=*********
-    ; In most docker setups, 172.17.0.1 is the address of the docker host. Adjust
-    ; this to wherever your database is running, e.g. the name of a linked container.
-    host=172.17.0.1
-
-    [mail]
-    ; See config file documentation for more options
-    from=tickets@yourdomain.com
-    ; This is the default IP address of your docker host in docker's virtual
-    ; network. Make sure postfix listens on this address.
-    host=172.17.0.1
-
-    [redis]
-    location=unix:///var/run/redis/redis.sock?db=0
-    ; Remove the following line if you are unsure about your redis' security
-    ; to reduce impact if redis gets compromised.
-    sessions=true
-
-    [celery]
-    backend=redis+socket:///var/run/redis/redis.sock?virtual_host=1
-    broker=redis+socket:///var/run/redis/redis.sock?virtual_host=2
-
-See :ref:`email configuration <mail-settings>` to learn more about configuring mail features.
-
-Docker image and service
-------------------------
-
-First of all, download the latest stable pretix image by running::
-
-    $ docker pull pretix/standalone:stable
-
-We recommend starting the docker container using systemd to make sure it runs correctly after a reboot. Create a file
-named ``/etc/systemd/system/pretix.service`` with the following content::
-
-    [Unit]
-    Description=pretix
-    After=docker.service
-    Requires=docker.service
-
-    [Service]
-    TimeoutStartSec=0
-    ExecStartPre=-/usr/bin/docker kill %n
-    ExecStartPre=-/usr/bin/docker rm %n
-    ExecStart=/usr/bin/docker run --name %n -p 127.0.0.1:8345:80 \
-        -v /var/pretix-data:/data \
-        -v /etc/pretix:/etc/pretix \
-        -v /var/run/redis:/var/run/redis \
-        --sysctl net.core.somaxconn=4096 \
-        pretix/standalone:stable all
-    ExecStop=/usr/bin/docker stop %n
-
-    [Install]
-    WantedBy=multi-user.target
-
-You can now run the following commands
-to enable and start the service::
-
-    # systemctl daemon-reload
-    # systemctl enable pretix
-    # systemctl start pretix
-
-Cronjob
--------
-
-You need to set up a cronjob that runs the management command ``runperiodic``. The exact interval is not important
-but should be something between every minute and every hour. You could for example configure cron like this::
-
-    15,45 * * * * /usr/bin/docker exec pretix.service pretix cron
-
-The cronjob may run as any user that can use the docker daemon.
-
-SSL
----
-
-The following snippet is an example on how to configure a nginx proxy for pretix::
-
-    server {
-        listen 80 default_server;
-        listen [::]:80 ipv6only=on default_server;
-        server_name pretix.mydomain.com;
-        location / {
-            return 301 https://$host$request_uri;
-        }
-    }
-    server {
-        listen 443 default_server;
-        listen [::]:443 ipv6only=on default_server;
-        server_name pretix.mydomain.com;
-
-        ssl on;
-        ssl_certificate /path/to/cert.chain.pem;
-        ssl_certificate_key /path/to/key.pem;
-
-        location / {
-            proxy_pass http://localhost:8345;
-            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-            proxy_set_header X-Forwarded-Proto https;
-            proxy_set_header Host $http_host;
-        }
-    }
-
-
-We recommend reading about setting `strong encryption settings`_ for your web server.
-
-Next steps
-----------
-
-Yay, you are done! You should now be able to reach pretix at https://pretix.yourdomain.com/control/ and log in as
-*admin@localhost* with a password of *admin*. Don't forget to change that password! Create an organizer first, then
-create an event and start selling tickets!
-
-You should probably read :ref:`maintainance` next.
-
-.. _`docker_updates`:
-
-Updates
--------
-
-.. warning:: While we try hard not to break things, **please perform a backup before every upgrade**.
-
-Updates are fairly simple, but require at least a short downtime::
-
-    # docker pull pretix/standalone:stable
-    # systemctl restart pretix.service
-    # docker exec -it pretix.service pretix upgrade
-
-Restarting the service can take a few seconds, especially if the update requires changes to the database.
-Replace ``stable`` above with a specific version number like ``1.0`` or with ``latest`` for the development
-version, if you want to.
-
-Make sure to also read :ref:`update_notes` and the release notes of the version you are updating to.
-
-.. _`docker_plugininstall`:
-
-Install a plugin
-----------------
-
-To install a plugin, you need to build your own docker image. To do so, create a new directory and place a file
-named ``Dockerfile`` in it. The Dockerfile could look like this (replace ``pretix-passbook`` with the plugins of your
-choice)::
-
-    FROM pretix/standalone:stable
-    USER root
-    RUN pip3 install pretix-passbook
-    USER pretixuser
-    RUN cd /pretix/src && make production
-
-Then, go to that directory and build the image::
-
-    $ docker build . -t mypretix
-
-You can now use that image ``mypretix`` instead of ``pretix/standalone`` in your service file (see above). Be sure
-to re-build your custom image after you pulled ``pretix/standalone`` if you want to perform an update.
-
-Scaling up
-----------
-
-If you need to scale to multiple machines, please first read our :ref:`scaling guide <scaling>`.
-
-If you run the official docker container on multiple machines, it is recommended to set the environment
-variable ``AUTOMIGRATE=skip`` on all containers and run ``docker exec -it pretix.service pretix migrate``
-on one machine after each upgrade manually, otherwise multiple containers might try to upgrade the
-database schema at the same time.
-
-To run only the ``pretix-web`` component of pretix as well as a nginx server serving static files, you
-can invoke the container with ``docker run … pretix/standalone:stable web`` (instead of ``all``). You
-can adjust the number of ``gunicorn`` processes with the ``NUM_WORKERS`` environment variable (defaults to
-two times the number of CPUs detected).
-
-To run only ``pretix-worker``, you can run ``docker run … pretix/standalone:stable taskworker``. You can
-also pass arguments to limit the worker to specific queues or to change the number of concurrent task
-workers, e.g. ``docker run … taskworker -Q notifications --concurrency 32``.
-
-
-.. _Docker: https://docs.docker.com/engine/installation/linux/debian/
-.. _Postfix: https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-postfix-as-a-send-only-smtp-server-on-ubuntu-22-04
-.. _nginx: https://botleg.com/stories/https-with-lets-encrypt-and-nginx/
-.. _Let's Encrypt: https://letsencrypt.org/
-.. _pretix.eu: https://pretix.eu/
-.. _PostgreSQL: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-22-04
-.. _redis: https://blog.programster.org/debian-8-install-redis-server/
-.. _ufw: https://en.wikipedia.org/wiki/Uncomplicated_Firewall
-.. _redis website: https://redis.io/topics/security
-.. _redis in docker: https://hub.docker.com/r/_/redis/
-.. _strong encryption settings: https://mozilla.github.io/server-side-tls/ssl-config-generator/

doc/admin/installation/enterprise.rst

@@ -1,84 +0,0 @@
-.. highlight:: none
-
-Installing pretix Enterprise plugins
-====================================
-
-If you want to use a feature of pretix that is part of our commercial offering pretix Enterprise, you need to follow
-some extra steps. Installation works similar to normal pretix plugins, but involves a few extra steps.
-
-Buying the license
-------------------
-
-To obtain a license, please get in touch at sales@pretix.eu. Please let us know how many tickets you roughly intend
-to sell per year and how many servers you want to use the plugin on. We recommend having a look at our `price list`_
-first.
-
-
-Manual installation
--------------------
-
-First, generate an SSH key for the system user that you install pretix as. In our tutorial, that would be the user
-``pretix``. Choose an empty passphrase::
-
-    # su pretix
-    $ ssh-keygen
-    Generating public/private rsa key pair.
-    Enter file in which to save the key (/var/pretix/.ssh/id_rsa):
-    Enter passphrase (empty for no passphrase):
-    Enter same passphrase again:
-    Your identification has been saved in /var/pretix/.ssh/id_rsa.
-    Your public key has been saved in /var/pretix/.ssh/id_rsa.pub.
-
-Next, send the content of the *public* key to your sales representative at pretix::
-
-    $ cat /var/pretix/.ssh/id_rsa.pub
-    ssh-rsa AAAAB3N...744HZawHlD pretix@foo
-
-After we configured your key in our system, you can install the plugin directly using ``pip`` from the URL we told
-you, for example::
-
-    $ source /var/pretix/venv/bin/activate
-    (venv)$ pip3 install -U "git+ssh://git@code.rami.io:10022/pretix/pretix-slack.git@stable#egg=pretix-slack"
-    (venv)$ python -m pretix migrate
-    (venv)$ python -m pretix rebuild
-    # systemctl restart pretix-web pretix-worker
-
-Docker installation
--------------------
-
-To install a plugin, you need to build your own docker image. To do so, create a new directory to work in. As a first
-step, generate a new SSH key in that directory to use for authentication with us::
-
-    $ cd /home/me/mypretixdocker
-    $ ssh-keygen -N "" -f id_pretix_enterprise
-
-Next, send the content of the *public* key to your sales representative at pretix::
-
-    $ cat id_pretix_enterprise.pub
-    ssh-rsa AAAAB3N...744HZawHlD pretix@foo
-
-After we configured your key in our system, you can add a ``Dockerfile`` in your directory that includes the newly
-generated key and installs the plugin from the URL we told you::
-
-    FROM pretix/standalone:stable
-    USER root
-    COPY id_pretix_enterprise /root/.ssh/id_rsa
-    COPY id_pretix_enterprise.pub /root/.ssh/id_rsa.pub
-    RUN chmod -R 0600 /root/.ssh && \
-        mkdir -p /etc/ssh && \
-        ssh-keyscan -t rsa -p 10022 code.rami.io >> /root/.ssh/known_hosts && \
-        echo StrictHostKeyChecking=no >> /root/.ssh/config && \
-        DJANGO_SETTINGS_MODULE=pretix.settings pip3 install -U "git+ssh://git@code.rami.io:10022/pretix/pretix-slack.git@stable#egg=pretix-slack" && \
-        cd /pretix/src && \
-        sudo -u pretixuser make production
-    USER pretixuser
-
-Then, build the image for docker::
-
-    $ docker build -t mypretix
-
-You can now use that image ``mypretix`` instead of ``pretix/standalone:stable`` in your ``/etc/systemd/system/pretix.service``
-service file. Be sure to re-build your custom image after you pulled ``pretix/standalone`` if you want to perform an
-update to a new version of pretix.
-
-.. _price list: https://pretix.eu/about/en/pricing

doc/admin/installation/general.rst

@@ -1,39 +0,0 @@
-.. highlight:: ini
-
-.. spelling:word-list:: SQL
-
-General remarks
-===============
-
-Requirements
-------------
-To use pretix, you will need the following things:
-
-* **pretix** and the python packages it depends on
-
-* An **WSGI application server** (we recommend gunicorn)
-
-* A periodic task runner, e.g. ``cron``
-
-* **A database**. This needs to be a SQL-based that is supported by Django. We highly recommend to either
-  go for **PostgreSQL**. If you do not provide one, pretix will run on SQLite, which is useful
-  for evaluation and development purposes.
-
-  .. warning:: Do not ever use SQLite in production. It will break.
-
-* A **reverse proxy**. pretix needs to deliver some static content to your users (e.g. CSS, images, ...). While pretix
-  is capable of doing this, having this handled by a proper web server like **nginx** or **Apache** will be much
-  faster. Also, you need a proxying web server in front to provide SSL encryption.
-
-  .. warning:: Do not ever run without SSL in production. Your users deserve encrypted connections and thanks to
-               `Let's Encrypt`_ SSL certificates can be obtained for free these days.
-
-* A **redis** server. This will be used for caching, session storage and task queuing.
-
-  .. warning:: pretix can run without redis, however this is only intended for development and should never be
-               used in production.
-
-* Optionally: RabbitMQ or memcached. Both of them might provide speedups, but if they are not present,
-  redis will take over their job.
-
-.. _Let's Encrypt: https://letsencrypt.org/

doc/admin/installation/index.rst

@@ -1,16 +0,0 @@
-.. _`installation`:
-
-Installation guide
-==================
-
-We provide you with multiple installation guides for multiple types of setups so you can choose the one appropriate
-for your needs.
-
-.. toctree::
-   :maxdepth: 1
-
-   general
-   docker_smallscale
-   manual_smallscale
-   dev_version
-   enterprise

doc/admin/installation/manual_smallscale.rst

@@ -1,335 +0,0 @@
-.. highlight:: none
-
-Small-scale manual deployment
-=============================
-
-This guide describes the installation of a small-scale installation of pretix from source. By small-scale, we mean
-that everything is being run on one host and you don't expect thousands of participants trying to get a ticket within
-a few minutes. In this setup, you will have to perform a number of manual steps. If you prefer using a container
-solution with many things readily set-up, look at :ref:`dockersmallscale`.
-
-.. warning:: Even though we try to make it straightforward to run pretix, it still requires some Linux experience to
-             get it right. If you're not feeling comfortable managing a Linux server, check out our hosting and service
-             offers at `pretix.eu`_.
-
-We tested this guide on the Linux distribution **Debian 11.6** but it should work very similar on other
-modern distributions, especially on all systemd-based ones.
-
-Requirements
-------------
-
-Please set up the following systems beforehand, we'll not explain them here in detail (but see these links for external
-installation guides):
-
-* A python 3.9+ installation
-* A SMTP server to send out mails, e.g. `Postfix`_ on your machine or some third-party server you have credentials for
-* A HTTP reverse proxy, e.g. `nginx`_ or Apache to allow HTTPS connections
-* A `PostgreSQL`_ 11+ database server
-* A `redis`_ server
-* A `nodejs`_ installation
-
-We also recommend that you use a firewall, although this is not a pretix-specific recommendation. If you're new to
-Linux and firewalls, we recommend that you start with `ufw`_.
-
-.. note:: Please, do not run pretix without HTTPS encryption. You'll handle user data and thanks to `Let's Encrypt`_
-          SSL certificates can be obtained for free these days. We also *do not* provide support for HTTP-only
-          installations except for evaluation purposes.
-
-Unix user
----------
-
-As we do not want to run pretix as root, we first create a new unprivileged user::
-
-    # adduser pretix --disabled-password --home /var/pretix
-
-In this guide, all code lines prepended with a ``#`` symbol are commands that you need to execute on your server as
-``root`` user (e.g. using ``sudo``); all lines prepended with a ``$`` symbol should be run by the unprivileged user.
-
-Database
---------
-
-Having the database server installed, we still need a database and a database user. We can create these with any kind
-of database managing tool or directly on our database's shell. Please make sure that UTF8 is used as encoding for the
-best compatibility. You can check this with the following command::
-
-    # sudo -u postgres psql -c 'SHOW SERVER_ENCODING'
-
-For PostgreSQL database creation, we would do::
-
-    # sudo -u postgres createuser pretix
-    # sudo -u postgres createdb -O pretix pretix
-
-Package dependencies
---------------------
-
-To build and run pretix, you will need the following debian packages::
-
-    # apt-get install git build-essential python-dev python3-venv python3 python3-pip \
-                      python3-dev libxml2-dev libxslt1-dev libffi-dev zlib1g-dev libssl-dev \
-                      gettext libpq-dev libjpeg-dev libopenjp2-7-dev
-
-Config file
------------
-
-We now create a config directory and config file for pretix::
-
-    # mkdir /etc/pretix
-    # touch /etc/pretix/pretix.cfg
-    # chown -R pretix:pretix /etc/pretix/
-    # chmod 0600 /etc/pretix/pretix.cfg
-
-Fill the configuration file ``/etc/pretix/pretix.cfg`` with the following content (adjusted to your environment)::
-
-    [pretix]
-    instance_name=My pretix installation
-    url=https://pretix.mydomain.com
-    currency=EUR
-    datadir=/var/pretix/data
-    trust_x_forwarded_for=on
-    trust_x_forwarded_proto=on
-
-    [database]
-    backend=postgresql
-    name=pretix
-    user=pretix
-    ; For PostgreSQL on the same host, we don't need a password because we can use
-    ; peer authentication if our PostgreSQL user matches our unix user.
-    password=
-    ; For local postgres authentication, you can leave it empty
-    host=
-
-    [mail]
-    ; See config file documentation for more options
-    from=tickets@yourdomain.com
-    host=127.0.0.1
-
-    [redis]
-    location=redis://127.0.0.1/0
-    sessions=true
-
-    [celery]
-    backend=redis://127.0.0.1/1
-    broker=redis://127.0.0.1/2
-
-See :ref:`email configuration <mail-settings>` to learn more about configuring mail features.
-
-Install pretix from PyPI
-------------------------
-
-Now we will install pretix itself. The following steps are to be executed as the ``pretix`` user. Before we
-actually install pretix, we will create a virtual environment to isolate the python packages from your global
-python installation::
-
-    $ python3 -m venv /var/pretix/venv
-    $ source /var/pretix/venv/bin/activate
-    (venv)$ pip3 install -U pip setuptools wheel
-
-We now install pretix, its direct dependencies and gunicorn::
-
-    (venv)$ pip3 install pretix gunicorn
-
-Note that you need Python 3.9 or newer. You can find out your Python version using ``python -V``.
-
-We also need to create a data directory::
-
-    (venv)$ mkdir -p /var/pretix/data/media
-
-Finally, we compile static files and translation data and create the database structure::
-
-    (venv)$ python -m pretix migrate
-    (venv)$ python -m pretix rebuild
-
-
-Start pretix as a service
--------------------------
-
-We recommend starting pretix using systemd to make sure it runs correctly after a reboot. Create a file
-named ``/etc/systemd/system/pretix-web.service`` with the following content::
-
-    [Unit]
-    Description=pretix web service
-    After=network.target
-
-    [Service]
-    User=pretix
-    Group=pretix
-    Environment="VIRTUAL_ENV=/var/pretix/venv"
-    Environment="PATH=/var/pretix/venv/bin:/usr/local/bin:/usr/bin:/bin"
-    ExecStart=/var/pretix/venv/bin/gunicorn pretix.wsgi \
-                          --name pretix --workers 5 \
-                          --max-requests 1200  --max-requests-jitter 50 \
-                          --log-level=info --bind=127.0.0.1:8345
-    WorkingDirectory=/var/pretix
-    Restart=on-failure
-
-    [Install]
-    WantedBy=multi-user.target
-
-For background tasks we need a second service ``/etc/systemd/system/pretix-worker.service`` with the following content::
-
-    [Unit]
-    Description=pretix background worker
-    After=network.target
-
-    [Service]
-    User=pretix
-    Group=pretix
-    Environment="VIRTUAL_ENV=/var/pretix/venv"
-    Environment="PATH=/var/pretix/venv/bin:/usr/local/bin:/usr/bin:/bin"
-    ExecStart=/var/pretix/venv/bin/celery -A pretix.celery_app worker -l info
-    WorkingDirectory=/var/pretix
-    Restart=on-failure
-
-    [Install]
-    WantedBy=multi-user.target
-
-You can now run the following commands to enable and start the services::
-
-    # systemctl daemon-reload
-    # systemctl enable pretix-web pretix-worker
-    # systemctl start pretix-web pretix-worker
-
-
-Cronjob
--------
-
-You need to set up a cronjob that runs the management command ``runperiodic``. The exact interval is not important
-but should be something between every minute and every hour. You could for example configure cron like this::
-
-    15,45 * * * * export PATH=/var/pretix/venv/bin:$PATH && cd /var/pretix && python -m pretix runperiodic
-
-The cronjob should run as the ``pretix`` user (``crontab -e -u pretix``).
-
-SSL
----
-
-The following snippet is an example on how to configure a nginx proxy for pretix::
-
-    server {
-        listen 80 default_server;
-        listen [::]:80 ipv6only=on default_server;
-        server_name pretix.mydomain.com;
-        location / {
-            return 301 https://$host$request_uri;
-        }
-    }
-    server {
-        listen 443 default_server;
-        listen [::]:443 ipv6only=on default_server;
-        server_name pretix.mydomain.com;
-
-        ssl on;
-        ssl_certificate /path/to/cert.chain.pem;
-        ssl_certificate_key /path/to/key.pem;
-
-        add_header Referrer-Policy same-origin;
-        add_header X-Content-Type-Options nosniff;
-
-        location / {
-            proxy_pass http://localhost:8345;
-            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-            proxy_set_header X-Forwarded-Proto https;
-            proxy_set_header Host $http_host;
-        }
-
-        location /media/ {
-            alias /var/pretix/data/media/;
-            expires 7d;
-            access_log off;
-        }
-
-        location ^~ /media/cachedfiles {
-            deny all;
-            return 404;
-        }
-        location ^~ /media/invoices {
-            deny all;
-            return 404;
-        }
-
-        location /static/ {
-            alias /var/pretix/venv/lib/python3.10/site-packages/pretix/static.dist/;
-            access_log off;
-            expires 365d;
-            add_header Cache-Control "public";
-        }
-    }
-
-.. note:: Remember to replace the ``python3.10`` in the ``/static/`` path in the config
-          above with your python version.
-
-We recommend reading about setting `strong encryption settings`_ for your web server.
-
-Next steps
-----------
-
-Yay, you are done! You should now be able to reach pretix at https://pretix.yourdomain.com/control/ and log in as
-*admin@localhost* with a password of *admin*. Don't forget to change that password! Create an organizer first, then
-create an event and start selling tickets!
-
-You should probably read :ref:`maintainance` next.
-
-.. _`manual_updates`:
-
-Updates
--------
-
-.. warning:: While we try hard not to break things, **please perform a backup before every upgrade**.
-
-To upgrade to a new pretix release, pull the latest code changes and run the following commands::
-
-    $ source /var/pretix/venv/bin/activate
-    (venv)$ pip3 install -U --upgrade-strategy eager pretix gunicorn
-    (venv)$ python -m pretix migrate
-    (venv)$ python -m pretix rebuild
-    (venv)$ python -m pretix updatestyles
-    # systemctl restart pretix-web pretix-worker
-
-Make sure to also read :ref:`update_notes` and the release notes of the version you are updating to.
-
-.. _`manual_plugininstall`:
-
-Install a plugin
-----------------
-
-To install a plugin, just use ``pip``! Depending on the plugin, you should probably apply database migrations and
-rebuild the static files afterwards. Replace ``pretix-passbook`` with the plugin of your choice in the following
-example::
-
-    $ source /var/pretix/venv/bin/activate
-    (venv)$ pip3 install pretix-passbook
-    (venv)$ python -m pretix migrate
-    (venv)$ python -m pretix rebuild
-    # systemctl restart pretix-web pretix-worker
-
-System updates
---------------
-
-After system updates, such as updates to a new Ubuntu or Debian release, you might be using a new Python version.
-That's great, but requires some adjustments. First, adjust any old version paths in your nginx configuration file.
-Then, re-create your Python environment::
-
-    $ source /var/pretix/venv/bin/activate
-    (venv)$ pip3 freeze > /tmp/pip-backup.txt
-    $ rm -rf /var/pretix/venv
-    $ python3 -m venv /var/pretix/venv
-    $ source /var/pretix/venv/bin/activate
-    (venv)$ pip3 install -U pip wheel setuptools
-    (venv)$ pip3 install -r /tmp/pip-backup.txt
-
-Then, proceed like after any plugin installation::
-
-    (venv)$ python -m pretix migrate
-    (venv)$ python -m pretix rebuild
-    (venv)$ python -m pretix updatestyles
-    # systemctl restart pretix-web pretix-worker
-
-.. _Postfix: https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-postfix-as-a-send-only-smtp-server-on-ubuntu-22-04
-.. _nginx: https://botleg.com/stories/https-with-lets-encrypt-and-nginx/
-.. _Let's Encrypt: https://letsencrypt.org/
-.. _pretix.eu: https://pretix.eu/
-.. _PostgreSQL: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-22-04
-.. _redis: https://blog.programster.org/debian-8-install-redis-server/
-.. _ufw: https://en.wikipedia.org/wiki/Uncomplicated_Firewall
-.. _strong encryption settings: https://mozilla.github.io/server-side-tls/ssl-config-generator/
-.. _nodejs: https://github.com/nodesource/distributions/blob/master/README.md#deb

doc/admin/maintainance.rst

@@ -1,108 +0,0 @@
-.. highlight:: ini
-
-.. _`maintainance`:
-
-Backups and Monitoring
-======================
-
-If you host your own pretix instance, you also need to care about the availability
-of your service and the safety of your data yourself. This page gives you some
-information that you might need to do so properly.
-
-.. _`backups`:
-
-Backups
--------
-
-There are essentially two things which you should create backups of:
-
-Database
-    Your SQL database. This is critical and you should **absolutely always create automatic
-    backups of your database**. There are tons of tutorials on the internet on how to do this,
-    and the exact process depends on the choice of your database. For PostgreSQL, see the
-    ``pg_dump`` tool. You probably want to create a cronjob that does the backups for you on a
-    regular schedule.
-
-Data directory
-    The data directory of your pretix configuration might contain some things that you should
-    back up. If you did not specify a secret in your config file, back up the ``.secret`` text
-    file in the data directory. If you lose your secret, all currently active user sessions,
-    password reset links and similar things will be rendered invalid. Also, you probably want
-    to backup the ``media`` subdirectory of the data directory which contains all user-uploaded
-    and generated files. This includes files you could in theory regenerate (ticket downloads)
-    but also files that you might be legally required to keep (invoice PDFs) or files that you
-    would need to re-upload (event logos, product pictures, etc.). It is up to you if you
-    create regular backups of this data, but we strongly advise you to do so. You can create
-    backups e.g. using ``rsync``. There is a lot of information on the internet on how to create
-    backups of folders on a Linux machine.
-
-There is no need to create backups of the redis database, if you use it. We only use it for
-non-critical, temporary or cached data.
-
-Uptime monitoring
------------------
-
-To monitor whether your pretix instance is running, you can issue a GET request to
-``https://pretix.mydomain.com/healthcheck/``. This endpoint tests if the connection to the
-database, to the configured cache and to redis (if used) is working correctly. If everything
-appears to work fine, an empty response with status code ``200`` is returned.
-If there is a problem, a status code in the ``5xx`` range will be returned.
-
-.. _`perf-monitoring`:
-
-Performance monitoring
-----------------------
-
-If you want to generate detailed performance statistics of your pretix installation, there is an
-endpoint at ``https://pretix.mydomain.com/metrics`` (no slash at the end) which returns a
-number of values in the text format understood by monitoring tools like Prometheus_. This data
-is only collected and exposed if you enable it in the :ref:`metrics-settings` section of your
-pretix configuration. You can also configure basic auth credentials there to protect your
-statistics against unauthorized access. The data is temporarily collected in redis, so the
-performance impact of this feature depends on the connection to your redis database.
-
-Currently, mostly response times of HTTP requests and background tasks are exposed.
-
-If you want to go even further, you can set the ``profile`` option in the :ref:`django-settings`
-section to a value between 0 and 1. If you set it for example to 0.1, then 10% of your requests
-(randomly selected) will be run with cProfile_ activated. The profiling results will be saved
-to your data directory. As this might impact performance significantly and writes a lot of data
-to disk, we recommend to only enable it for a small number of requests -- and only if you are
-really interested in the results.
-
-Available metrics
-^^^^^^^^^^^^^^^^^
-
-The metrics available in pretix follow the standard `metric types`_ from the Prometheus world.
-Currently, the following metrics are exported:
-
-pretix_view_requests_total
-    Counter. Counts requests to Django views, labeled with the resolved ``url_name``, the used
-    HTTP ``method`` and the ``status_code`` returned.
-
-pretix_view_durations_seconds
-    Histogram. Measures duration of requests to Django views, labeled with the resolved
-    ``url_name``, the used HTTP ``method`` and the ``status_code`` returned.
-
-pretix_task_runs_total
-    Counter. Counts executions of background tasks, labeled with the ``task_name`` and the
-    ``status``. The latter can be ``success``, ``error`` or ``expected-error``.
-
-pretix_task_duration_seconds
-    Histogram. Measures duration of successful background task executions, labeled with the
-    ``task_name``.
-
-pretix_model_instances
-    Gauge. Measures number of instances of a certain model within the database, labeled with
-    the ``model`` name. Starting with pretix 3.11, these numbers might only be approximate for
-    most tables when running on PostgreSQL to mitigate performance impact.
-
-pretix_celery_tasks_queued_count
-    The number of background tasks in the worker queue, labeled with ``queue``.
-
-pretix_celery_tasks_queued_age_seconds
-    The age of the longest-waiting in the worker queue in seconds, labeled with ``queue``.
-
-.. _metric types: https://prometheus.io/docs/concepts/metric_types/
-.. _Prometheus: https://prometheus.io/
-.. _cProfile: https://docs.python.org/3/library/profile.html

doc/admin/mysql2postgres.rst

@@ -1,241 +0,0 @@
-.. highlight:: none
-
-Migrating from MySQL/MariaDB to PostgreSQL
-==========================================
-
-Our recommended database for all production installations is PostgreSQL. Support for MySQL/MariaDB has been removed
-in newer pretix releases.
-
-In order to follow this guide, your pretix installation needs to be a version that fully supports MySQL/MariaDB. If you
-already upgraded to pretix 5.0 or later, downgrade back to the last 4.x release using ``pip``.
-
-.. note:: We have tested this guide carefully, but we can't assume any liability for its correctness. The data loss
-          risk should be low as long as pretix is not running while you do the migration. If you are a pretix Enterprise
-          customer, feel free to reach out in advance if you want us to support you along the way.
-
-Update database schema
-----------------------
-
-Before you start, make sure your database schema is up to date::
-
-    # sudo -u pretix -s
-    $ source /var/pretix/venv/bin/activate
-    (venv)$ python -m pretix migrate
-
-Install PostgreSQL
-------------------
-
-Now, install and set up a PostgreSQL server. For a local installation on Debian or Ubuntu, use::
-
-    # apt install postgresql
-
-Having the database server installed, we still need a database and a database user. We can create these with any kind
-of database managing tool or directly on our database's shell. Please make sure that UTF8 is used as encoding for the
-best compatibility. You can check this with the following command::
-
-    # sudo -u postgres psql -c 'SHOW SERVER_ENCODING'
-
-Without Docker
-""""""""""""""
-
-For our standard manual installation, create the database and user like this::
-
-    # sudo -u postgres createuser pretix
-    # sudo -u postgres createdb -O pretix pretix
-
-With Docker
-"""""""""""
-
-For our standard docker installation, create the database and user like this::
-
-    # sudo -u postgres createuser -P pretix
-    # sudo -u postgres createdb -O pretix pretix
-
-Make sure that your database listens on the network. If PostgreSQL on the same same host as docker, but not inside a docker container, we recommend that you listen on the Docker interface by changing the following line in ``/etc/postgresql/<version>/main/postgresql.conf``::
-
-    listen_addresses = 'localhost,172.17.0.1'
-
-You also need to add a new line to ``/etc/postgresql/<version>/main/pg_hba.conf`` to allow network connections to this user and database::
-
-    host    pretix          pretix          172.17.0.1/16           md5
-
-Restart PostgreSQL after you changed these files::
-
-    # systemctl restart postgresql
-
-If you have a firewall running, you should also make sure that port 5432 is reachable from the ``172.17.0.1/16`` subnet.
-
-Of course, instead of all this you can also run a PostgreSQL docker container and link it to the pretix container.
-
-Stop pretix
------------
-
-To prevent any more changes to your data, stop pretix from running::
-
-    # systemctl stop pretix-web pretix-worker
-
-Change configuration
---------------------
-
-Change the database configuration in your ``/etc/pretix/pretix.cfg`` file::
-
-    [database]
-    backend=postgresql
-    name=pretix
-    user=pretix
-    password=  ; only required for docker or remote database, can be kept empty for local auth
-    host=      ; set to 172.17.0.1 in docker setup, keep empty for local auth
-
-
-Create database schema
------------------------
-
-To create the schema in your new PostgreSQL database, use the following commands::
-
-    # sudo -u pretix -s
-    $ source /var/pretix/venv/bin/activate
-    (venv)$ python -m pretix migrate
-
-
-Migrate your data
------------------
-
-Install ``pgloader``::
-
-    # apt install pgloader
-
-.. note::
-
-   If you are using Ubuntu 20.04, the ``pgloader`` version from the repositories seems to be incompatible with PostgreSQL
-   12+. You can install ``pgloader`` from the `PostgreSQL repositories`_ instead.
-   See also `this discussion <https://github.com/pretix/pretix/issues/3090>`_.
-
-Create a new file ``/tmp/pretix.load``, replacing the MySQL and PostgreSQL connection strings with the correct user names, passwords, and/or database names::
-
-    LOAD DATABASE
-        FROM mysql://pretix:password@localhost/pretix  -- replace with mysql://username:password@hostname/dbname
-        INTO postgresql:///pretix                      -- replace with dbname
-
-    WITH data only, include no drop, truncate, disable triggers,
-         create no indexes, drop indexes, reset sequences
-
-    ALTER SCHEMA 'pretix' RENAME TO 'public'           -- replace pretix with the name of the MySQL database
-
-    ALTER TABLE NAMES MATCHING ~/.*/
-        SET SCHEMA 'public'
-
-    SET timezone TO '+00:00'
-
-    SET PostgreSQL PARAMETERS
-         maintenance_work_mem to '128MB',
-         work_mem to '12MB';
-
-Then, run::
-
-    # sudo -u postgres pgloader /tmp/pretix.load
-
-The output should end with a table summarizing the results for every table. You can ignore warnings about type casts
-and missing constraints.
-
-Afterwards, delete the file again::
-
-    # rm -rf /tmp/pretix.load
-
-Start pretix
-------------
-
-Now, restart pretix. Maybe stop your MySQL server as a verification step that you are no longer using it::
-
-    # systemctl stop mariadb
-    # systemctl start pretix-web pretix-worker
-
-And you're done! After you've verified everything has been copied correctly, you can delete the old MySQL database.
-
-.. note:: Don't forget to update your backup process to back up your PostgreSQL database instead of your MySQL database now.
-
-Troubleshooting
----------------
-
-Peer authentication failed
-""""""""""""""""""""""""""
-
-Sometimes you might see an error message like this::
-
-    django.db.utils.OperationalError: connection to server on socket "/var/run/postgresql/.s.PGSQL.5432" failed: FATAL:  Peer authentication failed for user "pretix"
-
-It is important to understand that PostgreSQL by default offers two types of authentication:
-
-- **Peer authentication**, which works automatically based on the Linux user you are working as. This requires that
-  the connection is made through a local socket (empty ``host=`` in ``pretix.cfg``) and the name of the PostgreSQL user
-  and the Linux user are identical.
-
-  - Typically, you might run into this error if you accidentally execute ``python -m pretix`` commands as root instead
-    of the ``pretix`` user.
-
-- **Password authentication**, which requires a username and password and works over network connections. To force
-  password authentication instead of peer authentication, set ``host=127.0.0.1`` in ``pretix.cfg``.
-
-  - You can alter the password on a PostgreSQL shell using the command ``ALTER USER pretix WITH PASSWORD '***';``.
-    When creating a user with the ``createuser`` command, pass option ``-P`` to set a new password.
-
-  - Even with password authentication, PostgreSQL by default only allows local connections. To allow remote connections,
-    you need to adjust both the ``listen_address`` configuration parameter as well as the ``pg_hba.conf`` file (see above
-    for an example with the docker networking setup).
-
-Database error: relation does not exist
-"""""""""""""""""""""""""""""""""""""""
-
-If you see an error like this::
-
-    2023-04-17T19:20:47.744023Z ERROR Database error 42P01: relation "public.pretix_foobar" does not exist
-    QUERY: ALTER TABLE public.pretix_foobar DROP CONSTRAINT IF EXISTS pretix_foobar_order_id_57e2cb41_fk_pretixbas CASCADE;
-    2023-04-17T19:20:47.744023Z FATAL Failed to create the schema, see above.
-
-The reason is most likely that in the past, you installed a pretix plugin that you no longer have installed. However,
-the database still contains tables of that plugin. If you want to keep the data, reinstall the plugin and re-run the
-``migrate`` step from above. If you want to get rid of the data, manually drop the table mentioned in the error message
-from your MySQL database::
-
-    # mysql -u root pretix
-    mysql> DROP TABLE pretix_foobar;
-
-Then, retry. You might see a new error message with a new table, which you can handle the same way.
-
-Cleaning out a failed attempt
-"""""""""""""""""""""""""""""
-
-You might want to clean your PostgreSQL database before you try again after an error. You can do so like this::
-
-    # sudo -u postgres psql pretix
-    pretix=# DROP SCHEMA public CASCADE;
-    pretix=# CREATE SCHEMA public;
-    pretix=# ALTER SCHEMA public OWNER TO pretix;
-
-``pgloader`` crashes with heap exhaustion error
-"""""""""""""""""""""""""""""""""""""""""""""""
-
-On some larger databases, we've seen ``pgloader`` crash with error messages similar to this::
-
-    Heap exhausted during garbage collection: 16 bytes available, 48 requested.
-
-Or this::
-
-    2021-01-04T21:31:17.367000Z ERROR A SB-KERNEL::HEAP-EXHAUSTED-ERROR condition without bindings for heap statistics.  (If
-    you did not expect to see this message, please report it.
-    2021-01-04T21:31:17.382000Z ERROR The value
-      NIL
-    is not of type
-      NUMBER
-    when binding SB-KERNEL::X
-
-The ``pgloader`` version distributed for Debian and Ubuntu is compiled with the ``SBCL`` compiler. If compiled with
-``CCL``, these bugs go away. Unfortunately, it is pretty hard to compile ``pgloader`` manually with ``CCL``. If you
-run into this, we therefore recommend using the docker container provided by the ``pgloader`` maintainers::
-
-    sudo docker run --rm -v /tmp:/tmp --network host -it dimitri/pgloader:ccl.latest pgloader /tmp/pretix.load
-
-As peer authentication is not available from inside the container, this requires you to use password-based authentication
-in PostgreSQL (see above).
-
-
-.. _PostgreSQL repositories: https://wiki.postgresql.org/wiki/Apt

doc/admin/scaling.rst

@@ -1,236 +0,0 @@
-.. _`scaling`:
-
-Scaling guide
-=============
-
-Our :ref:`installation guide <installation>` only covers "small-scale" setups, by which we mostly mean
-setups that run on a **single (virtual) machine** and do not encounter large traffic peaks.
-
-We do not offer an installation guide for larger-scale setups of pretix, mostly because we believe that
-there is no one-size-fits-all solution for this and the desired setup highly depends on your use case,
-the platform you run pretix on, and your technical capabilities. We do not recommend trying set up pretix
-in a multi-server environment if you do not already have experience with managing server clusters.
-
-This document is intended to give you a general idea on what issues you will encounter when you scale up
-and what you should think of.
-
-.. tip::
-
-   If you require more help on this, we're happy to help. Our pretix Enterprise support team has built
-   and helped building, scaling and load-testing pretix installations at any scale and we're looking
-   forward to work with you on fine-tuning your system. If you intend to sell **more than a thousand
-   tickets in a very short amount of time**, we highly recommend reaching out and at least talking this
-   through. Just get in touch at sales@pretix.eu!
-
-Scaling reasons
----------------
-
-There are two main reasons for scaling up a pretix installation beyond a single server:
-
-* **Availability:** Distributing pretix over multiple servers can allow you to survive failure of one or more single machines, leading to a higher uptime and reliability of your system.
-
-* **Traffic and throughput:** Distributing pretix over multiple servers can allow you to process more web requests and ticket sales at the same time.
-
-You are very unlikely to require scaling for other reasons, such as having too much data in your database.
-
-Components
-----------
-
-A pretix installation usually consists of the following components which run performance-relevant processes:
-
-* ``pretix-web`` is the Django-based web application that serves all user interaction.
-
-* ``pretix-worker`` is a Celery-based application that processes tasks that should be run asynchronously outside of the web application process.
-
-* A **PostgreSQL database** keeps all the important data and processes the actual transactions.
-
-* A **web server** that terminates TLS and HTTP connections and forwards them to ``pretix-web``. In some cases, e.g. when serving static files, the web servers might return a response directly. We recommend using ``nginx``.
-
-* A **redis** server responsible for the communication between ``pretix-web`` and ``pretix-worker``, as well as for caching.
-
-* A directory of **media files** such as user-uploaded files or generated files (tickets, invoices, …) that are created and used by ``pretix-web``, ``pretix-worker`` and the web server.
-
-In the following, we will discuss the scaling behavior of every component individually. In general, you can run all of the components
-on the same server, but you can just as well distribute every component to its own server, or even use multiple servers for some single
-components.
-
-.. warning::
-
-   When setting up your system, don't forget about security. In a multi-server environment,
-   you need to take special care to ensure that no unauthorized access to your database
-   is possible through the network and that it's not easy to wiretap your connections. We
-   recommend a rigorous use of firewalls and encryption on all communications. You can
-   ensure this either on an application level (such as using the TLS support in your
-   database) or on a network level with a VPN solution.
-
-Web server
-""""""""""
-
-Your web server is at the very front of your installation. It will need to absorb all of the traffic, and it should be able to
-at least show a decent error message, even when everything else fails. Luckily, web servers are really fast these days, so this
-can be achieved without too much work.
-
-We recommend reading up on tuning your web server for high concurrency. For nginx, this means thinking about the number of worker
-processes and the number of connections each worker process accepts. Double-check that TLS session caching works, because TLS
-handshakes can get really expensive.
-
-During a traffic peak, your web server will be able to make use of more CPU resources, while memory usage will stay comparatively low,
-so if you invest in more hardware here, invest in more and faster CPU cores.
-
-Make sure that pretix' static files (such as CSS and JavaScript assets) as well as user-uploaded media files (event logos, etc)
-are served directly by your web server and your web server caches them in-memory (nginx does it by default) and sets useful
-headers for client-side caching. As an additional performance improvement, you can turn of access logging for these types of files.
-If you want, you can even farm out serving static files to a different web server entirely and :ref:`configure pretix to reference
-them from a different URL <config-urls>`.
-
-.. tip::
-
-   If you expect *really high traffic* for your very popular event, you might want to do some rate limiting on this layer, or,
-   if you want to ensure a fair and robust first-come-first-served experience and prefer letting users wait over showing them
-   errors, consider a queuing solution. We're happy to provide you with such systems, just get in touch at sales@pretix.eu.
-
-pretix-web
-""""""""""
-
-The ``pretix-web`` process does not carry any internal state and can be easily started on as many machines as you like, and you can
-use the load balancing features of your frontend web server to redirect to all of them.
-
-You can adjust the number of processes in the ``gunicorn`` command line, and we recommend choosing roughly two times the number
-of CPU cores available. Under load, the memory consumption of ``pretix-web`` will stay comparatively constant, while the CPU usage
-will increase a lot. Therefore, if you can add more or faster CPU cores, you will be able to serve more users.
-
-pretix-worker
-"""""""""""""
-
-The ``pretix-worker`` process performs all operations that are not directly executed in the request-response-cycle of ``pretix-web``.
-Just like ``pretix-web`` you can easily start up as many instances as you want on different machines to share the work. As long as they
-all talk to the same redis server, they will all receive tasks from ``pretix-web``, work on them and post their result back.
-You can configure the number of threads that run tasks in parallel through the ``--concurrency`` command line option of ``celery``.
-
-Just like ``pretix-web``, this process is mostly heavy on CPU, disk IO and network IO, although memory peaks can occur e.g. during the
-generation of large PDF files, so we recommend having some reserves here.
-
-``pretix-worker`` performs a variety of tasks which are of different importance.
-Some of them are mission-critical and need to be run quickly even during high load (such as
-creating a cart or an order), others are irrelevant and can easily run later (such as
-distributing tickets on the waiting list). You can fine-tune the capacity you assign to each
-of these tasks by running ``pretix-worker`` processes that only work on a specific **queue**.
-For example, you could have three servers dedicated only to process order creations and one
-server dedicated only to sending emails. This allows you to set priorities and also protects
-you from e.g. a slow email server lowering your ticket throughput.
-
-You can do so by specifying one or more queues on the ``celery`` command line of this process, such as ``celery -A pretix.celery_app worker -Q notifications,mail``. Currently,
-the following queues exist:
-
-* ``checkout`` -- This queue handles everything related to carts and orders and thereby everything required to process a sale. This includes adding and deleting items from carts as well as creating and canceling orders.
-
-* ``mail`` -- This queue handles sending of outgoing emails.
-
-* ``notifications`` -- This queue handles the processing of any outgoing notifications, such as email notifications to admin users (except for the actual sending) or API notifications to registered webhooks.
-
-* ``background`` -- This queue handles tasks that are expected to take long or have no human waiting for their result immediately, such as refreshing caches, re-generating CSS files, assigning tickets on the waiting list or parsing bank data files.
-
-* ``default`` -- This queue handles everything else with "medium" or unassigned priority, most prominently the generation of files for tickets, invoices, badges, admin exports, etc.
-
-Media files
-"""""""""""
-
-Both ``pretix-web``, ``pretix-worker`` and in some cases your webserver need to work with
-media files. Media files are all files generated *at runtime* by the software. This can
-include files uploaded by the event organizers, such as the event logo, files uploaded by
-ticket buyers (if you use such features) or files generated by the software, such as
-ticket files, invoice PDFs, data exports or customized CSS files.
-
-Those files are by default stored to the ``media/`` sub-folder of the data directory given
-in the ``pretix.cfg`` configuration file. Inside that ``media/`` folder, you will find a
-``pub/`` folder containing the subset of files that should be publicly accessible through
-the web server. Everything else only needs to be accessible by ``pretix-web`` and
-``pretix-worker`` themselves.
-
-If you distribute ``pretix-web`` or ``pretix-worker`` across more than one machine, you
-**must** make sure that they all have access to a shared storage to read and write these
-files, otherwise you **will** run into errors with the user interface.
-
-The easiest solution for this is probably to store them on a NFS server that you mount
-on each of the other servers.
-
-Since we use Django's file storage mechanism internally, you can in theory also use an object-storage solution like Amazon S3, Ceph, or Minio to store these files, although we currently do not expose this through pretix' configuration file and this would require you to ship your own variant of ``pretix/settings.py`` and reference it through the ``DJANGO_SETTINGS_MODULE`` environment variable.
-
-At pretix.eu, we use a custom-built `object storage cluster`_.
-
-SQL database
-""""""""""""
-
-One of the most critical parts of the whole setup is the SQL database -- and certainly the
-hardest to scale. Tuning relational databases is an art form, and while there's lots of
-material on it on the internet, there's not a single recipe that you can apply to every case.
-
-As a general rule of thumb, the more resources you can give your databases, the better.
-Most databases will happily use all CPU cores available, but only use memory up to an amount
-you configure, so make sure to set this memory usage as high as you can afford. Having more
-memory available allows your database to make more use of caching, which is usually good.
-
-Scaling your database to multiple machines needs to be treated with great caution. It's a
-good idea to have a replica of your database for availability reasons. In case your primary
-database server fails, you can easily switch over to the replica and continue working.
-
-However, using database replicas for performance gain is much more complicated. When using
-replicated database systems, you are always trading in consistency or availability to get
-additional performance and the consequences of this can be subtle. It is important
-that you have a deep understanding of the semantics of your replication mechanism.
-
-.. warning::
-
-   Using an off-the-shelf database proxy solution that redirects read queries to your
-   replicas and write queries to your primary database **will lead to very nasty bugs.**
-
-   As an example, if you buy a ticket, pretix first needs to calculate how many tickets
-   are left to sell. If this calculation is done on a database replica that lags behind
-   even for fractions of a second, the decision to allow selling the ticket will be made
-   on stale data and you can end up with more tickets sold than configured. Similarly,
-   you could imagine situations leading to double payments etc.
-
-If you do have a replica, you *can* tell pretix about it :ref:`in your configuration <config-replica>`.
-This way, pretix can offload complex read-only queries to the replica when it is safe to do so.
-As of pretix 2.7, this is mainly used for search queries in the backend and for rendering the
-product list and event lists in the frontend, but we plan on expanding this in the future.
-
-Therefore, for now our clear recommendation is: Try to scale your database vertically and put
-it on the most powerful machine you have available.
-
-redis
-"""""
-
-While redis is a very important part that glues together some of the components, it isn't used
-heavily and can usually handle a fairly large pretix installation easily on a single modern
-CPU core.
-Having some memory available is good, e.g. if lots of tasks queue up during a traffic peak, but we wouldn't expect ever needing more than a gigabyte of it.
-
-Feel free to set up a redis cluster for availability – but you probably won't need it for performance.
-
-The limitations
----------------
-
-Up to a certain point, pretix scales really well. However, there are a few things that we consider
-even more important than scalability, and those are correctness and reliability. We want you to be
-able to trust that pretix will not sell more tickets than you intended or run into similar error
-cases.
-
-Combined with pretix' flexibility and complexity, especially around vouchers and quotas, this creates
-some hard issues. In many cases, we need to fall back to event-global locking for some actions which
-are likely to run with high concurrency and cause harm.
-
-For every event, only one of these locking actions can be run at the same time. Examples for this are
-adding products limited by a quota to a cart, adding items to a cart using a voucher or placing an order
-consisting of cart positions that don't have a valid reservation for much longer. In these cases, it is
-currently not realistically possible to exceed selling **approx. 500 orders per minute per event**, even
-if you add more hardware.
-If you have an unlimited number of tickets, we can apply fewer locking and we've reached **approx.
-1500 orders per minute per event** in benchmarks, although even more should be possible.
-
-We're working on reducing the number of cases in which this is relevant and thereby improve the possible
-throughput. If you want to use pretix for an event with 10,000+ tickets that are likely to be sold out
-within minutes, please get in touch to discuss possible solutions. We'll work something out for you!
-
-
-.. _object storage cluster: https://behind.pretix.eu/2018/03/20/high-available-cdn/

doc/admin/updates.rst

@@ -1,51 +0,0 @@
-.. _`update_notes`:
-
-Update notes
-============
-
-pretix receives regular feature and bugfix updates and we highly encourage you to always update to
-the latest version for maximum quality and security. Updates are announces on our `blog`_. There are
-usually 10 feature updates in a year, so you can expect a new release almost every month.
-
-Pure bugfix releases are only issued in case of very critical bugs or security vulnerabilities. In these
-case, we'll publish bugfix releases for the last three stable release branches.
-
-Compatibility to plugins and in very rare cases API clients may break. For in-depth details on the
-API changes of every version, please refer to the release notes published on our blog.
-
-Upgrade steps
--------------
-
-For the actual upgrade, you can usually just follow the steps from the installation guide for :ref:`manual installations <manual_updates>`
-or :ref:`docker installations <docker_updates>` respectively.
-Generally, it is always strongly recommended to perform a :ref:`backup <backups>` first.
-It is possible to skip versions during updates, although we recommend not skipping over major version numbers
-(i.e. if you want to go from 2.4 to 4.4, first upgrade to 3.0, then upgrade to 4.0, then to 4.4).
-
-In addition to these standard update steps, the following list issues steps that should be taken when you upgrade
-to specific versions for pretix. If you're skipping versions, please read the instructions for every version in
-between as well.
-
-Upgrade to 3.17.0 or newer
-""""""""""""""""""""""""""
-
-pretix 3.17 introduces a dependency on ``nodejs``, so you should install it on your system::
-
-    # apt install nodejs npm
-
-Upgrade to 4.4.0 or newer
-"""""""""""""""""""""""""
-
-pretix 4.4 introduces a new data structure to store historical financial data. If you already have existing
-data in your database, you will need to back-fill this data or you might get incorrect reports! This is not
-done automatically as part of the usual update steps since it can take a while on large databases and you might
-want to do it in parallel while the system is already running again. Please execute the following command::
-
-    (venv)$ python -m pretix create_order_transactions
-
-Or, with a docker installation::
-
-    $ docker exec -it pretix.service pretix create_order_transactions
-
-
-.. _blog: https://pretix.eu/about/en/blog/

doc/api/deviceauth.rst

@@ -35,9 +35,13 @@ as well as the type of underlying hardware. Example:
        "os_name": "Android",
        "os_version": "2.3.6",
        "software_brand": "pretixdroid",
-       "software_version": "4.0.0"
+       "software_version": "4.0.0",
+       "rsa_pubkey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqh…nswIDAQAB\n-----END PUBLIC KEY-----\n"
    }
 
+The ``rsa_pubkey`` is optional any only required for certain features such as working with reusable
+media and NFC cryptography.
+
 Every initialization token can only be used once. On success, you will receive a response containing
 information on your device as well as your API token:
 
@@ -137,9 +141,29 @@ The response will look like this:
          "id": 3,
          "name": "South entrance"
        }
-     }
+     },
+     "server": {
+       "version": {
+         "pretix": "3.6.0.dev0",
+         "pretix_numeric": 30060001000
+       }
+     },
+     "medium_key_sets": [
+       {
+         "public_id": 3456349,
+         "organizer": "foo",
+         "active": true,
+         "media_type": "nfc_mf0aes",
+         "uid_key": "base64-encoded-encrypted-key",
+         "diversification_key": "base64-encoded-encrypted-key",
+       }
+     ]
    }
 
+``"medium_key_sets`` will always be empty if you did not set an ``rsa_pubkey``.
+The individual keys in the key sets are encrypted with the device's ``rsa_pubkey``
+using ``RSA/ECB/PKCS1Padding``.
+
 Creating a new API key
 ----------------------
 
@@ -184,20 +208,6 @@ Additionally, when creating a device through the user interface or API, a user c
 the device. These include an allow list of specific API calls that may be made by the device. pretix ships with security
 policies for official pretix apps like pretixSCAN and pretixPOS.
 
-Removing a device
------------------
-
-If you want implement a way to to deprovision a device in your software, you can call the ``revoke`` endpoint to
-invalidate your API key. There is no way to reverse this operation.
-
-.. sourcecode:: http
-
-   POST /api/v1/device/revoke HTTP/1.1
-   Host: pretix.eu
-   Authorization: Device 1kcsh572fonm3hawalrncam4l1gktr2rzx25a22l8g9hx108o9oi0rztpcvwnfnd
-
-This can also be done by the user through the web interface.
-
 Event selection
 ---------------
 
@@ -225,7 +235,10 @@ You can get three response codes:
    Content-Type: application/json
 
    {
-      "event": "democon",
+      "event": {
+        "name": "Demo Conference",
+        "slug": "democon"
+      },
       "subevent": 23,
       "checkinlist": 5
    }

doc/api/fundamentals.rst

@@ -117,7 +117,7 @@ List-level conditional fetching
 If modification checks are not possible with this granularity, you can instead check for the full list.
 In this case, the list of objects may contain a regular HTTP header ``Last-Modified`` with the date of the
 last modification to any item of that resource. You can then pass this date back in your next request in the
-``If-Modified-Since`` header. If the any object has changed in the meantime, you will receive back a full list
+``If-Modified-Since`` header. If any object has changed in the meantime, you will receive back a full list
 (if something it missing, this means the object has been deleted). If nothing happened, we'll send back a
 ``304 Not Modified`` return code.
 

doc/api/guides/custom_checkout.rst

@@ -94,7 +94,9 @@ If you want the user to return to your application after the payment is complete
 "Plugins". Enable the plugin "Redirection from order page". Then, go to the new page "Settings", then "Redirection".
 Enter the base URL of your web application. This will allow you to redirect to pages under this base URL later on.
 For example, if you want users to be redirected to ``https://example.org/order/return?tx_id=1234``, you could now
-either enter ``https://example.org`` or ``https://example.org/order/``.
+either enter ``https://example.org/order/`` or ``https://example.org/``.
+Please note that in the latter case the trailing slash is required, ``https://example.org`` is not allowed to prevent.
+Only base URLs with a secure (``https://``) or local (``http://localhost``) origin are permitted.
 
 The user will be redirected back to your page instead of pretix' order confirmation page after the payment,
 **regardless of whether it was successful or not**. We will append an ``error=…`` query parameter with an error

doc/api/resources/auto_checkin_rules.rst

@@ -0,0 +1,259 @@
+.. _rest-autocheckinrules:
+
+Auto check-in rules
+===================
+
+This feature requires the bundled ``pretix.plugins.autocheckin`` plugin to be active for the event in order to work properly.
+
+Resource description
+--------------------
+
+Auto check-in rules specify that tickets should under specific conditions automatically be considered checked in after
+they have been purchased.
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of the rule
+list                                  integer                    ID of the check-in list to check the ticket in on. If
+                                                                 ``None``, the system will select all matching check-in lists.
+mode                                  string                     ``"placed"`` if the rule should be evaluated right after
+                                                                 an order has been created, ``"paid"`` if the rule should
+                                                                 be evaluated after the order has been fully paid.
+all_sales_channels                    boolean                    If ``true`` (default), the rule applies to tickets sold on all sales channels.
+limit_sales_channels                  list of strings            List of sales channel identifiers the rule should apply to
+                                                                 if ``all_sales_channels`` is ``false``.
+all_products                          boolean                    If ``true`` (default), the rule affects all products and variations.
+limit_products                        list of integers           List of item IDs, if ``all_products`` is not set. If the
+                                                                 product listed here has variations, all variations will be matched.
+limit_variations                      list of integers           List of product variation IDs, if ``all_products`` is not set.
+                                                                 The parent product does not need to be part of ``limit_products``.
+all_payment_methods                   boolean                    If ``true`` (default), the rule applies to tickets paid with all payment methods.
+limit_payment_methods                 list of strings            List of payment method identifiers the rule should apply to
+                                                                 if ``all_payment_methods`` is ``false``.
+===================================== ========================== =======================================================
+
+.. versionadded:: 2024.7
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/auto_checkin_rules/
+
+   Returns a list of all rules configured for an event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/auto_checkin_rules/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "id": 1,
+            "list": 12345,
+            "mode": "placed",
+            "all_sales_channels": false,
+            "limit_sales_channels": ["web"],
+            "all_products": false,
+            "limit_products": [2, 3],
+            "limit_variations": [456],
+            "all_payment_methods": true,
+            "limit_payment_methods": []
+          }
+        ]
+      }
+
+   :query page: The page number in case of a multi-page result set, default is 1
+   :param organizer: The ``slug`` field of a valid organizer
+   :param event: The ``slug`` field of the event to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view it.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/auto_checkin_rules/(id)/
+
+   Returns information on one rule, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/auto_checkin_rules/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "list": 12345,
+        "mode": "placed",
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
+        "all_products": false,
+        "limit_products": [2, 3],
+        "limit_variations": [456],
+        "all_payment_methods": true,
+        "limit_payment_methods": []
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param id: The ``id`` field of the rule to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/rule does not exist **or** you have no permission to view it.
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/auto_checkin_rules/
+
+   Create a new rule.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/auto_checkin_rules/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 166
+
+      {
+        "list": 12345,
+        "mode": "placed",
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
+        "all_products": false,
+        "limit_products": [2, 3],
+        "limit_variations": [456],
+        "all_payment_methods": true,
+        "limit_payment_methods": []
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "list": 12345,
+        "mode": "placed",
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
+        "all_products": false,
+        "limit_products": [2, 3],
+        "limit_variations": [456],
+        "all_payment_methods": true,
+        "limit_payment_methods": []
+      }
+
+   :param organizer: The ``slug`` field of the organizer to create a rule for
+   :param event: The ``slug`` field of the event to create a rule for
+   :statuscode 201: no error
+   :statuscode 400: The rule could not be created due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to create rules.
+
+
+.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/auto_checkin_rules/(id)/
+
+   Update a rule. You can also use ``PUT`` instead of ``PATCH``. With ``PUT``, you have to provide all fields of
+   the resource, other fields will be reset to default. With ``PATCH``, you only need to provide the fields that you
+   want to change.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/events/sampleconf/auto_checkin_rules/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 34
+
+      {
+        "mode": "paid",
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: text/javascript
+
+      {
+        "id": 1,
+        "list": 12345,
+        "mode": "placed",
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
+        "all_products": false,
+        "limit_products": [2, 3],
+        "limit_variations": [456],
+        "all_payment_methods": true,
+        "limit_payment_methods": []
+      }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param event: The ``slug`` field of the event to modify
+   :param id: The ``id`` field of the rule to modify
+   :statuscode 200: no error
+   :statuscode 400: The rule could not be modified due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/rule does not exist **or** you have no permission to change it.
+
+
+.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/auto_checkin_rules/(id)/
+
+   Delete a rule.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/auto_checkin_rules/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 204 No Content
+      Vary: Accept
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param event: The ``slug`` field of the event to modify
+   :param id: The ``id`` field of the rule to delete
+   :statuscode 204: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/rule does not exist **or** you have no permission to change it **or** this rule cannot be deleted since it is currently in use.

doc/api/resources/badges.rst

@@ -1,7 +1,7 @@
 Badges
 ======
 
-The badges plugin provides a HTTP API that exposes the various layouts used to generate PDF badges.
+The built-in badges plugin provides a HTTP API that exposes the various layouts used to generate PDF badges.
 
 Resource description
 --------------------

doc/api/resources/banktransfer.rst

@@ -1,7 +1,7 @@
-Bank transfer HTTP API
-======================
+Bank transfer
+=============
 
-The banktransfer plugin provides a HTTP API that `pretix-banktool`_ uses to send bank
+The built-in banktransfer plugin provides a HTTP API that `pretix-banktool`_ uses to send bank
 transactions to the pretix server. This API is integrated with the regular :ref:`rest-api`
 and therefore follows the conventions listed there.
 
@@ -32,6 +32,7 @@ transactions                          list of objects            Transactions in
 ├ checksum                            string                     Checksum computed from payer, reference, amount and
                                                                  date
 ├ payer                               string                     Payment source
+├ external_id                         string                     Unique ID of the payment from an external source
 ├ reference                           string                     Payment reference
 ├ amount                              string                     Payment amount
 ├ iban                                string                     Payment IBAN
@@ -85,6 +86,7 @@ Endpoints
                 "date": "26.06.2017",
                 "payer": "John Doe",
                 "order": null,
+                "external_id": null,
                 "iban": "",
                 "bic": "",
                 "checksum": "5de03a601644dfa63420dacfd285565f8375a8f2",
@@ -139,6 +141,7 @@ Endpoints
             "iban": "",
             "bic": "",
             "order": null,
+            "external_id": null,
             "checksum": "5de03a601644dfa63420dacfd285565f8375a8f2",
             "reference": "GUTSCHRIFT\r\nSAMPLECONF-NAB12 EREF: SAMPLECONF-NAB12\r\nIBAN: DE1234556…",
             "state": "nomatch",

doc/api/resources/campaigns.rst

@@ -1,6 +1,8 @@
 Campaigns
 =========
 
+.. note:: This API is only available when the plugin **pretix-campaigns** is installed (pretix Hosted and Enterprise only).
+
 The campaigns plugin provides a HTTP API that allows you to create new campaigns.
 
 Resource description

doc/api/resources/carts.rst

@@ -40,14 +40,14 @@ answers                               list of objects            Answers to user
 seat                                  objects                    The assigned seat (or ``null``)
 ├ id                                  integer                    Internal ID of the seat instance
 ├ name                                string                     Human-readable seat name
+├ zone_name                           string                     Name of the zone the seat is in
+├ row_name                            string                     Name/number of the row the seat is in
+├ row_label                           string                     Additional label of the row (or ``null``)
+├ seat_number                         string                     Number of the seat within the row
+├ seat_label                          string                     Additional label of the seat (or ``null``)
 └ seat_guid                           string                     Identifier of the seat within the seating plan
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.14
-
-   This ``is_bundled`` attribute has been added and the cart creation endpoints have been updated.
-
-
 Cart position endpoints
 -----------------------
 

doc/api/resources/categories.rst

@@ -23,6 +23,22 @@ position                              integer                    An integer, use
 is_addon                              boolean                    If ``true``, items within this category are not on sale
                                                                  on their own but the category provides a source for
                                                                  defining add-ons for other products.
+cross_selling_mode                    string                     If ``null``, cross-selling is disabled for this category.
+                                                                 If ``"only"``, it is only visible in the cross-selling
+                                                                 step.
+                                                                 If ``"both"``, it is visible on the normal index page
+                                                                 as well.
+                                                                 Only available if ``is_addon`` is ``false``.
+cross_selling_condition               string                     Only relevant if ``cross_selling_mode`` is not ``null``.
+                                                                 If ``"always"``, always show in cross-selling step.
+                                                                 If ``"products"``, only show if the cart contains one of
+                                                                 the products listed in ``cross_selling_match_products``.
+                                                                 If ``"discounts"``, only show products that qualify for
+                                                                 a discount according to discount rules.
+cross_selling_match_products          list of integer            Only relevant if ``cross_selling_condition`` is
+                                                                 ``"products"``. Internal ID of the items of which at
+                                                                 least one needs to be in the cart for this category to
+                                                                 be shown.
 ===================================== ========================== =======================================================
 
 
@@ -60,7 +76,10 @@ Endpoints
             "internal_name": "",
             "description": {"en": "Tickets are what you need to get in."},
             "position": 1,
-            "is_addon": false
+            "is_addon": false,
+            "cross_selling_mode": null,
+            "cross_selling_condition": null,
+            "cross_selling_match_products": []
           }
         ]
       }
@@ -102,7 +121,10 @@ Endpoints
         "internal_name": "",
         "description": {"en": "Tickets are what you need to get in."},
         "position": 1,
-        "is_addon": false
+        "is_addon": false,
+        "cross_selling_mode": null,
+        "cross_selling_condition": null,
+        "cross_selling_match_products": []
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -130,7 +152,10 @@ Endpoints
         "internal_name": "",
         "description": {"en": "Tickets are what you need to get in."},
         "position": 1,
-        "is_addon": false
+        "is_addon": false,
+        "cross_selling_mode": null,
+        "cross_selling_condition": null,
+        "cross_selling_match_products": []
       }
 
    **Example response**:
@@ -147,7 +172,10 @@ Endpoints
         "internal_name": "",
         "description": {"en": "Tickets are what you need to get in."},
         "position": 1,
-        "is_addon": false
+        "is_addon": false,
+        "cross_selling_mode": null,
+        "cross_selling_condition": null,
+        "cross_selling_match_products": []
       }
 
    :param organizer: The ``slug`` field of the organizer of the event to create a category for
@@ -193,7 +221,10 @@ Endpoints
         "internal_name": "",
         "description": {"en": "Tickets are what you need to get in."},
         "position": 1,
-        "is_addon": true
+        "is_addon": true,
+        "cross_selling_mode": null,
+        "cross_selling_condition": null,
+        "cross_selling_match_products": []
       }
 
    :param organizer: The ``slug`` field of the organizer to modify

doc/api/resources/certificates.rst

@@ -1,6 +1,8 @@
 Certificates of attendance
 ==========================
 
+.. note:: This API is only available when the plugin **pretix-certificates** is installed (pretix Hosted and Enterprise only).
+
 The certificates plugin provides a HTTP API that allows you to download the certificate for a specific attendee.
 
 
@@ -21,7 +23,7 @@ Certificate download
 
    .. sourcecode:: http
 
-      GET /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/certificate/ HTTP/1.1
+      GET /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/certificate/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
 
@@ -36,7 +38,7 @@ Certificate download
 
    .. sourcecode:: http
 
-      GET /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/certificate/?result=1f550651-ae7b-4911-a76c-2be8f348aaa5 HTTP/1.1
+      GET /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/certificate/?result=1f550651-ae7b-4911-a76c-2be8f348aaa5 HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
 

doc/api/resources/checkin.rst

@@ -9,14 +9,6 @@ This page describes special APIs built for ticket scanning apps. For managing ch
 please also see :ref:`rest-checkinlists`. The check-in list API also contains endpoints to obtain statistics or log
 failed scans.
 
-.. versionchanged:: 4.12
-
-    The endpoints listed on this page have been added.
-
-.. versionchanged:: 4.18
-
-    The ``source_type`` parameter has been added.
-
 .. _`rest-checkin-redeem`:
 
 Checking a ticket in
@@ -31,6 +23,7 @@ Checking a ticket in
    This endpoint supports passing multiple check-in lists to perform a multi-event scan. However, each check-in list
    passed needs to be from a distinct event.
 
+   :query string expand: Expand a field inside the ``position`` object into a full object. Currently ``subevent``, ``item``, ``variation``, and ``answers.question`` are supported. Can be passed multiple times.
    :<json string secret: Scanned QR code corresponding to the ``secret`` attribute of a ticket.
    :<json string source_type: Type of source the ``secret`` was obtained form. Defaults to ``"barcode"``.
    :<json array lists: List of check-in list IDs to search on. No two check-in lists may be from the same event.
@@ -53,6 +46,11 @@ Checking a ticket in
                         this request twice with the same nonce, the second request will also succeed but will always
                         create only one check-in object even when the previous request was successful as well. This
                         allows for a certain level of idempotency and enables you to re-try after a connection failure.
+   :<json boolean use_order_locale: Specifies that pretix should use the customer's language (``locale`` field from the
+                                    order) when building texts (currently only the ``reason_explanation`` response field).
+                                    Defaults to ``false`` in which case the server will determine the language (currently
+                                    the event default language, might change in the future with support for the
+                                    ``Accept-Language`` header).
    :>json string status: ``"ok"``, ``"incomplete"``, or ``"error"``
    :>json string reason: Reason code, only set on status ``"error"``, see below for possible values.
    :>json string reason_explanation: Human-readable explanation, only set on status ``"error"`` and reason ``"rules"``, can be null.
@@ -61,8 +59,11 @@ Checking a ticket in
                            will only include check-ins for the selected list. (2) An additional boolean property
                            ``require_attention`` will inform you whether either the order or the item have the
                            ``checkin_attention`` flag set. (3) If ``attendee_name`` is empty, it may automatically fall
-                           back to values from a parent product or from invoice addresses.
+                           back to values from a parent product or from invoice addresses. (4) Additional properties
+                           ``order__status``, ``order__valid_if_pending``, ``order__require_approval``, and
+                           ``order__locale`` are included with details form the order for convenience.
    :>json boolean require_attention: Whether or not the ``require_attention`` flag is set on the item or order.
+   :>json list checkin_texts: List of additional texts to show to the user.
    :>json object list: Excerpt of information about the matching :ref:`check-in list <rest-checkinlists>` (if any was found),
                        including the attributes ``id``, ``name``, ``event``, ``subevent``, and ``include_pending``.
    :>json object questions: List of questions to be answered for check-in, only set on status ``"incomplete"``.
@@ -103,6 +104,7 @@ Checking a ticket in
           …
         },
         "require_attention": false,
+        "checkin_texts": [],
         "list": {
           "id": 1,
           "name": "Default check-in list",
@@ -125,6 +127,7 @@ Checking a ticket in
           …
         },
         "require_attention": false,
+        "checkin_texts": [],
         "list": {
           "id": 1,
           "name": "Default check-in list",
@@ -142,6 +145,7 @@ Checking a ticket in
             "position": 1,
             "identifier": "WY3TP9SL",
             "ask_during_checkin": true,
+            "show_during_checkin": true,
             "options": [
               {
                 "id": 1,
@@ -178,7 +182,8 @@ Checking a ticket in
         "status": "error",
         "reason": "invalid",
         "reason_explanation": null,
-        "require_attention": false
+        "require_attention": false,
+        "checkin_texts": []
       }
 
    **Example error response (known, but invalid ticket)**:
@@ -193,6 +198,7 @@ Checking a ticket in
         "reason": "unpaid",
         "reason_explanation": null,
         "require_attention": false,
+        "checkin_texts": [],
         "list": {
           "id": 1,
           "name": "Default check-in list",
@@ -217,6 +223,7 @@ Checking a ticket in
    * ``rules`` - Check-in prevented by a user-defined rule.
    * ``ambiguous`` - Multiple tickets match scan, rejected.
    * ``revoked`` - Ticket code has been revoked.
+   * ``unapproved`` - Order has not yet been approved.
    * ``error`` - Internal error.
 
    In case of reason ``rules`` and ``invalid_time``, there might be an additional response field ``reason_explanation``
@@ -352,3 +359,156 @@ Performing a ticket search
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer or check-in list does not exist **or** you have no permission to view this resource.
    :statuscode 404: The requested check-in list does not exist.
+
+.. _`rest-checkin-annul`:
+
+Annulment of a check-in
+-----------------------
+
+.. http:post:: /api/v1/organizers/(organizer)/checkinrpc/annul/
+
+   If a check-in was made in error and the person was not let in, it can be annulled. We do not recommend this to be used
+   in case of manual check-ins or user interfaces because it is too prone for human errors. It is mostly intended for
+   automated entry systems like a turnstile or automated door, where the check-in is first created, then the door is
+   opened, and then the check-in may be annulled if the system knows that the turnstile did not turn or was out of
+   order.
+
+   This endpoint supports passing multiple check-in lists for the context of a multi-event scan. However, each
+   check-in list passed needs to be from a distinct event.
+
+   Check-ins created by a device can only be annulled by the same device. The datetime of annulment may not be more than
+   15 minutes after the datetime of check-in (value subject to change).
+
+   A status code of 404 is returned if no check-in was found for the given nonce. A status code of 400 is returned when
+   multiple check-ins match the nonce, the input is invalid in another way, the annulment is made from the wrong device,
+   the check-in is already in an annulled or failed state, or the datetime constraint is not valid.
+
+   :<json string nonce: ``nonce`` value of the original check-in.
+   :<json array lists: List of check-in list IDs to search on. No two check-in lists may be from the same event.
+   :<json datetime datetime: Specifies the client-side datetime of the annulment. If not supplied, the current time will be used.
+   :<json string error_explanation: A human-readable description of why the check-in was annulled (optional).
+   :>json string status: ``"ok"``
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/checkinrpc/annul/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+      {
+        "lists": [1],
+        "nonce": "Pvrk50vUzQd0DhdpNRL4I4OcXsvg70uA",
+        "error_explanation": "Turnstile did not turn"
+      }
+
+   **Example successful response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "status": "ok",
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :statuscode 200: no error
+   :statuscode 400: Invalid or incomplete request, see above
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+   :statuscode 404: The requested nonce does not exist.
+
+
+Check-in history
+----------------
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of the check-in
+successful                            boolean                    Whether the check-in was successful
+error_reason                          string                     Category of reason why the check-in was unsuccessful. Currently
+                                                                 ``"canceled"``, ``"invalid"``, ``"unpaid"`` ``"product"``,
+                                                                 ``"rules"``, ``"revoked"``, ``"incomplete"``, ``"already_redeemed"``,
+                                                                 ``"ambiguous"``, ``"error"``, ``"blocked"``, ``"unapproved"``,
+                                                                 ``"invalid_time"``, ``"annulled"`` or ``null``
+error_explanation                     string                     Additional, human-readable reason for the check-in to be unsuccessful (or ``null``)
+position                              integer                    Internal ID of the order position (or ``null`` for unknown scans)
+datetime                              datetime                   Logical time when the check-in happened
+created                               datetime                   Time when the check-in appeared on the server
+list                                  integer                    Internal ID of the check-in list
+auto_checked_in                       boolean                    Whether the check-in was performed by the system automatically
+gate                                  integer                    Internal ID of the gate (or ``null``)
+device                                integer                    Internal ID of the device (or ``null``)
+device_id                             integer                    Organizer-internal ID of the device (or ``null``)
+type                                  string                     Type of check-in, currently ``"entry"`` or ``"exit"``
+===================================== ========================== =======================================================
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/checkins/
+
+   Returns a list of all check-in events within a given event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/checkins/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "id": 1,
+            "successful": true,
+            "error_reason": null,
+            "error_explanation": null,
+            "position": 1234,
+            "datetime": "2017-12-25T12:45:23Z",
+            "created": "2017-12-25T12:45:23Z",
+            "list": 2,
+            "auto_checked_in": false,
+            "gate": null,
+            "device": null,
+            "device_id": null,
+            "type": "entry",
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :query datetime created_since: Only return check-ins that have been created since the given date (inclusive).
+   :query datetime created_before: Only return check-ins that have been created before the given date (exclusive).
+   :query datetime datetime_since: Only return check-ins that have happened since the given date (inclusive).
+   :query datetime datetime_before: Only return check-ins that have happened before the given date (exclusive).
+   :query boolean successful: Only return check-ins that have (not) been successful.
+   :query boolean error_reason: Only return check-ins with a specific error reason.
+   :query integer list: Only return check-ins from a specific list.
+   :query string type: Only return check-ins of a specific type.
+   :query integer gate: Only return check-ins from a specific gate.
+   :query integer device: Only return check-ins from a specific device.
+   :query boolean auto_checked_in: Only return check-ins that are (not) auto-checked in.
+   :query string ordering: Manually set the ordering of results. Valid fields to be used are ``datetime``, ``created``,
+                           and ``id``.
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.

doc/api/resources/checkinlists.rst

@@ -31,17 +31,18 @@ subevent                              integer                    ID of the date
 position_count                        integer                    Number of tickets that match this list (read-only).
 checkin_count                         integer                    Number of check-ins performed on this list (read-only).
 include_pending                       boolean                    If ``true``, the check-in list also contains tickets from orders in pending state.
-auto_checkin_sales_channels           list of strings            All items on the check-in list will be automatically marked as checked-in when purchased through any of the listed sales channels.
 allow_multiple_entries                boolean                    If ``true``, subsequent scans of a ticket on this list should not show a warning but instead be stored as an additional check-in.
 allow_entry_after_exit                boolean                    If ``true``, subsequent scans of a ticket on this list are valid if the last scan of the ticket was an exit scan.
 rules                                 object                     Custom check-in logic. The contents of this field are currently not considered a stable API and modifications through the API are highly discouraged.
 exit_all_at                           datetime                   Automatically check out (i.e. perform an exit scan) at this point in time. After this happened, this property will automatically be set exactly one day into the future. Note that this field is considered "internal configuration" and if you pull the list with ``If-Modified-Since``, the daily change in this field will not trigger a response.
 addon_match                           boolean                    If ``true``, tickets on this list can be redeemed by scanning their parent ticket if this still leads to an unambiguous match.
+ignore_in_statistics                  boolean                    If ``true``, check-ins on this list will be ignored in most reporting features.
+consider_tickets_used                 boolean                    If ``true`` (default), tickets checked in on this list will be considered "used" by other functionality, i.e. when checking if they can still be canceled.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.12
+.. versionchanged:: 2023.9
 
-    The ``addon_match`` attribute has been added.
+    The ``ignore_in_statistics`` and ``consider_tickets_used`` attributes have been added.
 
 Endpoints
 ---------
@@ -84,10 +85,7 @@ Endpoints
             "allow_entry_after_exit": true,
             "exit_all_at": null,
             "rules": {},
-            "addon_match": false,
-            "auto_checkin_sales_channels": [
-              "pretixpos"
-            ]
+            "addon_match": false
           }
         ]
       }
@@ -139,10 +137,7 @@ Endpoints
         "allow_entry_after_exit": true,
         "exit_all_at": null,
         "rules": {},
-        "addon_match": false,
-        "auto_checkin_sales_channels": [
-          "pretixpos"
-        ]
+        "addon_match": false
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -239,10 +234,7 @@ Endpoints
         "subevent": null,
         "allow_multiple_entries": false,
         "allow_entry_after_exit": true,
-        "addon_match": false,
-        "auto_checkin_sales_channels": [
-          "pretixpos"
-        ]
+        "addon_match": false
       }
 
    **Example response**:
@@ -264,10 +256,7 @@ Endpoints
         "subevent": null,
         "allow_multiple_entries": false,
         "allow_entry_after_exit": true,
-        "addon_match": false,
-        "auto_checkin_sales_channels": [
-          "pretixpos"
-        ]
+        "addon_match": false
       }
 
    :param organizer: The ``slug`` field of the organizer of the event/item to create a list for
@@ -319,10 +308,7 @@ Endpoints
         "subevent": null,
         "allow_multiple_entries": false,
         "allow_entry_after_exit": true,
-        "addon_match": false,
-        "auto_checkin_sales_channels": [
-          "pretixpos"
-        ]
+        "addon_match": false
       }
 
    :param organizer: The ``slug`` field of the organizer to modify
@@ -335,7 +321,7 @@ Endpoints
 
 .. http:delete:: /api/v1/organizers/(organizer)/events/(event)/checkinlist/(id)/
 
-   Delete a check-in list. Note that this also deletes the information on all check-ins performed via this list.
+   Delete a check-in list. **Note that this also deletes the information on all check-ins performed via this list.**
 
    **Example request**:
 
@@ -492,7 +478,7 @@ Order position endpoints
                            ``attendee_name,positionid``
    :query string order: Only return positions of the order with the given order code
    :query string search: Fuzzy search matching the attendee name, order code, invoice address name as well as to the beginning of the secret.
-   :query string expand: Expand a field into a full object. Currently only ``subevent``, ``item``, and ``variation`` are supported. Can be passed multiple times.
+   :query string expand: Expand a field into a full object. Currently ``subevent``, ``item``, ``variation``, and ``answers.question`` are supported. Can be passed multiple times.
    :query integer item: Only return positions with the purchased item matching the given ID.
    :query integer item__in: Only return positions with the purchased item matching one of the given comma-separated IDs.
    :query integer variation: Only return positions with the purchased item variation matching the given ID.
@@ -626,7 +612,8 @@ Order position endpoints
                                        set this to ``false``. In that case, questions will just be ignored. Defaults
                                        to ``true``.
    :<json boolean canceled_supported: When this parameter is set to ``true``, the response code ``canceled`` may be
-                                      returned. Otherwise, canceled orders will return ``unpaid``.
+                                      returned. Otherwise, canceled orders will return ``unpaid``. (**Deprecated**, in
+                                      the future, this will be ignored and ``canceled`` may always be returned.)
    :<json datetime datetime: Specifies the datetime of the check-in. If not supplied, the current time will be used.
    :<json boolean force: Specifies that the check-in should succeed regardless of revoked barcode, previous check-ins or required
                          questions that have not been filled. This is usually used to upload offline scans that already happened,
@@ -700,6 +687,7 @@ Order position endpoints
             "position": 1,
             "identifier": "WY3TP9SL",
             "ask_during_checkin": true,
+            "show_during_checkin": true,
             "options": [
               {
                 "id": 1,
@@ -752,6 +740,7 @@ Order position endpoints
    * ``rules`` - Check-in prevented by a user-defined rule.
    * ``ambiguous`` - Multiple tickets match scan, rejected.
    * ``revoked`` - Ticket code has been revoked.
+   * ``unapproved`` - Order has not yet been approved.
 
    In case of reason ``rules`` or ``invalid_time``, there might be an additional response field ``reason_explanation``
    with a human-readable description of the violated rules. However, that field can also be missing or be ``null``.
@@ -767,4 +756,4 @@ Order position endpoints
    :statuscode 404: The requested order position or check-in list does not exist.
 
 
-.. _security issues: https://pretix.eu/about/de/blog/20220705-release-4111/
+.. _security issues: https://pretix.eu/about/de/blog/20220705-release-4111/

doc/api/resources/customers.rst

@@ -19,6 +19,7 @@ external_identifier                   string                     External ID of
                                                                  the API, but is read-only for customers created through a
                                                                  SSO integration.
 email                                 string                     Customer email address
+phone                                 string                     Customer phone number
 name                                  string                     Name of this customer (or ``null``)
 name_parts                            object of strings          Decomposition of name (i.e. given name, family name)
 is_active                             boolean                    Whether this account is active
@@ -33,11 +34,9 @@ password                              string                     Can only be set
                                                                  not be included in any responses.
 ===================================== ========================== =======================================================
 
-.. versionadded:: 4.0
+.. versionchanged:: 2024.3
 
-.. versionchanged:: 4.3
-
-   Passwords can now be set through the API during customer creation.
+   The attribute ``phone`` has been added.
 
 Endpoints
 ---------
@@ -71,6 +70,7 @@ Endpoints
             "identifier": "8WSAJCJ",
             "external_identifier": null,
             "email": "customer@example.org",
+            "phone": "+493012345678",
             "name": "John Doe",
             "name_parts": {
                 "_scheme": "full",
@@ -118,6 +118,7 @@ Endpoints
         "identifier": "8WSAJCJ",
         "external_identifier": null,
         "email": "customer@example.org",
+        "phone": "+493012345678",
         "name": "John Doe",
         "name_parts": {
             "_scheme": "full",
@@ -155,6 +156,7 @@ Endpoints
 
       {
         "email": "test@example.org",
+        "phone": "+493012345678",
         "password": "verysecret",
         "send_email": true
       }
@@ -171,6 +173,7 @@ Endpoints
         "identifier": "8WSAJCJ",
         "external_identifier": null,
         "email": "test@example.org",
+        "phone": "+493012345678",
         ...
       }
 
@@ -215,6 +218,7 @@ Endpoints
         "identifier": "8WSAJCJ",
         "external_identifier": null,
         "email": "test@example.org",
+        "phone": "+493012345678",
         …
       }
 
@@ -249,6 +253,7 @@ Endpoints
         "identifier": "8WSAJCJ",
         "external_identifier": null,
         "email": null,
+        "phone": null,
         …
       }
 

doc/api/resources/digital.rst

@@ -1,6 +1,8 @@
 Digital content
 ===============
 
+.. note:: This API is only available when the plugin **pretix-digital** is installed (pretix Hosted and Enterprise only).
+
 URL interpolation and JWT authentication
 ----------------------------------------
 

doc/api/resources/discounts.rst

@@ -20,8 +20,12 @@ id                                       integer                    Internal ID
 active                                   boolean                    The discount will be ignored if this is ``false``
 internal_name                            string                     A name for the rule used in the backend
 position                                 integer                    An integer, used for sorting the rules which are applied in order
-sales_channels                           list of strings            Sales channels this discount is available on, such as
-                                                                    ``"web"`` or ``"resellers"``. Defaults to ``["web"]``.
+all_sales_channels                       boolean                    If ``true`` (default), the discount is available on all sales channels
+                                                                    that support discounts.
+limit_sales_channels                     list of strings            List of sales channel identifiers the discount is available on
+                                                                    if ``all_sales_channels`` is ``false``.
+sales_channels                           list of strings            **DEPRECATED.** Legacy interface, use ``all_sales_channels``
+                                                                    and ``limit_sales_channels`` instead.
 available_from                           datetime                   The first date time at which this discount can be applied
                                                                     (or ``null``).
 available_until                          datetime                   The last date time at which this discount can be applied
@@ -31,9 +35,13 @@ subevent_mode                            strings                    Determines h
                                                                     ``"same"`` (discount is only applied for groups within
                                                                     the same date), or ``"distinct"`` (discount is only applied
                                                                     for groups with no two same dates).
-condition_all_products                   boolean                    If ``true``, the discount applies to all items.
+subevent_date_from                       datetime                   The first date time of a subevent to which this discount can be applied
+                                                                    (or ``null``). Ignored in non-series events.
+subevent_date_until                      datetime                   The last date time of a subevent to which this discount can be applied
+                                                                    (or ``null``). Ignored in non-series events.
+condition_all_products                   boolean                    If ``true``, the discount condition applies to all items.
 condition_limit_products                 list of integers           If ``condition_all_products`` is not set, this is a list
-                                                                    of internal item IDs that the discount applies to.
+                                                                    of internal item IDs that the discount condition applies to.
 condition_apply_to_addons                boolean                    If ``true``, the discount applies to add-on products as well,
                                                                     otherwise it only applies to top-level items. The discount never
                                                                     applies to bundled products.
@@ -48,6 +56,17 @@ benefit_discount_matching_percent        decimal (string)           The percenta
 benefit_only_apply_to_cheapest_n_matches integer                    If set higher than 0, the discount will only be applied to
                                                                     the cheapest matches. Useful for a "3 for 2"-style discount.
                                                                     Cannot be combined with ``condition_min_value``.
+benefit_same_products                    boolean                    If ``true``, the discount benefit applies to the same set of items
+                                                                    as the condition (see above).
+benefit_limit_products                   list of integers           If ``benefit_same_products`` is not set, this is a list
+                                                                    of internal item IDs that the discount benefit applies to.
+benefit_apply_to_addons                  boolean                    (Only used if ``benefit_same_products`` is ``false``.)
+                                                                    If ``true``, the discount applies to add-on products as well,
+                                                                    otherwise it only applies to top-level items. The discount never
+                                                                    applies to bundled products.
+benefit_ignore_voucher_discounted        boolean                    (Only used if ``benefit_same_products`` is ``false``.)
+                                                                    If ``true``, the discount does not apply to products which have
+                                                                    been discounted by a voucher.
 ======================================== ========================== =======================================================
 
 
@@ -84,16 +103,24 @@ Endpoints
             "active": true,
             "internal_name": "3 for 2",
             "position": 1,
+            "all_sales_channels": false,
+            "limit_sales_channels": ["web"],
             "sales_channels": ["web"],
             "available_from": null,
             "available_until": null,
             "subevent_mode": "mixed",
+            "subevent_date_from": null,
+            "subevent_date_until": null,
             "condition_all_products": true,
             "condition_limit_products": [],
             "condition_apply_to_addons": true,
             "condition_ignore_voucher_discounted": false,
             "condition_min_count": 3,
             "condition_min_value": "0.00",
+            "benefit_same_products": true,
+            "benefit_limit_products": [],
+            "benefit_apply_to_addons": true,
+            "benefit_ignore_voucher_discounted": false,
             "benefit_discount_matching_percent": "100.00",
             "benefit_only_apply_to_cheapest_n_matches": 1
           }
@@ -136,16 +163,24 @@ Endpoints
         "active": true,
         "internal_name": "3 for 2",
         "position": 1,
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "available_from": null,
         "available_until": null,
         "subevent_mode": "mixed",
+        "subevent_date_from": null,
+        "subevent_date_until": null,
         "condition_all_products": true,
         "condition_limit_products": [],
         "condition_apply_to_addons": true,
         "condition_ignore_voucher_discounted": false,
         "condition_min_count": 3,
         "condition_min_value": "0.00",
+        "benefit_same_products": true,
+        "benefit_limit_products": [],
+        "benefit_apply_to_addons": true,
+        "benefit_ignore_voucher_discounted": false,
         "benefit_discount_matching_percent": "100.00",
         "benefit_only_apply_to_cheapest_n_matches": 1
       }
@@ -174,16 +209,24 @@ Endpoints
         "active": true,
         "internal_name": "3 for 2",
         "position": 1,
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "available_from": null,
         "available_until": null,
         "subevent_mode": "mixed",
+        "subevent_date_from": null,
+        "subevent_date_until": null,
         "condition_all_products": true,
         "condition_limit_products": [],
         "condition_apply_to_addons": true,
         "condition_ignore_voucher_discounted": false,
         "condition_min_count": 3,
         "condition_min_value": "0.00",
+        "benefit_same_products": true,
+        "benefit_limit_products": [],
+        "benefit_apply_to_addons": true,
+        "benefit_ignore_voucher_discounted": false,
         "benefit_discount_matching_percent": "100.00",
         "benefit_only_apply_to_cheapest_n_matches": 1
       }
@@ -201,16 +244,24 @@ Endpoints
         "active": true,
         "internal_name": "3 for 2",
         "position": 1,
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "available_from": null,
         "available_until": null,
         "subevent_mode": "mixed",
+        "subevent_date_from": null,
+        "subevent_date_until": null,
         "condition_all_products": true,
         "condition_limit_products": [],
         "condition_apply_to_addons": true,
         "condition_ignore_voucher_discounted": false,
         "condition_min_count": 3,
         "condition_min_value": "0.00",
+        "benefit_same_products": true,
+        "benefit_limit_products": [],
+        "benefit_apply_to_addons": true,
+        "benefit_ignore_voucher_discounted": false,
         "benefit_discount_matching_percent": "100.00",
         "benefit_only_apply_to_cheapest_n_matches": 1
       }
@@ -257,16 +308,24 @@ Endpoints
         "active": false,
         "internal_name": "3 for 2",
         "position": 1,
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "available_from": null,
         "available_until": null,
         "subevent_mode": "mixed",
+        "subevent_date_from": null,
+        "subevent_date_until": null,
         "condition_all_products": true,
         "condition_limit_products": [],
         "condition_apply_to_addons": true,
         "condition_ignore_voucher_discounted": false,
         "condition_min_count": 3,
         "condition_min_value": "0.00",
+        "benefit_same_products": true,
+        "benefit_limit_products": [],
+        "benefit_apply_to_addons": true,
+        "benefit_ignore_voucher_discounted": false,
         "benefit_discount_matching_percent": "100.00",
         "benefit_only_apply_to_cheapest_n_matches": 1
       }

doc/api/resources/events.rst

@@ -36,6 +36,8 @@ geo_lon                               float                      Longitude of th
 has_subevents                         boolean                    ``true`` if the event series feature is active for this
                                                                  event. Cannot change after event is created.
 meta_data                             object                     Values set for organizer-specific meta data parameters.
+                                                                 The allowed keys need to be set up as meta properties
+                                                                 in the organizer configuration.
 plugins                               list                       A list of package names of the enabled plugins for this
                                                                  event.
 seating_plan                          integer                    If reserved seating is in use, the ID of a seating
@@ -47,8 +49,11 @@ item_meta_properties                  object                     Item-specific m
 valid_keys                            object                     Cryptographic keys for non-default signature schemes.
                                                                  For performance reason, value is omitted in lists and
                                                                  only contained in detail views. Value can be cached.
-sales_channels                        list                       A list of sales channels this event is available for
-                                                                 sale on.
+all_sales_channels                    boolean                    If ``true`` (default), the event is available on all sales channels.
+limit_sales_channels                  list of strings            List of sales channel identifiers the event is available on
+                                                                 if ``all_sales_channels`` is ``false``.
+sales_channels                        list of strings            **DEPRECATED.** Legacy interface, use ``all_sales_channels``
+                                                                 and ``limit_sales_channels`` instead.
 public_url                            string                     The public, customer-facing URL of the event (read-only).
 ===================================== ========================== =======================================================
 
@@ -56,25 +61,6 @@ public_url                            string                     The public, cus
 Endpoints
 ---------
 
-.. versionchanged:: 4.0
-
-    The ``clone_from`` parameter has been added to the event creation endpoint.
-
-.. versionchanged:: 4.1
-
-    The ``with_availability_for`` parameter has been added.
-
-    The ``search`` query parameter has been added to filter events by their slug, name, or location in any language.
-
-.. versionchanged:: 4.17
-
-    The ``public_url`` field has been added.
-
-.. versionchanged:: 5.0
-
-    The ``date_from_before``, ``date_from_after``, ``date_to_before``, and ``date_to_after`` query parameters have been
-    added.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/
 
    Returns a list of all events within a given organizer the authenticated user/token has access to.
@@ -129,11 +115,13 @@ Endpoints
               "pretix.plugins.paypal",
               "pretix.plugins.ticketoutputpdf"
             ],
-            "sales_channels": [
+            "all_sales_channels": false,
+            "limit_sales_channels": [
               "web",
               "pretixpos",
               "resellers"
             ],
+            "sales_channels": [],
             "public_url": "https://pretix.eu/bigevents/sampleconf/"
           }
         ]
@@ -223,6 +211,8 @@ Endpoints
             "LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUNvd0JRWURLMlZ3QXlFQTdBRDcvdkZBMzNFc1k0ejJQSHI3aVpQc1o4bjVkaDBhalA4Z3l6Tm1tSXM9Ci0tLS0tRU5EIFBVQkxJQyBLRVktLS0tLQo="
           ]
         },
+        "all_sales_channels": true,
+        "limit_sales_channels": [],
         "sales_channels": [
           "web",
           "pretixpos",
@@ -280,11 +270,8 @@ Endpoints
           "pretix.plugins.stripe",
           "pretix.plugins.paypal"
         ],
-        "sales_channels": [
-          "web",
-          "pretixpos",
-          "resellers"
-        ]
+        "all_sales_channels": true,
+        "limit_sales_channels": []
       }
 
    **Example response**:
@@ -320,6 +307,8 @@ Endpoints
           "pretix.plugins.stripe",
           "pretix.plugins.paypal"
         ],
+        "all_sales_channels": true,
+        "limit_sales_channels": [],
         "sales_channels": [
           "web",
           "pretixpos",
@@ -343,8 +332,8 @@ Endpoints
    Creates a new event with properties as set in the request body. The properties that are copied are: ``is_public``,
    ``testmode``, ``has_subevents``, settings, plugin settings, items, variations, add-ons, quotas, categories, tax rules, questions.
 
-   If the ``plugins``, ``has_subevents`` and/or ``is_public`` fields are present in the post body this will determine their
-   value. Otherwise their value will be copied from the existing event.
+   If the ``plugins``, ``has_subevents``, ``meta_data`` and/or ``is_public`` fields are present in the post body this will
+   determine their  value. Otherwise their value will be copied from the existing event.
 
    Please note that you can only copy from events under the same organizer this way. Use the ``clone_from`` parameter
    when creating a new event for this instead.
@@ -385,11 +374,8 @@ Endpoints
           "pretix.plugins.stripe",
           "pretix.plugins.paypal"
         ],
-        "sales_channels": [
-          "web",
-          "pretixpos",
-          "resellers"
-        ]
+        "all_sales_channels": true,
+        "limit_sales_channels": []
       }
 
    **Example response**:
@@ -425,6 +411,8 @@ Endpoints
           "pretix.plugins.stripe",
           "pretix.plugins.paypal"
         ],
+        "all_sales_channels": true,
+        "limit_sales_channels": [],
         "sales_channels": [
           "web",
           "pretixpos",
@@ -436,9 +424,9 @@ Endpoints
    :param organizer: The ``slug`` field of the organizer of the event to create.
    :param event: The ``slug`` field of the event to copy settings and items from.
    :statuscode 201: no error
-   :statuscode 400: The event could not be created due to invalid submitted data.
+   :statuscode 400: The event could not be updated due to invalid submitted data.
    :statuscode 401: Authentication failure
-   :statuscode 403: The requested organizer does not exist **or** you have no permission to create this resource.
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to update this resource.
 
 
 .. http:patch:: /api/v1/organizers/(organizer)/events/(event)/
@@ -500,6 +488,8 @@ Endpoints
           "pretix.plugins.paypal",
           "pretix.plugins.pretixdroid"
         ],
+        "all_sales_channels": true,
+        "limit_sales_channels": [],
         "sales_channels": [
           "web",
           "pretixpos",
@@ -565,6 +555,8 @@ organizer level.
 .. warning:: This API is intended for advanced users. Even though we take care to validate your input, you will be
              able to break your event using this API by creating situations of conflicting settings. Please take care.
 
+.. note:: When authenticating with :ref:`rest-deviceauth`, only a limited subset of settings is available.
+
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/settings/
 
    Get current values of event settings.
@@ -619,10 +611,6 @@ organizer level.
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
 
-   .. versionchanged:: 4.18
-
-       The ``readonly`` flag has been added.
-
 .. http:patch:: /api/v1/organizers/(organizer)/events/(event)/settings/
 
    Updates event settings. Note that ``PUT`` is not allowed here, only ``PATCH``.

doc/api/resources/exhibitors.rst

@@ -1,6 +1,8 @@
 Exhibitors
 ==========
 
+.. note:: This API is only available when the plugin **pretix-exhibitors** is installed (pretix Hosted and Enterprise only).
+
 The exhibitors plugin allows to manage exhibitors at your trade show or conference. After signing up your exhibitors
 in the system, you can assign vouchers to exhibitors and give them access to the data of these vouchers. The exhibitors
 module is also the basis of the pretixLEAD lead scanning application.
@@ -34,13 +36,19 @@ internal_id                           string                     Can be used for
 contact_name                          string                     Contact person (or ``null``)
 contact_name_parts                    object of strings          Decomposition of contact name (i.e. given name, family name)
 contact_email                         string                     Contact person email address (or ``null``)
+contact_cc_email                      string                     Copy email addresses, can be multiple separated by comma (or ``null``)
 booth                                 string                     Booth number (or ``null``). Maximum 100 characters.
-locale                                string                     Locale for communication with the exhibitor (or ``null``).
+locale                                string                     Locale for communication with the exhibitor.
 access_code                           string                     Access code for the exhibitor to access their data or use the lead scanning app (read-only).
+lead_scanning_access_code             string                     Access code for the exhibitor to use the lead scanning app but not access data (read-only).
 allow_lead_scanning                   boolean                    Enables lead scanning app
 allow_lead_access                     boolean                    Enables access to data gathered by the lead scanning app
 allow_voucher_access                  boolean                    Enables access to data gathered by exhibitor vouchers
+lead_scanning_scope_by_device         string                     Enables lead scanning to be handled as one lead per attendee
+                                                                 per scanning device, instead of only per exhibitor.
 comment                               string                     Internal comment, not shown to exhibitor
+exhibitor_tags                        list of strings            Internal tags to categorize exhibitors, not shown to exhibitor.
+                                                                 The tags need to be created through the web interface currently.
 ===================================== ========================== =======================================================
 
 You can also access the scanned leads through the API which contains the following public fields:
@@ -62,6 +70,7 @@ data                                  list of objects            Attendee data s
                                                                  except in a few cases where it contains an additional list of objects
                                                                  with ``value`` and ``label`` keys (e.g. splitting of names).
 device_name                           string                     User-defined name for the device used for scanning (or ``null``).
+device_uuid                           string                     UUID of device used for scanning (or ``null``).
 ===================================== ========================== =======================================================
 
 Endpoints
@@ -105,13 +114,17 @@ Endpoints
                 "title": "Dr"
             },
             "contact_email": "johnson@as.example.org",
+            "contact_cc_email": "miller@as.example.org,smith@as.example.org",
             "booth": "A2",
             "locale": "de",
-            "access_code": "VKHZ2FU8",
+            "access_code": "VKHZ2FU84",
+            "lead_scanning_access_code": "WVK2B8PZ",
+            "lead_scanning_scope_by_device": false,
             "allow_lead_scanning": true,
             "allow_lead_access": true,
             "allow_voucher_access": true,
-            "comment": ""
+            "comment": "",
+            "exhibitor_tags": []
           }
         ]
       }
@@ -156,13 +169,17 @@ Endpoints
             "title": "Dr"
         },
         "contact_email": "johnson@as.example.org",
+        "contact_cc_email": "miller@as.example.org,smith@as.example.org",
         "booth": "A2",
         "locale": "de",
-        "access_code": "VKHZ2FU8",
+        "access_code": "VKHZ2FU84",
+        "lead_scanning_access_code": "WVK2B8PZ",
+        "lead_scanning_scope_by_device": false,
         "allow_lead_scanning": true,
         "allow_lead_access": true,
         "allow_voucher_access": true,
-        "comment": ""
+        "comment": "",
+        "exhibitor_tags": []
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -230,7 +247,8 @@ Endpoints
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/vouchers/
 
    Returns a list of all vouchers connected to an exhibitor. The response contains the same data as described in
-   :ref:`rest-vouchers`.
+   :ref:`rest-vouchers` as well as for each voucher an additional field ``exhibitor_comment`` that is shown to the exhibitor. It can only
+   be modified using the ``attach`` API call below.
 
    **Example request**:
 
@@ -285,7 +303,7 @@ Endpoints
 .. http:post:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/vouchers/attach/
 
    Attaches an **existing** voucher to an exhibitor. You need to send either the ``id`` **or** the ``code`` field of
-   the voucher.
+   the voucher. You can call this method multiple times to update the optional ``exhibitor_comment`` field.
 
    **Example request**:
 
@@ -296,7 +314,8 @@ Endpoints
       Accept: application/json, text/javascript
 
      {
-       "id": 15
+       "id": 15,
+       "exhibitor_comment": "Free ticket"
      }
 
    **Example request**:
@@ -308,7 +327,8 @@ Endpoints
       Accept: application/json, text/javascript
 
      {
-       "code": "43K6LKM37FBVR2YG"
+       "code": "43K6LKM37FBVR2YG",
+       "exhibitor_comment": "Free ticket"
      }
 
    **Example response**:
@@ -329,6 +349,45 @@ Endpoints
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer or event or exhibitor does not exist **or** you have no permission to view it.
 
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/vouchers/bulk_attach/
+
+   Attaches many **existing** vouchers to an exhibitor. You need to send either the ``id`` **or** the ``code`` field of
+   the voucher, but you need to send the same field for all entries.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/exhibitors/1/vouchers/bulk_attach/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+     [
+       {
+         "id": 15,
+         "exhibitor_comment": "Free ticket"
+       },
+       ..
+     ]
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {}
+
+   :param organizer: The ``slug`` field of a valid organizer
+   :param event: The ``slug`` field of the event to use
+   :param id: The ``id`` field of the exhibitor to use
+   :statuscode 200: no error
+   :statuscode 400: Invalid data sent, e.g. voucher does not exist
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer or event or exhibitor does not exist **or** you have no permission to view it.
+
 .. http:post:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/
 
    Create a new exhibitor.
@@ -354,13 +413,16 @@ Endpoints
             "title": "Dr"
         },
         "contact_email": "johnson@as.example.org",
+        "contact_cc_email": "miller@as.example.org,smith@as.example.org",
         "booth": "A2",
         "locale": "de",
-        "access_code": "VKHZ2FU8",
         "allow_lead_scanning": true,
         "allow_lead_access": true,
         "allow_voucher_access": true,
-        "comment": ""
+        "comment": "",
+        "exhibitor_tags": [
+          "Gold Sponsor"
+        ]
       }
 
    **Example response**:
@@ -384,13 +446,19 @@ Endpoints
             "title": "Dr"
         },
         "contact_email": "johnson@as.example.org",
+        "contact_cc_email": "miller@as.example.org,smith@as.example.org",
         "booth": "A2",
         "locale": "de",
-        "access_code": "VKHZ2FU8",
+        "access_code": "VKHZ2FU84",
+        "lead_scanning_access_code": "WVK2B8PZ",
+        "lead_scanning_scope_by_device": false,
         "allow_lead_scanning": true,
         "allow_lead_access": true,
         "allow_voucher_access": true,
-        "comment": ""
+        "comment": "",
+        "exhibitor_tags": [
+          "Gold Sponsor"
+        ]
       }
 
    :param organizer: The ``slug`` field of the organizer to create new exhibitor for
@@ -411,7 +479,7 @@ Endpoints
 
    .. sourcecode:: http
 
-      PATCH /api/v1/organizers/bigevents/events/sampleconf/digitalcontents/1/ HTTP/1.1
+      PATCH /api/v1/organizers/bigevents/events/sampleconf/exhibitors/1/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
       Content-Type: application/json
@@ -442,13 +510,19 @@ Endpoints
             "title": "Dr"
         },
         "contact_email": "johnson@as.example.org",
+        "contact_cc_email": "miller@as.example.org,smith@as.example.org",
         "booth": "A2",
         "locale": "de",
-        "access_code": "VKHZ2FU8",
+        "access_code": "VKHZ2FU84",
+        "lead_scanning_access_code": "WVK2B8PZ",
+        "lead_scanning_scope_by_device": false,
         "allow_lead_scanning": true,
         "allow_lead_access": true,
         "allow_voucher_access": true,
-        "comment": ""
+        "comment": "",
+        "exhibitor_tags": [
+          "Gold Sponsor"
+        ]
       }
 
    :param organizer: The ``slug`` field of the organizer to modify
@@ -459,6 +533,36 @@ Endpoints
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event/exhibitor does not exist **or** you have no permission to change it.
 
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/send_access_code/
+
+   Sends an email to the exhibitor with their access code.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/exhibitors/1/send_access_code/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 204 No Content
+      Vary: Accept
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param event: The ``slug`` field of the event to modify
+   :param code: The ``id`` field of the exhibitor to send an email for
+   :statuscode 200: no error
+   :statuscode 400: The exhibitor does not have an email address associated
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+   :statuscode 404: The requested exhibitor does not exist.
+   :statuscode 503: The email could not be sent.
+
 
 .. http:delete:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/
 
@@ -529,6 +633,7 @@ name                                  string                     Exhibitor name
 booth                                 string                     Booth number (or ``null``)
 event                                 object                     Object describing the event
 ├ name                                multi-lingual string       Event name
+├ end_date                            datetime                   End date of the event. After this time, the app could show a warning that the event is over.
 ├ imprint_url                         string                     URL to legal notice page. If not ``null``, a button in the app should link to this page.
 ├ privacy_url                         string                     URL to privacy notice page. If not ``null``, a button in the app should link to this page.
 ├ help_url                            string                     URL to help page. If not ``null``, a button in the app should link to this page.
@@ -564,6 +669,7 @@ scan_types                            list of objects            Only used for a
       "booth": "A2",
       "event": {
         "name": {"en": "Sample conference", "de": "Beispielkonferenz"},
+        "end_date": "2017-12-28T10:00:00+00:00",
         "slug": "bigevents",
         "imprint_url": null,
         "privacy_url": null,
@@ -602,6 +708,7 @@ On the request, you should set the following properties:
 * ``tags`` with the list of selected tags
 * ``rating`` with the rating assigned by the exhibitor
 * ``device_name`` with a user-specified name of the device used for scanning (max. 190 characters), or ``null``
+* ``device_uuid`` with a auto-generated UUID of the device used for scanning, or ``null``
 
 If you submit ``tags`` and ``rating`` to be ``null`` and ``notes`` to be ``""``, the server
 responds with the previously saved information and will not delete that information. If you
@@ -636,7 +743,8 @@ The request for this looks like this:
       "scan_type": "lead",
       "tags": ["foo"],
       "rating": 4,
-      "device_name": "DEV1"
+      "device_name": "DEV1",
+      "device_uuid": "d8c2ec53-d602-4a08-882d-db4cf54344a2"
     }
 
    **Example response:**
@@ -669,7 +777,9 @@ The request for this looks like this:
         },
         "rating": 4,
         "tags": ["foo"],
-        "notes": "Great customer, wants our newsletter"
+        "notes": "Great customer, wants our newsletter",
+        "device_name": "DEV1",
+        "device_uuid": "d8c2ec53-d602-4a08-882d-db4cf54344a2"
     }
 
    :statuscode 200: No error, leads was not scanned for the first time
@@ -724,7 +834,9 @@ You can also fetch existing leads (if you are authorized to do so):
           },
           "rating": 4,
           "tags": ["foo"],
-          "notes": "Great customer, wants our newsletter"
+          "notes": "Great customer, wants our newsletter",
+          "device_name": "DEV1",
+          "device_uuid": "d8c2ec53-d602-4a08-882d-db4cf54344a2"
         }
       ]
     }

doc/api/resources/exporters.rst

@@ -1,5 +1,7 @@
 .. spelling:word-list:: checkin
 
+.. _rest-exporters:
+
 Data exporters
 ==============
 

doc/api/resources/giftcards.rst

@@ -47,11 +47,6 @@ acceptor                              string                     Organizer slug
                                                                  this field was added.)
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.20
-
-    The ``owner_ticket`` and ``issuer`` attributes of the gift card and the ``info`` and ``acceptor`` attributes of the
-    gift card transaction resource have been added.
-
 Endpoints
 ---------
 
@@ -96,6 +91,8 @@ Endpoints
 
    :query integer page: The page number in case of a multi-page result set, default is 1
    :query string secret: Only show gift cards with the given secret.
+   :query string value: Only show gift cards with the given value.
+   :query boolean expired: Filter for gift cards that are (not) expired.
    :query boolean testmode: Filter for gift cards that are (not) in test mode.
    :query boolean include_accepted: Also show gift cards issued by other organizers that are accepted by this organizer.
    :query string expand: If you pass ``"owner_ticket"``, the respective field will be shown as a nested value instead of just an ID.

doc/api/resources/imported_secrets.rst

@@ -1,6 +1,8 @@
 Secrets Import
 ==============
 
+.. note:: This API is only available when the plugin **pretix-secrets-import** is installed (pretix Hosted and Enterprise only).
+
 Usually, pretix generates ticket secrets (i.e. the QR code used for scanning) itself. You can read more about this
 process at :ref:`secret_generators`.
 

doc/api/resources/index.rst

@@ -19,17 +19,21 @@ at :ref:`plugin-docs`.
    item_bundles
    item_add-ons
    item_meta_properties
+   item_program_times
    questions
    question_options
    quotas
+   seats
    orders
    invoices
+   transactions
    vouchers
    discounts
    checkin
    checkinlists
    waitinglist
    customers
+   saleschannels
    membershiptypes
    memberships
    giftcards
@@ -40,7 +44,19 @@ at :ref:`plugin-docs`.
    webhooks
    seatingplans
    exporters
+   scheduled_exports
    shredders
+   banktransfer
+   ticketoutputpdf
+   badges
    sendmail_rules
+   auto_checkin_rules
+   campaigns
+   certificates
+   digital
+   exhibitors
+   imported_secrets
+   offlinesales
+   shipping
    billing_invoices
-   billing_var
+   billing_var

doc/api/resources/invoices.rst

@@ -1,3 +1,5 @@
+.. _rest-invoices:
+
 Invoices
 ========
 
@@ -12,6 +14,7 @@ The invoice resource contains the following public fields:
 Field                                 Type                       Description
 ===================================== ========================== =======================================================
 number                                string                     Invoice number (with prefix)
+event                                 string                     The slug of the parent event
 order                                 string                     Order code of the order this invoice belongs to
 is_cancellation                       boolean                    ``true``, if this invoice is the cancellation of a
                                                                  different invoice.
@@ -19,10 +22,13 @@ invoice_from_name                     string                     Sender address:
 invoice_from                          string                     Sender address: Address lines
 invoice_from_zipcode                  string                     Sender address: ZIP code
 invoice_from_city                     string                     Sender address: City
+invoice_from_state                    string                     Sender address: State (only used in some countries)
 invoice_from_country                  string                     Sender address: Country code
 invoice_from_tax_id                   string                     Sender address: Local Tax ID
 invoice_from_vat_id                   string                     Sender address: EU VAT ID
 invoice_to                            string                     Full recipient address
+invoice_to_is_business                boolean                    Recipient address: Business vs individual (``null`` for
+                                                                 invoices created before pretix 2025.6).
 invoice_to_company                    string                     Recipient address: Company name
 invoice_to_name                       string                     Recipient address: Person name
 invoice_to_street                     string                     Recipient address: Address lines
@@ -32,6 +38,7 @@ invoice_to_state                      string                     Recipient addre
 invoice_to_country                    string                     Recipient address: Country code
 invoice_to_vat_id                     string                     Recipient address: EU VAT ID
 invoice_to_beneficiary                string                     Invoice beneficiary
+invoice_to_transmission_info          object                     Additional transmission info (see :ref:`rest-transmission-types`)
 custom_field                          string                     Custom invoice address field
 date                                  date                       Invoice date
 refers                                string                     Invoice number of an invoice this invoice refers to
@@ -74,17 +81,12 @@ lines                                 list of objects            The actual invo
                                                                  for all invoice lines
                                                                  created before this field was introduced as well as for
                                                                  all lines not created by a fee (e.g. a product).
-├ event_date_from                     datetime                   Start date of the (sub)event this line was created for as it
-                                                                 was set during invoice creation. Can be ``null`` for all invoice
-                                                                 lines created before this was introduced as well as for lines in
-                                                                 an event series not created by a product (e.g. shipping or
-                                                                 cancellation fees).
-├ event_date_to                       datetime                   End date of the (sub)event this line was created for as it
-                                                                 was set during invoice creation. Can be ``null`` for all invoice
-                                                                 lines created before this was introduced as well as for lines in
-                                                                 an event series not created by a product (e.g. shipping or
-                                                                 cancellation fees) as well as whenever the respective (sub)event
-                                                                 has no end date set.
+├ period_start                        datetime                   Start date of the service or delivery period of the invoice line.
+                                                                 Can be ``null`` if not known.
+├ period_end                          datetime                   End date of the service or delivery period of the invoice line.
+                                                                 Can be ``null`` if not known.
+├ event_date_from                     datetime                   Deprecated alias of ``period_start``.
+├ event_date_to                       datetime                   Deprecated alias of ``period_end``.
 ├ event_location                      string                     Location of the (sub)event this line was created for as it
                                                                  was set during invoice creation. Can be ``null`` for all invoice
                                                                  lines created before this was introduced as well as for lines in
@@ -96,6 +98,7 @@ lines                                 list of objects            The actual invo
 ├ gross_value                         money (string)             Price including taxes
 ├ tax_value                           money (string)             Tax amount included
 ├ tax_name                            string                     Name of used tax rate (e.g. "VAT")
+├ tax_code                            string                     Codified reason for tax rate (or ``null``), see :ref:`rest-taxcodes`.
 └ tax_rate                            decimal (string)           Used tax rate
 foreign_currency_display              string                     If the invoice should also show the total and tax
                                                                  amount in a different currency, this contains the
@@ -106,24 +109,96 @@ foreign_currency_rate                 decimal (string)           If ``foreign_cu
 foreign_currency_rate_date            date                       If ``foreign_currency_rate`` is set, this signifies the
                                                                  date at which the currency rate was obtained.
 internal_reference                    string                     Customer's reference to be printed on the invoice.
+transmission_type                     string                     Requested transmission channel (see :ref:`rest-transmission-types`)
+transmission_provider                 string                     Selected transmission provider (depends on installed
+                                                                 plugins). ``null`` if not yet chosen.
+transmission_status                   string                     Transmission status, one of ``unknown`` (pre-2025.6),
+                                                                 ``pending``, ``inflight``, ``failed``, and ``completed``.
+transmission_date                     datetime                   Time of last change in transmission status (may be ``null``).
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 4.1
+.. versionchanged:: 2023.8
 
-   The attributes ``fee_type`` and ``fee_internal_type`` have been added.
+   The ``event`` attribute has been added. The organizer-level endpoint has been added.
 
-.. versionchanged:: 4.1
+.. versionchanged:: 2024.8
 
-   The attribute ``lines.event_location`` has been added.
+   The ``tax_code`` attribute has been added.
 
-.. versionchanged:: 4.6
+.. versionchanged:: 2025.6
 
-   The attribute ``lines.subevent`` has been added.
+   The attributes ``invoice_to_is_business``, ``invoice_to_transmission_info``, ``transmission_type``,
+   ``transmission_provider``, ``transmission_status``, and ``transmission_date`` have been added.
 
 
-Endpoints
----------
+.. _`rest-transmission-types`:
+
+Transmission types
+------------------
+
+pretix supports multiple ways to transmit an invoice from the organizer to the invoice recipient.
+For each transmission type, different fields are supported in the ``transmission_info`` object of the
+invoice address. Currently, pretix supports the following transmission types:
+
+Email
+"""""
+
+The identifier ``"email"`` represents the transmission of PDF invoices through email.
+This is the default transmission type in pretix and has some special behavior for backwards compatibility.
+Transmission is always executed through the provider ``"email_pdf"``.
+The ``transmission_info`` object may contain the following properties:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+transmission_email_address            string                     Optional. An email address other than the order address
+                                                                 that the invoice should be sent to.
+                                                                 Business customers only.
+===================================== ========================== =======================================================
+
+Peppol
+""""""
+
+The identifier ``"peppol"`` represents the transmission of XML invoices through the `Peppol`_ network.
+This is only available for business addresses.
+This is not supported by pretix out of the box and requires the use of a suitable plugin.
+The ``transmission_info`` object may contain the following properties:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+transmission_peppol_participant_id    string                     Required. The Peppol participant ID of the recipient.
+===================================== ========================== =======================================================
+
+Italian Exchange System
+"""""""""""""""""""""""
+
+The identifier ``"it_sdi"`` represents the transmission of XML invoices through the `Sistema di Interscambio`_ network used in Italy.
+This is only available for addresses with country ``"IT"``.
+This is not supported by pretix out of the box and requires the use of a suitable plugin.
+The ``transmission_info`` object may contain the following properties:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+transmission_it_sdi_codice_fiscale    string                     Required for non-business address. Fiscal code of the
+                                                                 recipient.
+transmission_it_sdi_pec               string                     Required for business addresses. Address for certified
+                                                                 electronic mail.
+transmission_it_sdi_recipient_code    string                     Required for businesses. SdI recipient code.
+===================================== ========================== =======================================================
+
+If this type is selected, ``vat_id`` is required for business addresses.
+
+List of all invoices
+--------------------
 
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/invoices/
 
@@ -152,17 +227,20 @@ Endpoints
         "results": [
           {
             "number": "SAMPLECONF-00001",
+            "event": "sampleconf",
             "order": "ABC12",
             "is_cancellation": false,
             "invoice_from_name": "Big Events LLC",
             "invoice_from": "Demo street 12",
             "invoice_from_zipcode":"",
             "invoice_from_city":"Demo town",
+            "invoice_from_state":"CA",
             "invoice_from_country":"US",
             "invoice_from_tax_id":"",
             "invoice_from_vat_id":"",
             "invoice_to": "Sample company\nJohn Doe\nTest street 12\n12345 Testington\nTestikistan\nVAT-ID: EU123456789",
             "invoice_to_company": "Sample company",
+            "invoice_to_is_business": true,
             "invoice_to_name": "John Doe",
             "invoice_to_street": "Test street 12",
             "invoice_to_zipcode": "12345",
@@ -171,6 +249,7 @@ Endpoints
             "invoice_to_country": "TE",
             "invoice_to_vat_id": "EU123456789",
             "invoice_to_beneficiary": "",
+            "invoice_to_transmission_info": {},
             "custom_field": null,
             "date": "2017-12-01",
             "refers": null,
@@ -192,17 +271,24 @@ Endpoints
                 "fee_internal_type": null,
                 "event_date_from": "2017-12-27T10:00:00Z",
                 "event_date_to": null,
+                "period_start": "2017-12-27T10:00:00Z",
+                "period_end": "2017-12-27T10:00:00Z",
                 "event_location": "Heidelberg",
                 "attendee_name": null,
                 "gross_value": "23.00",
                 "tax_value": "0.00",
                 "tax_name": "VAT",
+                "tax_code": "S/standard",
                 "tax_rate": "0.00"
               }
             ],
             "foreign_currency_display": "PLN",
             "foreign_currency_rate": "4.2408",
-            "foreign_currency_rate_date": "2017-07-24"
+            "foreign_currency_rate_date": "2017-07-24",
+            "transmission_type": "email",
+            "transmission_provider": "email_pdf",
+            "transmission_status": "completed",
+            "transmission_date": "2017-07-24T10:00:00Z"
           }
         ]
       }
@@ -211,6 +297,9 @@ Endpoints
    :query boolean is_cancellation: If set to ``true`` or ``false``, only invoices with this value for the field
                                    ``is_cancellation`` will be returned.
    :query string order: If set, only invoices belonging to the order with the given order code will be returned.
+                        This parameter may be given multiple times. In this case, all invoices matching one of the inputs will be returned.
+   :query string number: If set, only invoices with the given invoice number will be returned.
+                        This parameter may be given multiple times. In this case, all invoices matching one of the inputs will be returned.
    :query string refers: If set, only invoices referring to the given invoice will be returned.
    :query string locale: If set, only invoices with the given locale will be returned.
    :query string ordering: Manually set the ordering of results. Valid fields to be used are ``date`` and
@@ -221,6 +310,50 @@ Endpoints
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
 
+.. http:get:: /api/v1/organizers/(organizer)/invoices/
+
+   Returns a list of all invoices within all events of a given organizer (with sufficient access permissions).
+
+   Supported query parameters and output format of this endpoint are identical to the list endpoint within an event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/invoices/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "number": "SAMPLECONF-00001",
+            "event": "sampleconf",
+            "order": "ABC12",
+            ...
+        ]
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+
+
+Fetching individual invoices
+----------------------------
+
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/invoices/(number)/
 
    Returns information on one invoice, identified by its invoice number.
@@ -243,17 +376,20 @@ Endpoints
 
       {
         "number": "SAMPLECONF-00001",
+        "event": "sampleconf",
         "order": "ABC12",
         "is_cancellation": false,
         "invoice_from_name": "Big Events LLC",
         "invoice_from": "Demo street 12",
         "invoice_from_zipcode":"",
         "invoice_from_city":"Demo town",
+        "invoice_from_state":"CA",
         "invoice_from_country":"US",
         "invoice_from_tax_id":"",
         "invoice_from_vat_id":"",
         "invoice_to": "Sample company\nJohn Doe\nTest street 12\n12345 Testington\nTestikistan\nVAT-ID: EU123456789",
         "invoice_to_company": "Sample company",
+        "invoice_to_is_business": true,
         "invoice_to_name": "John Doe",
         "invoice_to_street": "Test street 12",
         "invoice_to_zipcode": "12345",
@@ -262,6 +398,7 @@ Endpoints
         "invoice_to_country": "TE",
         "invoice_to_vat_id": "EU123456789",
         "invoice_to_beneficiary": "",
+        "invoice_to_transmission_info": {},
         "custom_field": null,
         "date": "2017-12-01",
         "refers": null,
@@ -283,27 +420,34 @@ Endpoints
             "fee_internal_type": null,
             "event_date_from": "2017-12-27T10:00:00Z",
             "event_date_to": null,
+            "period_start": "2017-12-27T10:00:00Z",
+            "period_end": "2017-12-27T10:00:00Z",
             "event_location": "Heidelberg",
             "attendee_name": null,
             "gross_value": "23.00",
             "tax_value": "0.00",
             "tax_name": "VAT",
+            "tax_code": "S/standard",
             "tax_rate": "0.00"
           }
         ],
         "foreign_currency_display": "PLN",
         "foreign_currency_rate": "4.2408",
-        "foreign_currency_rate_date": "2017-07-24"
+        "foreign_currency_rate_date": "2017-07-24",
+        "transmission_type": "email",
+        "transmission_provider": "email_pdf",
+        "transmission_status": "completed",
+        "transmission_date": "2017-07-24T10:00:00Z"
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
-   :param invoice_no: The ``invoice_no`` field of the invoice to fetch
+   :param number: The ``number`` field of the invoice to fetch
    :statuscode 200: no error
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
 
-.. http:get:: /api/v1/organizers/(organizer)/events/(event)/invoices/(invoice_no)/download/
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/invoices/(number)/download/
 
    Download an invoice in PDF format.
 
@@ -330,14 +474,20 @@ Endpoints
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
-   :param invoice_no: The ``invoice_no`` field of the invoice to fetch
+   :param number: The ``number`` field of the invoice to fetch
    :statuscode 200: no error
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
    :statuscode 409: The file is not yet ready and will now be prepared. Retry the request after waiting for a few
                     seconds.
 
-.. http:post:: /api/v1/organizers/(organizer)/events/(event)/invoices/(invoice_no)/reissue/
+
+Modifying invoices
+------------------
+
+Invoices cannot be edited directly, but the following actions can be triggered:
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/invoices/(number)/reissue/
 
    Cancels the invoice and creates a new one.
 
@@ -359,13 +509,13 @@ Endpoints
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
-   :param invoice_no: The ``invoice_no`` field of the invoice to reissue
+   :param number: The ``number`` field of the invoice to reissue
    :statuscode 200: no error
    :statuscode 400: The invoice has already been canceled
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to change this resource.
 
-.. http:post:: /api/v1/organizers/(organizer)/events/(event)/invoices/(invoice_no)/regenerate/
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/invoices/(number)/regenerate/
 
    Re-generates the invoice from order data.
 
@@ -387,8 +537,75 @@ Endpoints
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
-   :param invoice_no: The ``invoice_no`` field of the invoice to regenerate
+   :param number: The ``number`` field of the invoice to regenerate
    :statuscode 200: no error
    :statuscode 400: The invoice has already been canceled
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to change this resource.
+
+
+Transmitting invoices
+---------------------
+
+Invoices are transmitted automatically when created during order creation or payment receipt,
+but in other cases transmission may need to be triggered manually.
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/invoices/(number)/transmit/
+
+   Transmits the invoice to the recipient, but only if it is in ``pending`` state.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/invoices/00001/transmit/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 204 No Content
+      Vary: Accept
+      Content-Type: application/pdf
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param number: The ``number`` field of the invoice to transmit
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to transmit this invoice **or** the invoice may not be transmitted
+   :statuscode 409: The invoice is currently in transmission
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/invoices/(number)/retransmit/
+
+   Transmits the invoice to the recipient even if transmission was already attempted previously.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/invoices/00001/retransmit/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 204 No Content
+      Vary: Accept
+      Content-Type: application/pdf
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param number: The ``number`` field of the invoice to transmit
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to transmit this invoice **or** the invoice may not be transmitted
+   :statuscode 409: The invoice is currently in transmission
+
+
+.. _Peppol: https://en.wikipedia.org/wiki/PEPPOL
+.. _Sistema di Interscambio: https://it.wikipedia.org/wiki/Fattura_elettronica_in_Italia

doc/api/resources/item_program_times.rst

@@ -0,0 +1,223 @@
+Item program times
+==================
+
+Resource description
+--------------------
+
+Program times for products (items) that can be set in addition to event times, e.g. to display seperate schedules within an event.
+Note that ``program_times`` are not available for items inside event series.
+The program times resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of the program time
+start                                 datetime                   The start date time for this program time slot.
+end                                   datetime                   The end date time for this program time slot.
+===================================== ========================== =======================================================
+
+.. versionchanged:: TODO
+
+   The resource has been added.
+
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/items/(item)/program_times/
+
+   Returns a list of all program times for a given item.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/items/11/program_times/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+         "count": 3,
+         "next": null,
+         "previous": null,
+         "results": [
+            {
+               "id": 2,
+               "start": "2025-08-14T22:00:00Z",
+               "end": "2025-08-15T00:00:00Z"
+            },
+            {
+               "id": 3,
+               "start": "2025-08-12T22:00:00Z",
+               "end": "2025-08-13T22:00:00Z"
+            },
+            {
+               "id": 14,
+               "start": "2025-08-15T22:00:00Z",
+               "end": "2025-08-17T22:00:00Z"
+            }
+        ]
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param item: The ``id`` field of the item to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/item does not exist **or** you have no permission to view this resource.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/items/(item)/program_times/(id)/
+
+   Returns information on one program time, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/items/1/program_times/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+         "id": 1,
+         "start": "2025-08-15T22:00:00Z",
+         "end": "2025-10-27T23:00:00Z"
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param item: The ``id`` field of the item to fetch
+   :param id: The ``id`` field of the program time to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/items/(item)/program_times/
+
+   Creates a new program time
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/items/1/program_times/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "start": "2025-08-15T10:00:00Z",
+        "end": "2025-08-15T22:00:00Z"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 17,
+        "start": "2025-08-15T10:00:00Z",
+        "end": "2025-08-15T22:00:00Z"
+      }
+
+   :param organizer: The ``slug`` field of the organizer of the event/item to create a program time for
+   :param event: The ``slug`` field of the event to create a program time for
+   :param item: The ``id`` field of the item to create a program time for
+   :statuscode 201: no error
+   :statuscode 400: The program time could not be created due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to create this resource.
+
+.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/items/(item)/program_times/(id)/
+
+   Update a program time. You can also use ``PUT`` instead of ``PATCH``. With ``PUT``, you have to provide all fields of
+   the resource, other fields will be reset to default. With ``PATCH``, you only need to provide the fields that you
+   want to change.
+
+   You can change all fields of the resource except the ``id`` field.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/events/sampleconf/items/1/program_times/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 94
+
+      {
+        "start": "2025-08-14T10:00:00Z"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "start": "2025-08-14T10:00:00Z",
+        "end": "2025-08-15T12:00:00Z"
+      }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param event: The ``slug`` field of the event to modify
+   :param id: The ``id`` field of the item to modify
+   :param id: The ``id`` field of the program time to modify
+   :statuscode 200: no error
+   :statuscode 400: The program time could not be modified due to invalid submitted data
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to change this resource.
+
+.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/items/(id)/program_times/(id)/
+
+   Delete a program time.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/items/1/program_times/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 204 No Content
+      Vary: Accept
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param event: The ``slug`` field of the event to modify
+   :param id: The ``id`` field of the item to modify
+   :param id: The ``id`` field of the program time to delete
+   :statuscode 204: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to delete this resource.

doc/api/resources/item_variations.rst

@@ -18,6 +18,8 @@ default_price                         money (string)             The price set d
 price                                 money (string)             The price used for this variation. This is either the
                                                                  same as ``default_price`` if that value is set or equal
                                                                  to the item's ``default_price`` (read-only).
+free_price_suggestion                 money (string)             A suggested price, used as a default value if
+                                                                 ``Item.free_price`` is set (or ``null``).
 original_price                        money (string)             An original price, shown for comparison, not used
                                                                  for price calculations (or ``null``).
 active                                boolean                    If ``false``, this variation will not be sold or shown.
@@ -27,6 +29,8 @@ position                              integer                    An integer, use
 checkin_attention                     boolean                    If ``true``, the check-in app should show a warning
                                                                  that this ticket requires special attention if such
                                                                  a variation is being scanned.
+checkin_text                          string                     Text that will be shown if a ticket of this type is
+                                                                 scanned (or ``null``).
 require_approval                      boolean                    If ``true``, orders with this variation will need to be
                                                                  approved by the event organizer before they can be
                                                                  paid.
@@ -34,24 +38,37 @@ require_membership                    boolean                    If ``true``, bo
 require_membership_hidden             boolean                    If ``true`` and ``require_membership`` is set, this variation will
                                                                  be hidden from users without a valid membership.
 require_membership_types              list of integers           Internal IDs of membership types valid if ``require_membership`` is ``true``
-sales_channels                        list of strings            Sales channels this variation is available on, such as
-                                                                 ``"web"`` or ``"resellers"``. Defaults to all existing sales channels.
+all_sales_channels                    boolean                    If ``true`` (default), the variation is available on all sales channels.
+limit_sales_channels                  list of strings            List of sales channel identifiers the variation is available on
+                                                                 if ``all_sales_channels`` is ``false``.
                                                                  The item-level list takes precedence, i.e. a sales
-                                                                 channel needs to be on both lists for the item to be
-                                                                 available.
+                                                                 channel needs to be on both lists for the variation to be
+                                                                 available (unless ``all_sales_channels`` is used).
+sales_channels                        list of strings            **DEPRECATED.** Legacy interface, use ``all_sales_channels``
+                                                                 and ``limit_sales_channels`` instead.
 available_from                        datetime                   The first date time at which this variation can be bought
                                                                  (or ``null``).
+available_from_mode                   string                     If ``hide`` (the default), this variation is hidden in the shop
+                                                                 if unavailable due to the available_from setting.
+                                                                 If ``info``, the variation is visible, but can't be purchased,
+                                                                 and a note explaining the unavailability is displayed.
 available_until                       datetime                   The last date time at which this variation can be bought
                                                                  (or ``null``).
+available_until_mode                  string                     If ``hide`` (the default), this variation is hidden in the shop
+                                                                 if unavailable due to the available_until setting.
+                                                                 If ``info``, the variation is visible, but can't be purchased,
+                                                                 and a note explaining the unavailability is displayed.
 hide_without_voucher                  boolean                    If ``true``, this variation is only shown during the voucher
                                                                  redemption process, but not in the normal shop
                                                                  frontend.
 meta_data                             object                     Values set for event-specific meta data parameters.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.16
+.. versionchanged:: 2023.10
+
+   The ``free_price_suggestion`` attribute has been added.
+   The ``checkin_text`` attribute has been added.
 
-   The ``meta_data`` and ``checkin_attention`` attributes have been added.
 
 Endpoints
 ---------
@@ -88,13 +105,18 @@ Endpoints
             },
             "active": true,
             "checkin_attention": false,
+            "checkin_text": null,
             "require_approval": false,
             "require_membership": false,
             "require_membership_hidden": false,
             "require_membership_types": [],
+            "all_sales_channels": false,
+            "limit_sales_channels": ["web"],
             "sales_channels": ["web"],
             "available_from": null,
+            "available_from_mode": "hide",
             "available_until": null,
+            "available_until_mode": "hide",
             "hide_without_voucher": false,
             "description": {
               "en": "Test2"
@@ -103,6 +125,7 @@ Endpoints
             "default_price": "223.00",
             "price": 223.0,
             "original_price": null,
+            "free_price_suggestion": null,
             "meta_data": {}
           },
           {
@@ -112,20 +135,32 @@ Endpoints
             },
             "active": true,
             "checkin_attention": false,
+            "checkin_text": null,
             "require_approval": false,
             "require_membership": false,
             "require_membership_hidden": false,
             "require_membership_types": [],
+            "all_sales_channels": false,
+            "limit_sales_channels": ["web"],
+            "sales_channels": ["web"],
+            "available_from": null,
+            "available_from_mode": "hide",
+            "available_until": null,
+            "available_until_mode": "hide",
+            "hide_without_voucher": false,
             "description": {},
             "position": 1,
-            "default_price": null,
-            "price": 15.0,
+            "default_price": "223.00",
+            "price": 223.0,
+            "original_price": null,
+            "free_price_suggestion": null,
             "meta_data": {}
           }
         ]
       }
 
    :query integer page: The page number in case of a multi-page result set, default is 1
+   :query string search: Filter the list by the value of the variation (substring search).
    :query boolean active: If set to ``true`` or ``false``, only items with this value for the field ``active`` will be
                           returned.
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -163,15 +198,21 @@ Endpoints
         "default_price": "10.00",
         "price": "10.00",
         "original_price": null,
+        "free_price_suggestion": null,
         "active": true,
         "checkin_attention": false,
+        "checkin_text": null,
         "require_approval": false,
         "require_membership": false,
         "require_membership_hidden": false,
         "require_membership_types": [],
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "available_from": null,
+        "available_from_mode": "hide",
         "available_until": null,
+        "available_until_mode": "hide",
         "hide_without_voucher": false,
         "description": null,
         "position": 0,
@@ -204,13 +245,17 @@ Endpoints
         "default_price": "10.00",
         "active": true,
         "checkin_attention": false,
+        "checkin_text": null,
         "require_approval": false,
         "require_membership": false,
         "require_membership_hidden": false,
         "require_membership_types": [],
-        "sales_channels": ["web"],
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "available_from": null,
+        "available_from_mode": "hide",
         "available_until": null,
+        "available_until_mode": "hide",
         "hide_without_voucher": false,
         "description": null,
         "position": 0,
@@ -231,15 +276,21 @@ Endpoints
         "default_price": "10.00",
         "price": "10.00",
         "original_price": null,
+        "free_price_suggestion": null,
         "active": true,
         "checkin_attention": false,
+        "checkin_text": null,
         "require_approval": false,
         "require_membership": false,
         "require_membership_hidden": false,
         "require_membership_types": [],
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "available_from": null,
+        "available_from_mode": "hide",
         "available_until": null,
+        "available_until_mode": "hide",
         "hide_without_voucher": false,
         "description": null,
         "position": 0,
@@ -291,15 +342,21 @@ Endpoints
         "default_price": "10.00",
         "price": "10.00",
         "original_price": null,
+        "free_price_suggestion": null,
         "active": false,
         "checkin_attention": false,
+        "checkin_text": null,
         "require_approval": false,
         "require_membership": false,
         "require_membership_hidden": false,
         "require_membership_types": [],
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "available_from": null,
+        "available_from_mode": "hide",
         "available_until": null,
+        "available_until_mode": "hide",
         "hide_without_voucher": false,
         "description": null,
         "position": 1,

doc/api/resources/items.rst

@@ -29,6 +29,8 @@ free_price                              boolean                    If ``true``,
                                                                    they buy the product (however, the price can't be set
                                                                    lower than the price defined by ``default_price`` or
                                                                    otherwise).
+free_price_suggestion                   money (string)             A suggested price, used as a default value if
+                                                                   ``free_price`` is set (or ``null``).
 tax_rate                                decimal (string)           The VAT rate to be applied for this item (read-only,
                                                                    set through ``tax_rule``).
 tax_rule                                integer                    The internal ID of the applied tax rule (or ``null``).
@@ -44,15 +46,33 @@ personalized                            boolean                    ``true`` for
 position                                integer                    An integer, used for sorting
 picture                                 file                       A product picture to be displayed in the shop
                                                                    (can be ``null``).
-sales_channels                          list of strings            Sales channels this product is available on, such as
-                                                                   ``"web"`` or ``"resellers"``. Defaults to ``["web"]``.
+all_sales_channels                      boolean                    If ``true`` (default), the item is available on all sales channels.
+limit_sales_channels                    list of strings            List of sales channel identifiers the item is available on
+                                                                   if ``all_sales_channels`` is ``false``.
+sales_channels                          list of strings            **DEPRECATED.** Legacy interface, use ``all_sales_channels``
+                                                                   and ``limit_sales_channels`` instead.
 available_from                          datetime                   The first date time at which this item can be bought
                                                                    (or ``null``).
+available_from_mode                     string                     If ``hide`` (the default), this item is hidden in the shop
+                                                                   if unavailable due to the ``available_from`` setting.
+                                                                   If ``info``, the item is visible, but can't be purchased,
+                                                                   and a note explaining the unavailability is displayed.
 available_until                         datetime                   The last date time at which this item can be bought
                                                                    (or ``null``).
-hidden_if_available                     integer                    The internal ID of a quota object, or ``null``. If
+available_until_mode                    string                     If ``hide`` (the default), this item is hidden in the shop
+                                                                   if unavailable due to the ``available_until`` setting.
+                                                                   If ``info``, the item is visible, but can't be purchased,
+                                                                   and a note explaining the unavailability is displayed.
+hidden_if_available                     integer                    **DEPRECATED** The internal ID of a quota object, or ``null``. If
                                                                    set, this item won't be shown publicly as long as this
                                                                    quota is available.
+hidden_if_item_available                integer                    The internal ID of a different item, or ``null``. If
+                                                                   set, this item won't be shown publicly as long as this
+                                                                   other item is available.
+hidden_if_item_available_mode           string                     If ``hide`` (the default), this item is hidden in the shop
+                                                                   if unavailable due to the ``hidden_if_item_available`` setting.
+                                                                   If ``info``, the item is visible, but can't be purchased,
+                                                                   and a note explaining the unavailability is displayed.
 require_voucher                         boolean                    If ``true``, this item can only be bought using a
                                                                    voucher that is specifically assigned to this item.
 hide_without_voucher                    boolean                    If ``true``, this item is only shown during the voucher
@@ -69,6 +89,8 @@ max_per_order                           integer                    This product
 checkin_attention                       boolean                    If ``true``, the check-in app should show a warning
                                                                    that this ticket requires special attention if such
                                                                    a product is being scanned.
+checkin_text                            string                     Text that will be shown if a ticket of this type is
+                                                                   scanned (or ``null``).
 original_price                          money (string)             An original price, shown for comparison, not used
                                                                    for price calculations (or ``null``).
 require_approval                        boolean                    If ``true``, orders with this product will need to be
@@ -117,12 +139,18 @@ has_variations                          boolean                    Shows whether
 variations                              list of objects            A list with one object for each variation of this item.
                                                                    Can be empty. Only writable during creation,
                                                                    use separate endpoint to modify this later.
+program_times                           list of objects            A list with one object for each program time of this item.
+                                                                   Can be empty. Only writable during creation,
+                                                                   use separate endpoint to modify this later.
+                                                                   Not available for items in event series.
 ├ id                                    integer                    Internal ID of the variation
 ├ value                                 multi-lingual string       The "name" of the variation
 ├ default_price                         money (string)             The price set directly for this variation or ``null``
 ├ price                                 money (string)             The price used for this variation. This is either the
                                                                    same as ``default_price`` if that value is set or equal
                                                                    to the item's ``default_price``.
+├ free_price_suggestion                 money (string)             A suggested price, used as a default value if
+                                                                   ``free_price`` is set (or ``null``).
 ├ original_price                        money (string)             An original price, shown for comparison, not used
                                                                    for price calculations (or ``null``).
 ├ active                                boolean                    If ``false``, this variation will not be sold or shown.
@@ -130,6 +158,8 @@ variations                              list of objects            A list with o
 ├ checkin_attention                     boolean                    If ``true``, the check-in app should show a warning
                                                                    that this ticket requires special attention if such
                                                                    a variation is being scanned.
+├ checkin_text                          string                     Text that will be shown if a ticket of this type is
+                                                                   scanned (or ``null``).
 ├ require_approval                      boolean                    If ``true``, orders with this variation will need to be
                                                                    approved by the event organizer before they can be
                                                                    paid.
@@ -138,15 +168,26 @@ variations                              list of objects            A list with o
                                                                    be hidden from users without a valid membership.
 ├ require_membership_types              list of integers           Internal IDs of membership types valid if ``require_membership`` is ``true``
                                                                    Markdown syntax or can be ``null``.
-├ sales_channels                        list of strings            Sales channels this variation is available on, such as
-                                                                   ``"web"`` or ``"resellers"``. Defaults to all existing sales channels.
+├ all_sales_channels                    boolean                    If ``true`` (default), the variation is available on all sales channels.
+├ limit_sales_channels                  list of strings            List of sales channel identifiers the variation is available on
+                                                                   if ``all_sales_channels`` is ``false``.
                                                                    The item-level list takes precedence, i.e. a sales
-                                                                   channel needs to be on both lists for the item to be
-                                                                   available.
+                                                                   channel needs to be on both lists for the variation to be
+                                                                   available (unless ``all_sales_channels`` is used).
+├ sales_channels                        list of strings            **DEPRECATED.** Legacy interface, use ``all_sales_channels``
+                                                                   and ``limit_sales_channels`` instead.
 ├ available_from                        datetime                   The first date time at which this variation can be bought
                                                                    (or ``null``).
+├ available_from_mode                   string                     If ``hide`` (the default), this variation is hidden in the shop
+                                                                   if unavailable due to the ``available_from`` setting.
+                                                                   If ``info``, the variation is visible, but can't be purchased,
+                                                                   and a note explaining the unavailability is displayed.
 ├ available_until                       datetime                   The last date time at which this variation can be bought
                                                                    (or ``null``).
+├ available_until_mode                  string                     If ``hide`` (the default), this variation is hidden in the shop
+                                                                   if unavailable due to the ``available_until`` setting.
+                                                                   If ``info``, the variation is visible, but can't be purchased,
+                                                                   and a note explaining the unavailability is displayed.
 ├ hide_without_voucher                  boolean                    If ``true``, this variation is only shown during the voucher
                                                                    redemption process, but not in the normal shop
                                                                    frontend.
@@ -174,27 +215,23 @@ bundles                                 list of objects            Definition of
 meta_data                               object                     Values set for event-specific meta data parameters.
 ======================================= ========================== =======================================================
 
-.. versionchanged:: 4.0
+.. versionchanged:: 2023.10
 
-   The attributes ``require_membership``, ``require_membership_types``, ``grant_membership_type``, ``grant_membership_duration_like_event``,
-    ``grant_membership_duration_days`` and ``grant_membership_duration_months`` have been added.
+   The ``checkin_text`` and ``variations[x].checkin_text`` attributes have been added.
+   The ``free_price_suggestion`` and ``variations[x].free_price_suggestion`` attributes have been added.
 
-.. versionchanged:: 4.4
+.. versionchanged:: 2023.10
 
-   The attributes ``require_membership_hidden`` attribute has been added.
+   The ``hidden_if_item_available`` attributes has been added, the ``hidden_if_available`` attribute has been
+   deprecated.
 
-.. versionchanged:: 4.16
+.. versionchanged:: 2025.01
 
-   The ``variations[x].meta_data`` and ``variations[x].checkin_attention`` attributes have been added.
-   The ``personalized`` attribute has been added.
+   The ``hidden_if_item_available_mode`` attributes has been added.
 
-.. versionchanged:: 4.17
+.. versionchanged:: 2025.9
 
-   The ``validity_*`` attributes have been added.
-
-.. versionchanged:: 4.18
-
-   The ``media_policy`` and ``media_type`` attributes have been added.
+   The ``program_times`` attribute has been added.
 
 Notes
 -----
@@ -203,9 +240,11 @@ Please note that an item either always has variations or never has. Once created
 change to an item without and vice versa. To create an item with variations ensure that you POST an item with at least
 one variation.
 
-Also note that ``variations``, ``bundles``, and  ``addons`` are only supported on ``POST``. To update/delete variations,
-bundles, and add-ons please use the dedicated nested endpoints. By design this endpoint does not support ``PATCH`` and ``PUT``
-with nested ``variations``, ``bundles`` and/or ``addons``.
+Also note that ``variations``, ``bundles``, ``addons`` and  ``program_times`` are only supported on ``POST``. To update/delete variations,
+bundles, add-ons and program times please use the dedicated nested endpoints. By design this endpoint does not support ``PATCH`` and ``PUT``
+with nested ``variations``, ``bundles``, ``addons`` and/or ``program_times``.
+
+``program_times`` is not available to items in event series.
 
 Endpoints
 ---------
@@ -239,6 +278,8 @@ Endpoints
             "id": 1,
             "name": {"en": "Standard ticket"},
             "internal_name": "",
+            "all_sales_channels": false,
+            "limit_sales_channels": ["web"],
             "sales_channels": ["web"],
             "default_price": "23.00",
             "original_price": null,
@@ -246,6 +287,7 @@ Endpoints
             "active": true,
             "description": null,
             "free_price": false,
+            "free_price_suggestion": null,
             "tax_rate": "0.00",
             "tax_rule": 1,
             "admission": false,
@@ -257,14 +299,19 @@ Endpoints
             "position": 0,
             "picture": null,
             "available_from": null,
+            "available_from_mode": "hide",
             "available_until": null,
+            "available_until_mode": "hide",
             "hidden_if_available": null,
+            "hidden_if_item_available": null,
+            "hidden_if_item_available_mode": "hide",
             "require_voucher": false,
             "hide_without_voucher": false,
             "allow_cancel": true,
             "min_per_order": null,
             "max_per_order": null,
             "checkin_attention": false,
+            "checkin_text": null,
             "has_variations": false,
             "generate_tickets": null,
             "allow_waitinglist": true,
@@ -291,14 +338,20 @@ Endpoints
                  "default_price": "10.00",
                  "price": "10.00",
                  "original_price": null,
+                 "free_price_suggestion": null,
                  "active": true,
                  "checkin_attention": false,
+                 "checkin_text": null,
                  "require_approval": false,
                  "require_membership": false,
                  "require_membership_types": [],
+                 "all_sales_channels": false,
+                 "limit_sales_channels": ["web"],
                  "sales_channels": ["web"],
                  "available_from": null,
+                 "available_from_mode": "hide",
                  "available_until": null,
+                 "available_until_mode": "hide",
                  "hide_without_voucher": false,
                  "description": null,
                  "meta_data": {},
@@ -309,14 +362,20 @@ Endpoints
                  "default_price": null,
                  "price": "23.00",
                  "original_price": null,
+                 "free_price_suggestion": null,
                  "active": true,
                  "checkin_attention": false,
+                 "checkin_text": null,
                  "require_approval": false,
                  "require_membership": false,
                  "require_membership_types": [],
+                 "all_sales_channels": false,
+                 "limit_sales_channels": ["web"],
                  "sales_channels": ["web"],
                  "available_from": null,
+                 "available_from_mode": "hide",
                  "available_until": null,
+                 "available_until_mode": "hide",
                  "hide_without_voucher": false,
                  "description": null,
                  "meta_data": {},
@@ -324,12 +383,14 @@ Endpoints
               }
             ],
             "addons": [],
-            "bundles": []
+            "bundles": [],
+            "program_times": []
           }
         ]
       }
 
    :query integer page: The page number in case of a multi-page result set, default is 1
+   :query string search: Filter the list by internal name or name of the item (substring search).
    :query boolean active: If set to ``true`` or ``false``, only items with this value for the field ``active`` will be
                           returned.
    :query integer category: If set to the ID of a category, only items within that category will be returned.
@@ -370,6 +431,8 @@ Endpoints
         "id": 1,
         "name": {"en": "Standard ticket"},
         "internal_name": "",
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "default_price": "23.00",
         "original_price": null,
@@ -377,6 +440,7 @@ Endpoints
         "active": true,
         "description": null,
         "free_price": false,
+        "free_price_suggestion": null,
         "tax_rate": "0.00",
         "tax_rule": 1,
         "admission": false,
@@ -388,8 +452,12 @@ Endpoints
         "position": 0,
         "picture": null,
         "available_from": null,
+        "available_from_mode": "hide",
         "available_until": null,
+        "available_until_mode": "hide",
         "hidden_if_available": null,
+        "hidden_if_item_available": null,
+        "hidden_if_item_available_mode": "hide",
         "require_voucher": false,
         "hide_without_voucher": false,
         "allow_cancel": true,
@@ -399,6 +467,7 @@ Endpoints
         "min_per_order": null,
         "max_per_order": null,
         "checkin_attention": false,
+        "checkin_text": null,
         "has_variations": false,
         "require_approval": false,
         "require_bundling": false,
@@ -422,15 +491,21 @@ Endpoints
              "default_price": "10.00",
              "price": "10.00",
              "original_price": null,
+             "free_price_suggestion": null,
              "active": true,
              "checkin_attention": false,
+             "checkin_text": null,
              "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
              "description": null,
+             "all_sales_channels": false,
+             "limit_sales_channels": ["web"],
              "sales_channels": ["web"],
              "available_from": null,
+             "available_from_mode": "hide",
              "available_until": null,
+             "available_until_mode": "hide",
              "hide_without_voucher": false,
              "meta_data": {},
              "position": 0
@@ -440,14 +515,20 @@ Endpoints
              "default_price": null,
              "price": "23.00",
              "original_price": null,
+             "free_price_suggestion": null,
              "active": true,
              "checkin_attention": false,
+             "checkin_text": null,
              "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
+             "all_sales_channels": false,
+             "limit_sales_channels": ["web"],
              "sales_channels": ["web"],
              "available_from": null,
+             "available_from_mode": "hide",
              "available_until": null,
+             "available_until_mode": "hide",
              "hide_without_voucher": false,
              "description": null,
              "meta_data": {},
@@ -455,7 +536,8 @@ Endpoints
           }
         ],
         "addons": [],
-        "bundles": []
+        "bundles": [],
+        "program_times": []
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -482,13 +564,15 @@ Endpoints
         "id": 1,
         "name": {"en": "Standard ticket"},
         "internal_name": "",
-        "sales_channels": ["web"],
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "default_price": "23.00",
         "original_price": null,
         "category": null,
         "active": true,
         "description": null,
         "free_price": false,
+        "free_price_suggestion": null,
         "tax_rate": "0.00",
         "tax_rule": 1,
         "admission": false,
@@ -500,8 +584,12 @@ Endpoints
         "position": 0,
         "picture": null,
         "available_from": null,
+        "available_from_mode": "hide",
         "available_until": null,
+        "available_until_mode": "hide",
         "hidden_if_available": null,
+        "hidden_if_item_available": null,
+        "hidden_if_item_available_mode": "hide",
         "require_voucher": false,
         "hide_without_voucher": false,
         "allow_cancel": true,
@@ -511,6 +599,7 @@ Endpoints
         "min_per_order": null,
         "max_per_order": null,
         "checkin_attention": false,
+        "checkin_text": null,
         "require_approval": false,
         "require_bundling": false,
         "require_membership": false,
@@ -533,14 +622,19 @@ Endpoints
              "default_price": "10.00",
              "price": "10.00",
              "original_price": null,
+             "free_price_suggestion": null,
              "active": true,
              "checkin_attention": false,
+             "checkin_text": null,
              "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
-             "sales_channels": ["web"],
+             "all_sales_channels": false,
+             "limit_sales_channels": ["web"],
              "available_from": null,
+             "available_from_mode": "hide",
              "available_until": null,
+             "available_until_mode": "hide",
              "hide_without_voucher": false,
              "description": null,
              "meta_data": {},
@@ -551,14 +645,19 @@ Endpoints
              "default_price": null,
              "price": "23.00",
              "original_price": null,
+             "free_price_suggestion": null,
              "active": true,
              "checkin_attention": false,
+             "checkin_text": null,
              "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
-             "sales_channels": ["web"],
+             "all_sales_channels": false,
+             "limit_sales_channels": ["web"],
              "available_from": null,
+             "available_from_mode": "hide",
              "available_until": null,
+             "available_until_mode": "hide",
              "hide_without_voucher": false,
              "description": null,
              "meta_data": {},
@@ -566,7 +665,13 @@ Endpoints
           }
         ],
         "addons": [],
-        "bundles": []
+        "bundles": [],
+        "program_times": [
+          {
+            "start": "2025-08-14T22:00:00Z",
+            "end": "2025-08-15T00:00:00Z"
+          }
+        ]
       }
 
    **Example response**:
@@ -581,6 +686,8 @@ Endpoints
         "id": 1,
         "name": {"en": "Standard ticket"},
         "internal_name": "",
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "default_price": "23.00",
         "original_price": null,
@@ -588,6 +695,7 @@ Endpoints
         "active": true,
         "description": null,
         "free_price": false,
+        "free_price_suggestion": null,
         "tax_rate": "0.00",
         "tax_rule": 1,
         "admission": false,
@@ -599,8 +707,12 @@ Endpoints
         "position": 0,
         "picture": null,
         "available_from": null,
+        "available_from_mode": "hide",
         "available_until": null,
+        "available_until_mode": "hide",
         "hidden_if_available": null,
+        "hidden_if_item_available": null,
+        "hidden_if_item_available_mode": "hide",
         "require_voucher": false,
         "hide_without_voucher": false,
         "allow_cancel": true,
@@ -610,6 +722,7 @@ Endpoints
         "allow_waitinglist": true,
         "show_quota_left": null,
         "checkin_attention": false,
+        "checkin_text": null,
         "has_variations": true,
         "require_approval": false,
         "require_bundling": false,
@@ -633,14 +746,20 @@ Endpoints
              "default_price": "10.00",
              "price": "10.00",
              "original_price": null,
+             "free_price_suggestion": null,
              "active": true,
              "checkin_attention": false,
+             "checkin_text": null,
              "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
+             "all_sales_channels": false,
+             "limit_sales_channels": ["web"],
              "sales_channels": ["web"],
              "available_from": null,
+             "available_from_mode": "hide",
              "available_until": null,
+             "available_until_mode": "hide",
              "hide_without_voucher": false,
              "description": null,
              "meta_data": {},
@@ -651,14 +770,20 @@ Endpoints
              "default_price": null,
              "price": "23.00",
              "original_price": null,
+             "free_price_suggestion": null,
              "active": true,
              "checkin_attention": false,
+             "checkin_text": null,
              "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
+             "all_sales_channels": false,
+             "limit_sales_channels": ["web"],
              "sales_channels": ["web"],
              "available_from": null,
+             "available_from_mode": "hide",
              "available_until": null,
+             "available_until_mode": "hide",
              "hide_without_voucher": false,
              "description": null,
              "meta_data": {},
@@ -666,7 +791,13 @@ Endpoints
           }
         ],
         "addons": [],
-        "bundles": []
+        "bundles": [],
+        "program_times": [
+          {
+            "start": "2025-08-14T22:00:00Z",
+            "end": "2025-08-15T00:00:00Z"
+          }
+        ]
       }
 
    :param organizer: The ``slug`` field of the organizer of the event to create an item for
@@ -682,8 +813,9 @@ Endpoints
    the resource, other fields will be reset to default. With ``PATCH``, you only need to provide the fields that you
    want to change.
 
-   You can change all fields of the resource except the ``has_variations``, ``variations`` and the ``addon`` field. If
-   you need to update/delete variations or add-ons please use the nested dedicated endpoints.
+   You can change all fields of the resource except the ``has_variations``, ``variations``, ``addon`` and the
+   ``program_times`` field. If you need to update/delete variations, add-ons or program times, please use the nested
+   dedicated endpoints.
 
    **Example request**:
 
@@ -712,6 +844,8 @@ Endpoints
         "id": 1,
         "name": {"en": "Ticket"},
         "internal_name": "",
+        "all_sales_channels": false,
+        "limit_sales_channels": ["web"],
         "sales_channels": ["web"],
         "default_price": "25.00",
         "original_price": null,
@@ -719,6 +853,7 @@ Endpoints
         "active": true,
         "description": null,
         "free_price": false,
+        "free_price_suggestion": null,
         "tax_rate": "0.00",
         "tax_rule": 1,
         "admission": false,
@@ -730,8 +865,12 @@ Endpoints
         "position": 0,
         "picture": null,
         "available_from": null,
+        "available_from_mode": "hide",
         "available_until": null,
+        "available_until_mode": "hide",
         "hidden_if_available": null,
+        "hidden_if_item_available": null,
+        "hidden_if_item_available_mode": "hide",
         "require_voucher": false,
         "hide_without_voucher": false,
         "generate_tickets": null,
@@ -741,6 +880,7 @@ Endpoints
         "min_per_order": null,
         "max_per_order": null,
         "checkin_attention": false,
+        "checkin_text": null,
         "has_variations": true,
         "require_approval": false,
         "require_bundling": false,
@@ -764,14 +904,20 @@ Endpoints
              "default_price": "10.00",
              "price": "10.00",
              "original_price": null,
+             "free_price_suggestion": null,
              "active": true,
              "checkin_attention": false,
+             "checkin_text": null,
              "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
+             "all_sales_channels": false,
+             "limit_sales_channels": ["web"],
              "sales_channels": ["web"],
              "available_from": null,
+             "available_from_mode": "hide",
              "available_until": null,
+             "available_until_mode": "hide",
              "hide_without_voucher": false,
              "description": null,
              "meta_data": {},
@@ -782,14 +928,20 @@ Endpoints
              "default_price": null,
              "price": "23.00",
              "original_price": null,
+             "free_price_suggestion": null,
              "active": true,
              "checkin_attention": false,
+             "checkin_text": null,
              "require_approval": false,
              "require_membership": false,
              "require_membership_types": [],
+             "all_sales_channels": false,
+             "limit_sales_channels": ["web"],
              "sales_channels": ["web"],
              "available_from": null,
+             "available_from_mode": "hide",
              "available_until": null,
+             "available_until_mode": "hide",
              "hide_without_voucher": false,
              "description": null,
              "meta_data": {},
@@ -797,7 +949,8 @@ Endpoints
           }
         ],
         "addons": [],
-        "bundles": []
+        "bundles": [],
+        "program_times": []
       }
 
    :param organizer: The ``slug`` field of the organizer to modify

doc/api/resources/offlinesales.rst

@@ -0,0 +1,219 @@
+Offline sales
+=============
+
+.. note:: This API is only available when the plugin **pretix-offlinesales** is installed (pretix Hosted and Enterprise only).
+
+The offline sales module allows you to create batches of tickets intended for the sale outside the system.
+
+Resource description
+--------------------
+
+The offline sales batch resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal batch ID
+creation                              datetime                   Time of creation
+testmode                              boolean                    ``true`` if orders are created in test mode
+sales_channel                         string                     Sales channel of the orders
+layout                                integer                    Internal ID of the chosen ticket layout
+subevent                              integer                    Internal ID of the chosen subevent (or ``null``)
+item                                  integer                    Internal ID of the chosen product
+variation                             integer                    Internal ID of the chosen variation (or ``null``)
+amount                                integer                    Number of tickets in the batch
+comment                               string                     Internal comment
+orders                                list of strings            List of order codes (omitted in list view for performance reasons)
+===================================== ========================== =======================================================
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/offlinesalesbatches/
+
+   Returns a list of all offline sales batches
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/democon/offlinesalesbatches/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: text/javascript
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "id": 1,
+            "creation": "2025-07-08T18:27:32.134368+02:00",
+            "testmode": False,
+            "sales_channel": "web",
+            "comment": "Batch for sale at the event",
+            "layout": 3,
+            "subevent": null,
+            "item": 23,
+            "variation": null,
+            "amount": 7
+          }
+        ]
+      }
+
+   :query page: The page number in case of a multi-page result set, default is 1
+   :param organizer: The ``slug`` field of a valid organizer
+   :param event: The ``slug`` field of a valid event
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view it.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/offlinesalesbatches/(id)/
+
+   Returns information on a given batch.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/democon/offlinesalesbatches/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: text/javascript
+
+      {
+        "id": 1,
+        "creation": "2025-07-08T18:27:32.134368+02:00",
+        "testmode": False,
+        "sales_channel": "web",
+        "comment": "Batch for sale at the event",
+        "layout": 3,
+        "subevent": null,
+        "item": 23,
+        "variation": null,
+        "amount": 7,
+        "orders": ["TSRNN", "3FBSL", "WMDNJ", "BHW9H", "MXSUG", "DSDAP", "URLLE"]
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param id: The ``id`` field of the batch to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view it.
+
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/offlinesalesbatches/
+
+   With this API call, you can instruct the system to create a new batch.
+
+   Since batches can contain up to 10,000 tickets, they are created asynchronously on the server.
+   If your input parameters validate correctly, a ``202 Accepted`` status code is returned.
+   The body points you to the check URL of the result. Running a ``GET`` request on that result URL will
+   yield one of the following status codes:
+
+    * ``200 OK`` – The creation of the batch has succeeded. The body will be your resulting batch with the same information as in the detail endpoint above.
+    * ``409 Conflict`` – Your creation job is still running. The body will be JSON with the structure ``{"status": "running"}``. ``status`` can be ``waiting`` before the task is actually being processed. Please retry, but wait at least one second before you do.
+    * ``410 Gone`` – Creating the batch has failed permanently (e.g. quota no longer available). The body will be JSON with the structure ``{"status": "failed", "message": "Error message"}``
+    * ``404 Not Found`` – The job does not exist / is expired.
+
+   .. note:: To avoid performance issues, a maximum amount of 10000 is currently allowed.
+
+   .. note:: Do not wait multiple hours or more to retrieve your result. After a longer wait time, ``409`` might be returned permanently due to technical constraints, even though nothing will happen any more.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/offlinesalesbatches/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "testmode": True,
+        "layout": 123,
+        "item": 14,
+        "sales_channel": "web",
+        "amount": 10,
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "check": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/offlinesalesbatches/check/29891ede-196f-4942-9e26-d055a36e98b8/"
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :statuscode 202: no error
+   :statuscode 400: Invalid input options
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/offlinesalesbatches/(id)/render/
+
+   With this API call, you can render the PDF representation of a batch.
+
+   Since batches can contain up to 10,000 tickets, they are rendered asynchronously on the server.
+   If your input parameters validate correctly, a ``202 Accepted`` status code is returned.
+   The body points you to the download URL of the result. Running a ``GET`` request on that result URL will
+   yield one of the following status codes:
+
+    * ``200 OK`` – The creation of the batch has succeeded. The body will be your resulting batch with the same information as in the detail endpoint above.
+    * ``409 Conflict`` – Your rendering process is still running. The body will be JSON with the structure ``{"status": "running"}``. ``status`` can be ``waiting`` before the task is actually being processed. Please retry, but wait at least one second before you do.
+    * ``410 Gone`` – Rendering the batch has failed permanently. The body will be JSON with the structure ``{"status": "failed", "message": "Error message"}``
+    * ``404 Not Found`` – The rendering job does not exist / is expired.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/offlinesalesbatches/1/render HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "download": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/offlinesalesbatches/1/download/29891ede-196f-4942-9e26-d055a36e98b8/3f279f13-c198-4137-b49b-9b360ce9fcce/"
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param id: The ``id`` field of the batch to fetch
+   :statuscode 202: no error
+   :statuscode 400: Invalid input options
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+

doc/api/resources/orders.rst

@@ -20,6 +20,7 @@ The order resource contains the following public fields:
 Field                                 Type                       Description
 ===================================== ========================== =======================================================
 code                                  string                     Order code
+event                                 string                     The slug of the parent event
 status                                string                     Order status, one of:
 
                                                                  * ``n`` – pending
@@ -40,11 +41,16 @@ expires                               datetime                   The order will
 payment_date                          date                       **DEPRECATED AND INACCURATE** Date of payment receipt
 payment_provider                      string                     **DEPRECATED AND INACCURATE** Payment provider used for this order
 total                                 money (string)             Total value of this order
+tax_rounding_mode                     string                     Tax rounding mode, see :ref:`algorithms-rounding`
 comment                               string                     Internal comment on this order
+api_meta                              object                     Meta data for that order. Only available through API, no guarantees
+                                                                 on the content structure. You can use this to save references to your system.
 custom_followup_at                    date                       Internal date for a custom follow-up action
 checkin_attention                     boolean                    If ``true``, the check-in app should show a warning
                                                                  that this ticket requires special attention if a ticket
                                                                  of this order is scanned.
+checkin_text                          string                     Text that will be shown if a ticket of this order is
+                                                                 scanned (or ``null``).
 invoice_address                       object                     Invoice address information (can be ``null``)
 ├ last_modified                       datetime                   Last modification date of the address
 ├ company                             string                     Customer company name
@@ -60,18 +66,24 @@ invoice_address                       object                     Invoice address
 ├ state                               string                     Customer state (ISO 3166-2 code). Only supported in
                                                                  AU, BR, CA, CN, MY, MX, and US.
 ├ internal_reference                  string                     Customer's internal reference to be printed on the invoice
+
 ├ custom_field                        string                     Custom invoice address field
 ├ vat_id                              string                     Customer VAT ID
-└ vat_id_validated                    string                     ``true``, if the VAT ID has been validated against the
+├ vat_id_validated                    string                     ``true``, if the VAT ID has been validated against the
                                                                  EU VAT service and validation was successful. This only
                                                                  happens in rare cases.
+├ transmission_type                   string                     Transmission channel for invoice (see also :ref:`rest-transmission-types`).
+                                                                 Defaults to ``email``.
+└ transmission_info                   object                     Transmission-channel specific information (or ``null``).
+                                                                 See also :ref:`rest-transmission-types`.
 positions                             list of objects            List of order positions (see below). By default, only
                                                                  non-canceled positions are included.
 fees                                  list of objects            List of fees included in the order total. By default, only
                                                                  non-canceled fees are included.
 ├ id                                  integer                    Internal ID of the fee record
-├ fee_type                            string                     Type of fee (currently ``payment``, ``passbook``,
-                                                                 ``other``)
+├ fee_type                            string                     Type of fee (currently ``payment``, ``shipping``,
+                                                                 ``service``, ``cancellation``, ``insurance``, ``late``,
+                                                                 ``other``, ``giftcard``)
 ├ value                               money (string)             Fee amount
 ├ description                         string                     Human-readable string with more details (can be empty)
 ├ internal_type                       string                     Internal string (i.e. ID of the payment provider),
@@ -79,6 +91,7 @@ fees                                  list of objects            List of fees in
 ├ tax_rate                            decimal (string)           VAT rate applied for this fee
 ├ tax_value                           money (string)             VAT included in this fee
 ├ tax_rule                            integer                    The ID of the used tax rule (or ``null``)
+├ tax_code                            string                     Codified reason for tax rate (or ``null``), see :ref:`rest-taxcodes`.
 └ canceled                            boolean                    Whether or not this fee has been canceled.
 downloads                             list of objects            List of ticket download options for order-wise ticket
                                                                  downloading. This might be a multi-page PDF or a ZIP
@@ -99,37 +112,49 @@ url                                   string                     The full URL to
 payments                              list of objects            List of payment processes (see below)
 refunds                               list of objects            List of refund processes (see below)
 last_modified                         datetime                   Last modification of this object
+cancellation_date                     datetime                   Time of order cancellation (or ``null``). **Note**:
+                                                                 Will not be set for partial cancellations and is not
+                                                                 reliable for orders that have been cancelled,
+                                                                 reactivated and cancelled again.
+plugin_data                           object                     Additional data added by plugins.
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 4.0
+.. versionchanged:: 2023.8
 
-   The ``customer`` attribute has been added.
+   The ``event`` attribute has been added. The organizer-level endpoint has been added.
 
-.. versionchanged:: 4.1
+.. versionchanged:: 2023.9
 
-   The ``custom_followup_at`` attribute has been added.
+   The ``customer`` query parameter has been added.
 
-.. versionchanged:: 4.4
+.. versionchanged:: 2023.10
 
-   The ``item`` and ``variation`` query parameters have been added.
+   The ``checkin_text`` attribute has been added.
 
-.. versionchanged:: 4.6
+.. versionchanged:: 2024.1
 
-   The ``subevent`` query parameters has been added.
+   The ``expires`` attribute can now be passed during order creation.
 
-.. versionchanged:: 4.8
+.. versionchanged:: 2024.11
 
-   The ``order.fees.id`` attribute has been added.
+   The ``cancellation_date`` attribute has been added and can also be used as an ordering key.
 
-.. versionchanged:: 4.15
+.. versionchanged:: 2025.1
 
-   The ``include`` query parameter has been added.
+   The ``tax_code`` attribute has been added.
 
-.. versionchanged:: 4.16
+.. versionchanged:: 2025.2
 
-   The ``valid_if_pending`` attribute has been added.
+   The ``plugin_data`` attribute has been added.
 
+.. versionchanged:: 2025.6
+
+   The ``invoice_address.transmission_type`` and ``invoice_address.transmission_info`` attributes have been added.
+
+.. versionchanged:: 2025.10
+
+   The ``tax_rounding_mode`` attribute has been added.
 
 .. _order-position-resource:
 
@@ -160,8 +185,14 @@ country                               string                     Attendee countr
 state                                 string                     Attendee state (ISO 3166-2 code). Only supported in
                                                                  AU, BR, CA, CN, MY, MX, and US, otherwise ``null``.
 voucher                               integer                    Internal ID of the voucher used for this position (or ``null``)
+voucher_budget_use                    money (string)             Amount of money discounted by the voucher, corresponding
+                                                                 to how much of the ``budget`` of the voucher is consumed.
+                                                                 **Important:** Do not rely on this amount to be a useful
+                                                                 value if the position's price, product or voucher
+                                                                 are changed *after* the order was created. Can be ``null``.
 tax_rate                              decimal (string)           VAT rate applied for this position
 tax_value                             money (string)             VAT included in this position
+tax_code                              string                     Codified reason for tax rate (or ``null``), see :ref:`rest-taxcodes`.
 tax_rule                              integer                    The ID of the used tax rule (or ``null``)
 secret                                string                     Secret code printed on the tickets for validation
 addon_to                              integer                    Internal ID of the position this position is an add-on for (or ``null``)
@@ -177,8 +208,20 @@ checkins                              list of objects            List of **succe
 ├ datetime                            datetime                   Time of check-in
 ├ type                                string                     Type of scan (defaults to ``entry``)
 ├ gate                                integer                    Internal ID of the gate. Can be ``null``.
-├ device                              integer                    Internal ID of the device. Can be ``null``.
+├ device                              integer                    Internal ID of the device. Can be ``null``. **Deprecated**, since this ID is not otherwise used in the API and is therefore not very useful.
+├ device_id                           integer                    Attribute ``device_id`` of the device. Can be ``null``.
 └ auto_checked_in                     boolean                    Indicates if this check-in been performed automatically by the system
+print_logs                            list of objects            List of print jobs recorded e.g. by the pretix apps
+├ id                                  integer                    Internal ID of the print job
+├ successful                          boolean                    Whether the print job successfully resulted in a print.
+                                                                 This is not expected to be 100 % reliable information (since
+                                                                 printer feedback is never perfect) and there is no guarantee
+                                                                 that unsuccessful jobs will be logged.
+├ device_id                           integer                    Attribute ``device_id`` of the device that recorded the print. Can be ``null``.
+├ datetime                            datetime                   Time of printing
+├ source                              string                     Source of print job, e.g. name of the app used.
+├ type                                string                     Type of print (currently ``badge``, ``ticket``, ``certificate``, or ``other``)
+└ info                                object                     Additional data with client-dependent structure.
 downloads                             list of objects            List of ticket download options
 ├ output                              string                     Ticket output provider (e.g. ``pdf``, ``passbook``)
 └ url                                 string                     Download URL
@@ -191,15 +234,29 @@ answers                               list of objects            Answers to user
 seat                                  objects                    The assigned seat. Can be ``null``.
 ├ id                                  integer                    Internal ID of the seat instance
 ├ name                                string                     Human-readable seat name
+├ zone_name                           string                     Name of the zone the seat is in
+├ row_name                            string                     Name/number of the row the seat is in
+├ row_label                           string                     Additional label of the row (or ``null``)
+├ seat_number                         string                     Number of the seat within the row
+├ seat_label                          string                     Additional label of the seat (or ``null``)
 └ seat_guid                           string                     Identifier of the seat within the seating plan
 pdf_data                              object                     Data object required for ticket PDF generation. By default,
                                                                  this field is missing. It will be added only if you add the
                                                                  ``pdf_data=true`` query parameter to your request.
+plugin_data                           object                     Additional data added by plugins.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.16
+.. versionchanged:: 2024.9
 
-   The attributes ``blocked``, ``valid_from`` and ``valid_until`` have been added.
+   The attribute ``print_logs`` has been added.
+
+.. versionchanged:: 2025.1
+
+   The ``tax_code`` attribute has been added.
+
+.. versionchanged:: 2025.2
+
+   The ``plugin_data`` attribute has been added.
 
 .. _order-payment-resource:
 
@@ -289,6 +346,7 @@ List of all orders
         "results": [
           {
             "code": "ABC12",
+            "event": "sampleconf",
             "status": "p",
             "testmode": false,
             "secret": "k24fiuwvu8kxz3y1",
@@ -305,9 +363,11 @@ List of all orders
             "payment_provider": "banktransfer",
             "fees": [],
             "total": "23.00",
+            "tax_rounding_mode": "line",
             "comment": "",
             "custom_followup_at": null,
             "checkin_attention": false,
+            "checkin_text": null,
             "require_approval": false,
             "valid_if_pending": false,
             "invoice_address": {
@@ -323,7 +383,9 @@ List of all orders
                 "state": "",
                 "internal_reference": "",
                 "vat_id": "EU123456789",
-                "vat_id_validated": false
+                "vat_id_validated": false,
+                "transmission_type": "email",
+                "transmission_info": {}
             },
             "positions": [
               {
@@ -346,9 +408,11 @@ List of all orders
                 "country": "DE",
                 "state": null,
                 "voucher": null,
+                "voucher_budget_use": null,
                 "tax_rate": "0.00",
                 "tax_value": "0.00",
                 "tax_rule": null,
+                "tax_code": null,
                 "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
                 "addon_to": null,
                 "subevent": null,
@@ -360,14 +424,26 @@ List of all orders
                 "seat": null,
                 "checkins": [
                   {
+                    "id": 1337,
                     "list": 44,
                     "type": "entry",
                     "gate": null,
                     "device": 2,
+                    "device_id": 1,
                     "datetime": "2017-12-25T12:45:23Z",
                     "auto_checked_in": false
                   }
                 ],
+                "print_logs": [
+                  {
+                    "id": 1,
+                    "type": "badge",
+                    "datetime": "2017-12-25T12:45:23Z",
+                    "device_id": 1,
+                    "source": "pretixSCAN",
+                    "info": {}
+                  }
+                ],
                 "answers": [
                   {
                     "question": 12,
@@ -382,7 +458,8 @@ List of all orders
                     "output": "pdf",
                     "url": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/pdf/"
                   }
-                ]
+                ],
+                "plugin_data": {}
               }
             ],
             "downloads": [
@@ -403,17 +480,20 @@ List of all orders
                 "provider": "banktransfer"
               }
             ],
-            "refunds": []
+            "refunds": [],
+            "cancellation_date": null,
+            "plugin_data": {}
           }
         ]
       }
 
    :query integer page: The page number in case of a multi-page result set, default is 1
    :query string ordering: Manually set the ordering of results. Valid fields to be used are ``datetime``, ``code``,
-                           ``last_modified``, and ``status``. Default: ``datetime``
+                           ``last_modified``, ``status`` and ``cancellation_date``. Default: ``datetime``
    :query string code: Only return orders that match the given order code
    :query string status: Only return orders in the given order status (see above)
    :query string search: Only return orders matching a given search query (matching for names, email addresses, and company names)
+   :query string customer: Only show orders linked to the given customer.
    :query integer item: Only return orders with a position that contains this item ID. *Warning:* Result will also include orders if they contain mixed items, and it will even return orders where the item is only contained in a canceled position.
    :query integer variation: Only return orders with a position that contains this variation ID. *Warning:* Result will also include orders if they contain mixed items and variations, and it will even return orders where the variation is only contained in a canceled position.
    :query boolean testmode: Only return orders with ``testmode`` set to ``true`` or ``false``
@@ -427,10 +507,13 @@ List of all orders
    :query datetime modified_since: Only return orders that have changed since the given date. Be careful: We only
        recommend using this in combination with ``testmode=false``, since test mode orders can vanish at any time and
        you will not notice it using this method.
-   :query datetime created_since: Only return orders that have been created since the given date.
+   :query datetime created_since: Only return orders that have been created since the given date (inclusive).
+   :query datetime created_before: Only return orders that have been created before the given date (exclusive).
    :query integer subevent: Only return orders with a position that contains this subevent ID. *Warning:* Result will also include orders if they contain mixed subevents, and it will even return orders where the subevent is only contained in a canceled position.
    :query datetime subevent_after: Only return orders that contain a ticket for a subevent taking place after the given date. This is an exclusive after, and it considers the **end** of the subevent (or its start, if the end is not set).
    :query datetime subevent_before: Only return orders that contain a ticket for a subevent taking place after the given date. This is an exclusive before, and it considers the **start** of the subevent.
+   :query string sales_channel: Only return orders with the given sales channel identifier (e.g. ``"web"``).
+   :query string payment_provider: Only return orders that contain a payment using the given payment provider. Note that this also searches for partial incomplete, or failed payments within the order and is not useful to get a sum of payment amounts without further processing.
    :query string exclude: Exclude a field from the output, e.g. ``fees`` or ``positions.downloads``. Can be used as a performance optimization. Can be passed multiple times.
    :query string include: Include only the given field in the output, e.g. ``fees`` or ``positions.downloads``. Can be used as a performance optimization. Can be passed multiple times. ``include`` is applied before ``exclude``, so ``exclude`` takes precedence.
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -441,6 +524,48 @@ List of all orders
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
 
+.. http:get:: /api/v1/organizers/(organizer)/orders/
+
+   Returns a list of all orders within all events of a given organizer (with sufficient access permissions).
+
+   Supported query parameters and output format of this endpoint are identical to the list endpoint within an event,
+   with the exception that the ``pdf_data`` parameter is not supported here.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/orders/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+      X-Page-Generated: 2017-12-01T10:00:00Z
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "code": "ABC12",
+            "event": "sampleconf",
+            ...
+          }
+        ]
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+
 Fetching individual orders
 --------------------------
 
@@ -466,6 +591,7 @@ Fetching individual orders
 
       {
         "code": "ABC12",
+        "event": "sampleconf",
         "status": "p",
         "testmode": false,
         "secret": "k24fiuwvu8kxz3y1",
@@ -482,9 +608,12 @@ Fetching individual orders
         "payment_provider": "banktransfer",
         "fees": [],
         "total": "23.00",
+        "tax_rounding_mode": "line",
         "comment": "",
+        "api_meta": {},
         "custom_followup_at": null,
         "checkin_attention": false,
+        "checkin_text": null,
         "require_approval": false,
         "valid_if_pending": false,
         "invoice_address": {
@@ -500,7 +629,9 @@ Fetching individual orders
             "state": "",
             "internal_reference": "",
             "vat_id": "EU123456789",
-            "vat_id_validated": false
+            "vat_id_validated": false,
+            "transmission_type": "email",
+            "transmission_info": {}
         },
         "positions": [
           {
@@ -523,9 +654,11 @@ Fetching individual orders
             "country": "DE",
             "state": null,
             "voucher": null,
+            "voucher_budget_use": null,
             "tax_rate": "0.00",
             "tax_rule": null,
             "tax_value": "0.00",
+            "tax_code": null,
             "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
             "addon_to": null,
             "subevent": null,
@@ -537,14 +670,27 @@ Fetching individual orders
             "seat": null,
             "checkins": [
               {
+                "id": 1337,
                 "list": 44,
                 "type": "entry",
                 "gate": null,
                 "device": 2,
+                "device_id": 1,
                 "datetime": "2017-12-25T12:45:23Z",
                 "auto_checked_in": false
               }
             ],
+            "print_logs": [
+              {
+                "id": 1,
+                "type": "badge",
+                "successful": true,
+                "datetime": "2017-12-25T12:45:23Z",
+                "device_id": 1,
+                "source": "pretixSCAN",
+                "info": {}
+              }
+            ],
             "answers": [
               {
                 "question": 12,
@@ -559,7 +705,8 @@ Fetching individual orders
                 "output": "pdf",
                 "url": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/pdf/"
               }
-            ]
+            ],
+            "plugin_data": {}
           }
         ],
         "downloads": [
@@ -580,7 +727,9 @@ Fetching individual orders
             "provider": "banktransfer"
           }
         ],
-        "refunds": []
+        "refunds": [],
+        "cancellation_date": null,
+        "plugin_data": {}
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -597,10 +746,6 @@ Fetching individual orders
 Order ticket download
 ---------------------
 
-.. versionchanged:: 4.10
-
-   The API now supports ticket downloads for pending orders if allowed by the event settings.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/download/(output)/
 
    Download tickets for an order, identified by its order code. Depending on the chosen output, the response might
@@ -655,16 +800,22 @@ Updating order fields
 
    * ``checkin_attention``
 
+   * ``checkin_text``
+
    * ``locale``
 
    * ``comment``
 
+   * ``api_meta``
+
    * ``custom_followup_at``
 
    * ``invoice_address`` (you always need to supply the full object, or ``null`` to delete the current address)
 
    * ``valid_if_pending``
 
+   * ``expires``
+
    **Example request**:
 
    .. sourcecode:: http
@@ -705,7 +856,7 @@ Generating new secrets
 
 .. http:post:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/regenerate_secrets/
 
-   Triggers generation of new ``secret`` attributes for both the order and all order positions.
+   Triggers generation of new ``secret`` and ``web_secret`` attributes for both the order and all order positions.
 
    **Example request**:
 
@@ -736,7 +887,7 @@ Generating new secrets
 
 .. http:post:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/regenerate_secrets/
 
-   Triggers generation of a new ``secret`` attribute for a single order position.
+   Triggers generation of a new ``secret`` and ``web_secret`` attribute for a single order position.
 
    **Example request**:
 
@@ -867,9 +1018,11 @@ Creating orders
      provider will not be called to do anything about this (i.e. if you pass a bank account to a debit provider, *no*
      charge will be created), this is just informative in case you *handled the payment already*.
    * ``payment_date`` (optional) – Date and time of the completion of the payment.
+   * ``tax_rounding_mode`` (optional)
    * ``comment`` (optional)
    * ``custom_followup_at`` (optional)
    * ``checkin_attention`` (optional)
+   * ``checkin_text`` (optional)
    * ``require_approval`` (optional)
    * ``valid_if_pending`` (optional)
    * ``invoice_address`` (optional)
@@ -885,8 +1038,10 @@ Creating orders
       * ``internal_reference``
       * ``vat_id``
       * ``vat_id_validated`` (optional) – If you need support for reverse charge (rarely the case), you need to check
-       yourself if the passed VAT ID is a valid EU VAT ID. In that case, set this to ``true``. Only valid VAT IDs will
-       trigger reverse charge taxation. Don't forget to set ``is_business`` as well!
+        yourself if the passed VAT ID is a valid EU VAT ID. In that case, set this to ``true``. Only valid VAT IDs will
+        trigger reverse charge taxation. Don't forget to set ``is_business`` as well!
+     * ``transmission_type`` (optional, defaults to ``email``)
+     * ``transmission_info`` (optional, see also :ref:`rest-transmission-types`)
 
    * ``positions``
 
@@ -911,6 +1066,7 @@ Creating orders
       * ``valid_until`` (optional, if both ``valid_from`` and ``valid_until`` are **missing** (not ``null``) the availability will be computed from the given product)
       * ``requested_valid_from`` (optional, can be set **instead** of ``valid_from`` and ``valid_until`` to signal a user choice for the start time that may or may not be respected)
       * ``use_reusable_medium`` (optional, causes the new ticket to take over the given reusable medium, identified by its ID)
+      * ``discount`` (optional, only possible if ``price`` is set; attention: if this is set to not-``null`` on any position, automatic calculation of discounts will not run)
       * ``answers``
 
         * ``question``
@@ -929,9 +1085,10 @@ Creating orders
         prices. Note that this will not include other fees and is calculated once during order generation and will not
         be respected automatically when the order changes later.)
       * ``_split_taxes_like_products`` (Optional convenience flag. If set to ``true``, your ``tax_rule`` will be ignored
-        and the fee will be taxed like the products in the order. If the products have multiple tax rates, multiple fees
-        will be generated with weights adjusted to the net price of the products. Note that this will be calculated once
-        during order generation and is not respected automatically when the order changes later.)
+        and the fee will be taxed like the products in the order *unless* the total amount of the positions is zero.
+        If the products have multiple tax rates, multiple fees will be generated with weights adjusted to the net price
+        of the products. Note that this will be calculated once during order generation and is not respected automatically
+        when the order changes later.)
 
    * ``force`` (optional). If set to ``true``, quotas will be ignored.
    * ``send_email`` (optional). If set to ``true``, the same emails will be sent as for a regular order, regardless of
@@ -1470,9 +1627,11 @@ List of all order positions
             },
             "attendee_email": null,
             "voucher": null,
+            "voucher_budget_use": null,
             "tax_rate": "0.00",
             "tax_rule": null,
             "tax_value": "0.00",
+            "tax_code": null,
             "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
             "discount": null,
             "pseudonymization_id": "MQLJvANO3B",
@@ -1484,14 +1643,27 @@ List of all order positions
             "blocked": null,
             "checkins": [
               {
+                "id": 1337,
                 "list": 44,
                 "type": "entry",
                 "gate": null,
                 "device": 2,
+                "device_id": 1,
                 "datetime": "2017-12-25T12:45:23Z",
                 "auto_checked_in": false
               }
             ],
+            "print_logs": [
+              {
+                "id": 1,
+                "type": "badge",
+                "successful": true,
+                "datetime": "2017-12-25T12:45:23Z",
+                "device_id": 1,
+                "source": "pretixSCAN",
+                "info": {}
+              }
+            ],
             "answers": [
               {
                 "question": 12,
@@ -1506,7 +1678,8 @@ List of all order positions
                 "output": "pdf",
                 "url": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/pdf/"
               }
-            ]
+            ],
+            "plugin_data": {}
           }
         ]
       }
@@ -1517,6 +1690,7 @@ List of all order positions
                            ``order__datetime,positionid``
    :query string order: Only return positions of the order with the given order code
    :query string search: Fuzzy search matching the attendee name, order code, invoice address name as well as to the beginning of the secret.
+   :query string customer: Only show orders linked to the given customer.
    :query integer item: Only return positions with the purchased item matching the given ID.
    :query integer item__in: Only return positions with the purchased item matching one of the given comma-separated IDs.
    :query integer variation: Only return positions with the purchased item variation matching the given ID.
@@ -1582,9 +1756,11 @@ Fetching individual positions
         },
         "attendee_email": null,
         "voucher": null,
+        "voucher_budget_use": null,
         "tax_rate": "0.00",
         "tax_rule": null,
         "tax_value": "0.00",
+        "tax_code": null,
         "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
         "addon_to": null,
         "subevent": null,
@@ -1596,14 +1772,27 @@ Fetching individual positions
         "seat": null,
         "checkins": [
           {
+            "id": 1337,
             "list": 44,
             "type": "entry",
             "gate": null,
             "device": 2,
+            "device_id": 1,
             "datetime": "2017-12-25T12:45:23Z",
             "auto_checked_in": false
           }
         ],
+        "print_logs": [
+          {
+            "id": 1,
+            "type": "badge",
+            "successful": true,
+            "datetime": "2017-12-25T12:45:23Z",
+            "device_id": 1,
+            "source": "pretixSCAN",
+            "info": {}
+          }
+        ],
         "answers": [
           {
             "question": 12,
@@ -1618,7 +1807,8 @@ Fetching individual positions
             "output": "pdf",
             "url": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/pdf/"
           }
-        ]
+        ],
+        "plugin_data": {}
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -1635,10 +1825,6 @@ Fetching individual positions
 Order position ticket download
 ------------------------------
 
-.. versionchanged:: 4.10
-
-   The API now supports ticket downloads for pending orders if allowed by the event settings.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/download/(output)/
 
    Download tickets for one order position, identified by its internal ID.
@@ -1691,14 +1877,9 @@ Order position ticket download
 Manipulating individual positions
 ---------------------------------
 
-.. versionchanged:: 4.8
+.. versionchanged:: 2024.9
 
-   The ``PATCH`` method now supports changing items, variations, subevents, seats, prices, and tax rules.
-   The ``POST`` endpoint to add individual positions has been added.
-
-.. versionadded:: 4.16
-
-   The endpoints to manage blocks have been added.
+   The API now supports logging ticket and badge prints.
 
 .. http:patch:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/
 
@@ -1742,9 +1923,14 @@ Manipulating individual positions
 
    * ``valid_until``
 
+   * ``secret``
+
    Changing parameters such as ``item`` or ``price`` will **not** automatically trigger creation of a new invoice,
    you need to take care of that yourself.
 
+   Changing ``secret`` does not cause a new PDF ticket to be sent to the customer, nor does it cause the old secret
+   to be added to the revocation list, even if your ticket generator uses one.
+
    **Example request**:
 
    .. sourcecode:: http
@@ -1768,6 +1954,7 @@ Manipulating individual positions
 
       (Full order position resource, see above.)
 
+   :query boolean check_quotas: Whether to check quotas before committing item changes, default is ``true``
    :param organizer: The ``slug`` field of the organizer of the event
    :param event: The ``slug`` field of the event
    :param id: The ``id`` field of the order position to update
@@ -1847,6 +2034,7 @@ Manipulating individual positions
 
       (Full order position resource, see above.)
 
+   :query boolean check_quotas: Whether to check quotas before creating the new position, default is ``true``
    :param organizer: The ``slug`` field of the organizer of the event
    :param event: The ``slug`` field of the event
 
@@ -1959,6 +2147,59 @@ Manipulating individual positions
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to update this order position.
 
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/printlog/
+
+   Creates a print log, stating that this ticket has been printed.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/printlog/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+     {
+       "datetime": "2024-09-19T13:37:00+02:00",
+       "source": "pretixPOS",
+       "type": "badge",
+       "info": {
+         "cashier": 1234
+       }
+     }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/pdf
+
+     {
+       "id": 1234,
+       "device_id": null,
+       "datetime": "2024-09-19T13:37:00+02:00",
+       "source": "pretixPOS",
+       "type": "badge",
+       "info": {
+         "cashier": 1234
+       }
+     }
+
+   :param organizer: The ``slug`` field of the organizer to create a log for
+   :param event: The ``slug`` field of the event to create a log for
+   :param id: The ``id`` field of the order position to create a log for
+   :statuscode 201: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource
+                    **or** downloads are not available for this order position at this time. The response content will
+                    contain more details.
+   :statuscode 404: The requested order position or download provider does not exist.
+   :statuscode 409: The file is not yet ready and will now be prepared. Retry the request after waiting for a few
+                    seconds.
+
 Changing order contents
 -----------------------
 
@@ -1967,10 +2208,6 @@ multiple changes to an order at once within one transaction. This makes it possi
 attendees in an order without running into conflicts. This interface also offers some possibilities not available
 otherwise, such as splitting an order or changing fees.
 
-.. versionchanged:: 4.8
-
-   This endpoint has been added to the system.
-
 .. http:post:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/change/
 
    Performs a change operation on an order. You can supply the following fields:
@@ -1991,6 +2228,9 @@ otherwise, such as splitting an order or changing fees.
 
    * ``cancel_fees``: A list of objects with the single key ``fee`` specifying an order fee ID.
 
+   * ``create_fees``: A list of objects describing new order fees with the fields ``fee_type``, ``value``, ``description``,
+     ``internal_type``, ``tax_rule``
+
    * ``recalculate_taxes``: If set to ``"keep_net"``, all taxes will be recalculated based on the tax rule and invoice
      address, the net price will be kept. If set to ``"keep_gross"``, the gross price will be kept. If set to ``null``
      (the default) the taxes are not recalculated.
@@ -2010,17 +2250,12 @@ otherwise, such as splitting an order or changing fees.
       Content-Type: application/json
 
       {
-        "cancel_positions": [
-          {
-            "position": 12373
-          }
-        ],
         "patch_positions": [
           {
             "position": 12374,
             "body": {
               "item": 12,
-              "variation": None,
+              "variation": null,
               "subevent": 562,
               "seat": "seat-guid-2",
               "price": "99.99",
@@ -2028,6 +2263,11 @@ otherwise, such as splitting an order or changing fees.
             }
           }
         ],
+        "cancel_positions": [
+          {
+            "position": 12373
+          }
+        ],
         "split_positions": [
           {
             "position": 12375
@@ -2036,7 +2276,7 @@ otherwise, such as splitting an order or changing fees.
         "create_positions": [
           {
             "item": 12,
-            "variation": None,
+            "variation": null,
             "subevent": 562,
             "seat": "seat-guid-2",
             "price": "99.99",
@@ -2044,12 +2284,7 @@ otherwise, such as splitting an order or changing fees.
             "attendee_name": "Peter",
           }
         ],
-        "cancel_fees": [
-          {
-            "fee": 49
-          }
-        ],
-        "change_fees": [
+        "patch_fees": [
           {
             "fee": 51,
             "body": {
@@ -2057,6 +2292,20 @@ otherwise, such as splitting an order or changing fees.
             }
           }
         ],
+        "cancel_fees": [
+          {
+            "fee": 49
+          }
+        ],
+        "create_fees": [
+          {
+            "fee_type": "other",
+            "value": "1.50",
+            "description": "Example Fee",
+            "internal_type": "",
+            "tax_rule": 15
+          }
+        ],
         "reissue_invoice": true,
         "send_email": true,
         "recalculate_taxes": "keep_gross"
@@ -2072,6 +2321,7 @@ otherwise, such as splitting an order or changing fees.
 
       (Full order position resource, see above.)
 
+   :query boolean check_quotas: Whether to check quotas before patching or creating positions, default is ``true``
    :param organizer: The ``slug`` field of the organizer of the event
    :param event: The ``slug`` field of the event
    :param code: The ``code`` field of the order to update
@@ -2267,6 +2517,7 @@ Order payment endpoints
 
       {
         "amount": "23.00",
+        "comment": "Overpayment",
         "mark_canceled": false
       }
 

doc/api/resources/organizers.rst

@@ -19,16 +19,17 @@ name                                  string                     The organizer's
 slug                                  string                     A short form of the name, used e.g. in URLs.
 public_url                            string                     The public, customer-facing URL of the organizer, where
                                                                  the list of all events can be found (read-only).
+plugins                               list                       A list of package names of the enabled plugins for this
+                                                                 organizer. Note that most plugins are enabled on the
+                                                                 event level (or both levels). If you remove a plugin
+                                                                 that is also enabled on some events, it will
+                                                                 automatically be removed from all events as well.
 ===================================== ========================== =======================================================
 
 
 Endpoints
 ---------
 
-.. versionchanged:: 4.17
-
-    The ``public_url`` field has been added.
-
 .. http:get:: /api/v1/organizers/
 
    Returns a list of all organizers the authenticated user/token has access to.
@@ -57,7 +58,10 @@ Endpoints
           {
             "name": "Big Events LLC",
             "slug": "Big Events",
-            "public_url": "https://pretix.eu/bigevents/"
+            "public_url": "https://pretix.eu/bigevents/",
+            "plugins": [
+              "pretix_datev"
+            ]
           }
         ]
       }
@@ -91,7 +95,10 @@ Endpoints
       {
         "name": "Big Events LLC",
         "slug": "Big Events",
-        "public_url": "https://pretix.eu/bigevents/"
+        "public_url": "https://pretix.eu/bigevents/",
+        "plugins": [
+          "pretix_datev"
+        ]
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -99,6 +106,50 @@ Endpoints
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer does not exist **or** you have no permission to view it.
 
+.. http:patch:: /api/v1/organizers/(organizer)/
+
+   Updates an organizer. Currently only the ``plugins`` field may be updated.
+
+   Permission required: "Can change organizer settings"
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "plugins": [
+          "pretix_seating"
+        ]
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "name": "Big Events LLC",
+        "slug": "Big Events",
+        "public_url": "https://pretix.eu/bigevents/",
+        "plugins": [
+          "pretix_seating"
+        ]
+      }
+
+   :param organizer: The ``slug`` field of the organizer to update
+   :statuscode 200: no error
+   :statuscode 400: The organizer could not be updated due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to update this resource.
+
 Organizer settings
 ------------------
 

doc/api/resources/questions.rst

@@ -44,6 +44,8 @@ identifier                            string                     An arbitrary st
 ask_during_checkin                    boolean                    If ``true``, this question will not be asked while
                                                                  buying the ticket, but will show up when redeeming
                                                                  the ticket instead.
+show_during_checkin                   boolean                    If ``true``, the answer to the question will be shown
+                                                                 during check-in (if the check-in client supports it).
 hidden                                boolean                    If ``true``, the question will only be shown in the
                                                                  backend.
 print_on_invoice                      boolean                    If ``true``, the question will only be shown on
@@ -77,6 +79,10 @@ dependency_value                      string                     An old version
                                                                  for one value. **Deprecated.**
 ===================================== ========================== =======================================================
 
+.. versionchanged:: 2023.8
+
+   The ``show_during_checkin`` attribute has been added.
+
 Endpoints
 ---------
 
@@ -115,6 +121,7 @@ Endpoints
             "position": 1,
             "identifier": "WY3TP9SL",
             "ask_during_checkin": false,
+            "show_during_checkin": false,
             "hidden": false,
             "print_on_invoice": false,
             "valid_number_min": null,
@@ -194,6 +201,7 @@ Endpoints
         "position": 1,
         "identifier": "WY3TP9SL",
         "ask_during_checkin": false,
+        "show_during_checkin": false,
         "hidden": false,
         "print_on_invoice": false,
         "valid_number_min": null,
@@ -257,6 +265,7 @@ Endpoints
         "items": [1, 2],
         "position": 1,
         "ask_during_checkin": false,
+        "show_during_checkin": false,
         "hidden": false,
         "print_on_invoice": false,
         "dependency_question": null,
@@ -293,6 +302,7 @@ Endpoints
         "position": 1,
         "identifier": "WY3TP9SL",
         "ask_during_checkin": false,
+        "show_during_checkin": false,
         "hidden": false,
         "print_on_invoice": false,
         "dependency_question": null,
@@ -348,7 +358,7 @@ Endpoints
 
    .. sourcecode:: http
 
-      PATCH /api/v1/organizers/bigevents/events/sampleconf/items/1/ HTTP/1.1
+      PATCH /api/v1/organizers/bigevents/events/sampleconf/questions/1/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
       Content-Type: application/json
@@ -376,6 +386,7 @@ Endpoints
         "position": 2,
         "identifier": "WY3TP9SL",
         "ask_during_checkin": false,
+        "show_during_checkin": false,
         "hidden": false,
         "print_on_invoice": false,
         "dependency_question": null,
@@ -415,7 +426,7 @@ Endpoints
    :param event: The ``slug`` field of the event to modify
    :param id: The ``id`` field of the question to modify
    :statuscode 200: no error
-   :statuscode 400: The item could not be modified due to invalid submitted data
+   :statuscode 400: The question could not be modified due to invalid submitted data
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to change this resource.
 
@@ -427,7 +438,7 @@ Endpoints
 
    .. sourcecode:: http
 
-      DELETE /api/v1/organizers/bigevents/events/sampleconf/items/1/ HTTP/1.1
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/questions/1/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
 
@@ -440,7 +451,7 @@ Endpoints
 
    :param organizer: The ``slug`` field of the organizer to modify
    :param event: The ``slug`` field of the event to modify
-   :param id: The ``id`` field of the item to delete
+   :param id: The ``id`` field of the question to delete
    :statuscode 204: no error
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to delete this resource.

doc/api/resources/quotas.rst

@@ -28,6 +28,8 @@ closed                                boolean                    Whether the quo
                                                                  field).
 release_after_exit                    boolean                    Whether the quota regains capacity as soon as some tickets
                                                                  have been scanned at an exit.
+ignore_for_event_availability         boolean                    Whether the quota is ignored when calculating the event's
+                                                                 availability of tickets.
 available                             boolean                    Whether this quota is available. Only returned if ``with_availability=true``
                                                                  is set on the request. Do not rely on this value for critical operations, it may be
                                                                  slightly out of date.
@@ -36,10 +38,9 @@ available_number                      integer                    Number of avail
                                                                  slightly out of date. ``null`` means unlimited.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.1
-
-    The ``with_availability`` query parameter has been added.
+.. versionchanged:: 2025.7
 
+    The attribute ``ignore_for_event_availability`` has been added.
 
 Endpoints
 ---------
@@ -77,7 +78,8 @@ Endpoints
             "variations": [1, 4, 5, 7],
             "subevent": null,
             "close_when_sold_out": false,
-            "closed": false
+            "closed": false,
+            "ignore_for_event_availability": false
           }
         ]
       }
@@ -86,7 +88,8 @@ Endpoints
    :query string ordering: Manually set the ordering of results. Valid fields to be used are ``id`` and ``position``.
                            Default: ``position``
    :query integer subevent: Only return quotas of the sub-event with the given ID.
-   :query integer subevent__in: Only return quotas of sub-events with one the given IDs (comma-separated).
+   :query integer subevent__in: Only return quotas of sub-events with one of the given IDs (comma-separated).
+   :query integer items__in: Only return quotas that include a product with one of the given IDs (comma-separated).
    :query string with_availability: Set to ``true`` to get availability information. Can lead to increased answer times.
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
@@ -122,7 +125,8 @@ Endpoints
         "variations": [1, 4, 5, 7],
         "subevent": null,
         "close_when_sold_out": false,
-        "closed": false
+        "closed": false,
+        "ignore_for_event_availability": false
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -153,7 +157,8 @@ Endpoints
         "variations": [1, 4, 5, 7],
         "subevent": null,
         "close_when_sold_out": false,
-        "closed": false
+        "closed": false,
+        "ignore_for_event_availability": false
       }
 
    **Example response**:
@@ -172,7 +177,8 @@ Endpoints
         "variations": [1, 4, 5, 7],
         "subevent": null,
         "close_when_sold_out": false,
-        "closed": false
+        "closed": false,
+        "ignore_for_event_availability": false
       }
 
    :param organizer: The ``slug`` field of the organizer of the event/item to create a quota for
@@ -227,7 +233,8 @@ Endpoints
         ],
         "subevent": null,
         "close_when_sold_out": false,
-        "closed": false
+        "closed": false,
+        "ignore_for_event_availability": false
       }
 
    :param organizer: The ``slug`` field of the organizer to modify

doc/api/resources/reusablemedia.rst

@@ -18,7 +18,7 @@ The reusable medium resource contains the following public fields:
 Field                                 Type                       Description
 ===================================== ========================== =======================================================
 id                                    integer                    Internal ID of the medium
-type                                  string                     Type of medium, e.g. ``"barcode"`` or ``"nfc_uid"``.
+type                                  string                     Type of medium, e.g. ``"barcode"``, ``"nfc_uid"`` or ``"nfc_mf0aes"``.
 organizer                             string                     Organizer slug of the organizer who "owns" this medium.
 identifier                            string                     Unique identifier of the medium. The format depends on the ``type``.
 active                                boolean                    Whether this medium may be used.
@@ -37,6 +37,7 @@ Existing media types are:
 
 - ``barcode``
 - ``nfc_uid``
+- ``nfc_mf0aes``
 
 Endpoints
 ---------

doc/api/resources/saleschannels.rst

@@ -0,0 +1,219 @@
+Sales channels
+==============
+
+Resource description
+--------------------
+
+The sales channel resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+identifier                            string                     Internal ID of the sales channel. For sales channel types
+                                                                 that allow only one instance, this is the same as ``type``.
+                                                                 For sales channel types that allow multiple instances, this
+                                                                 is always prefixed with ``type.``.
+label                                 multi-lingual string       Human-readable name of the sales channel
+type                                  string                     Type of the sales channel. Only channels with type ``api``
+                                                                 can currently be created through the API.
+position                              integer                    Position for sorting lists of sales channels
+===================================== ========================== =======================================================
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/saleschannels/
+
+   Returns a list of all sales channels within a given organizer.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/saleschannels/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "identifier": "web",
+            "label": {
+              "en": "Online shop"
+            },
+            "type": "web",
+            "position": 0
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+
+.. http:get:: /api/v1/organizers/(organizer)/saleschannels/(identifier)/
+
+   Returns information on one sales channel, identified by its identifier.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/saleschannels/web/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "identifier": "web",
+        "label": {
+          "en": "Online shop"
+        },
+        "type": "web",
+        "position": 0
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param identifier: The ``identifier`` field of the sales channel to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+
+.. http:post:: /api/v1/organizers/(organizer)/saleschannels/
+
+   Creates a sales channel
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/saleschannels/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "identifier": "api.custom",
+        "label": {
+          "en": "Custom integration"
+        },
+        "type": "api",
+        "position": 2
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "identifier": "api.custom",
+        "label": {
+          "en": "Custom integration"
+        },
+        "type": "api",
+        "position": 2
+      }
+
+   :param organizer: The ``slug`` field of the organizer to create a sales channel for
+   :statuscode 201: no error
+   :statuscode 400: The sales channel could not be created due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to create this resource.
+
+.. http:patch:: /api/v1/organizers/(organizer)/saleschannels/(identifier)/
+
+   Update a sales channel. You can also use ``PUT`` instead of ``PATCH``. With ``PUT``, you have to provide all fields of
+   the resource, other fields will be reset to default. With ``PATCH``, you only need to provide the fields that you
+   want to change.
+
+   You can change all fields of the resource except the ``identifier`` and ``type`` fields.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/saleschannels/web/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 94
+
+      {
+        "position": 5
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "identifier": "web",
+        "label": {
+          "en": "Online shop"
+        },
+        "type": "web",
+        "position": 5
+      }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param identifier: The ``identifier`` field of the sales channel to modify
+   :statuscode 200: no error
+   :statuscode 400: The sales channel could not be modified due to invalid submitted data
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to change this resource.
+
+.. http:delete:: /api/v1/organizers/(organizer)/saleschannels/(identifier)/
+
+   Delete a sales channel. You can not delete sales channels which have already been used or which are integral parts
+   of the system.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/saleschannels/api.custom/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 204 No Content
+      Vary: Accept
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param identifier: The ``identifier`` field of the sales channel to delete
+   :statuscode 204: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to delete this resource **or** the sales channel is currently in use.

doc/api/resources/scheduled_exports.rst

@@ -0,0 +1,556 @@
+.. spelling:word-list:: checkin
+
+Scheduled data exports
+======================
+
+pretix and it's plugins include a number of data exporters that allow you to bulk download various data from pretix in
+different formats. You should read :ref:`rest-exporters` first to get an understanding of the basic mechanism.
+
+Exports can be scheduled to be sent at specific times automatically, both on organizer level and event level.
+
+Scheduled export resource
+-------------------------
+
+The scheduled export contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of the schedule
+owner                                 string                     Email address of the user who created this schedule (read-only).
+                                                                 This address will always receive the export and the export
+                                                                 will only contain data that this user has permission
+                                                                 to access at the time of the export. **We consider this
+                                                                 field experimental, it's behaviour might change in the future.
+                                                                 Note that the email address of a user can change at any time.**
+export_identifier                     string                     Identifier of the export to run, see :ref:`rest-exporters`
+export_form_data                      object                     Input data for the export, format depends on the export,
+                                                                 see :ref:`rest-exporters` for more details.
+locale                                string                     Language to run the export in
+mail_additional_recipients            string                     Email addresses to receive the export, comma-separated (or empty string)
+mail_additional_recipients_cc         string                     Email addresses to receive the export in copy, comma-separated (or empty string)
+mail_additional_recipients_bcc        string                     Email addresses to receive the exportin blind copy, comma-separated (or empty string)
+mail_subject                          string                     Subject to use for the email (currently no variables supported)
+mail_template                         string                     Text to use for the email (currently no variables supported)
+schedule_rrule                        string                     Recurrence specification to determine the **days** this
+                                                                 schedule runs on in ``RRULE`` syntax following `RFC 5545`_
+                                                                 with some restrictions. Only one rule is allowed, only
+                                                                 one occurrence per day is allowed, and some features
+                                                                 are not supported (``BYMONTHDAY``, ``BYYEARDAY``,
+                                                                 ``BYEASTER``, ``BYWEEKNO``).
+schedule_rrule_time                   time                       Time of day to run this on on the specified days.
+                                                                 Will be interpreted as local time of the event for event-level
+                                                                 exports. For organizer-level exports, the timezone is given
+                                                                 in the field ``timezone``. The export will never run **before**
+                                                                 this time but it **may** run **later**.
+timezone                              string                     Time zone to interpret the schedule in (only for organizer-level exports)
+schedule_next_run                     datetime                   Next planned execution (read-only, computed by server)
+error_counter                         integer                    Number of consecutive times this export failed (read-only).
+                                                                 After a number of failures (currently 5), the schedule no
+                                                                 longer is executed. Changing parameters resets the value.
+===================================== ========================== =======================================================
+
+Special notes on permissions
+----------------------------
+
+Permission handling for scheduled exports is more complex than for most other objects. The reason for this is that
+there are two levels of access control involved here: First, you need permission to access or change the configuration
+of the scheduled exports in the moment you are doing it. Second, you **continuously** need permission to access the
+**data** that is exported as part of the schedule. For this reason, scheduled exports always need one user account
+to be their **owner**.
+
+Therefore, scheduled exports **must** be created by an API client using :ref:`OAuth authentication <rest-oauth>`.
+It is impossible to create a scheduled export using token authentication. After the export is created, it can also be
+modified using token authentication.
+
+A user or token with the "can change settings" permission for a given organizer or event can see and change
+**all** scheduled exports created for the respective organizer or event, regardless of who created them.
+A user without this permission can only see **their own** scheduled exports.
+A token without this permission can not see scheduled exports as all.
+
+
+
+Endpoints for event exports
+---------------------------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/scheduled_exports/
+
+   Returns a list of all scheduled exports the client has access to.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/scheduled_exports/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "id": 1,
+            "owner": "john@example.com",
+            "export_identifier": "orderlist",
+            "export_form_data": {"_format": "xlsx", "date_range": "week_previous"},
+            "locale": "en",
+            "mail_additional_recipients": "mary@example.org",
+            "mail_additional_recipients_cc": "",
+            "mail_additional_recipients_bcc": "",
+            "mail_subject": "Order list",
+            "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+            "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+            "schedule_rrule_time": "04:00:00",
+            "schedule_next_run": "2023-10-26T02:00:00Z",
+            "error_counter": 0
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :query string ordering: Manually set the ordering of results. Valid fields to be used are ``id``, ``export_identifier``, and ``schedule_next_run``.
+                           Default: ``id``
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/scheduled_exports/(id)/
+
+   Returns information on one scheduled export, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/scheduled_exports/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "owner": "john@example.com",
+        "export_identifier": "orderlist",
+        "export_form_data": {"_format": "xlsx", "date_range": "week_previous"},
+        "locale": "en",
+        "mail_additional_recipients": "mary@example.org",
+        "mail_additional_recipients_cc": "",
+        "mail_additional_recipients_bcc": "",
+        "mail_subject": "Order list",
+        "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+        "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+        "schedule_rrule_time": "04:00:00",
+        "schedule_next_run": "2023-10-26T02:00:00Z",
+        "error_counter": 0
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param id: The ``id`` field of the scheduled export to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/scheduled_exports/
+
+   Schedule a new export.
+
+   .. note:: See above for special notes on permissions.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/scheduled_exports/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "export_identifier": "orderlist",
+        "export_form_data": {"_format": "xlsx", "date_range": "week_previous"},
+        "locale": "en",
+        "mail_additional_recipients": "mary@example.org",
+        "mail_additional_recipients_cc": "",
+        "mail_additional_recipients_bcc": "",
+        "mail_subject": "Order list",
+        "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+        "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+        "schedule_rrule_time": "04:00:00"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+
+      {
+        "id": 1,
+        "owner": "john@example.com",
+        "export_identifier": "orderlist",
+        "export_form_data": {"_format": "xlsx", "date_range": "week_previous"},
+        "locale": "en",
+        "mail_additional_recipients": "mary@example.org",
+        "mail_additional_recipients_cc": "",
+        "mail_additional_recipients_bcc": "",
+        "mail_subject": "Order list",
+        "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+        "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+        "schedule_rrule_time": "04:00:00",
+        "schedule_next_run": "2023-10-26T02:00:00Z",
+        "error_counter": 0
+      }
+
+   :param organizer: The ``slug`` field of the organizer of the event to create an item for
+   :param event: The ``slug`` field of the event to create an item for
+   :statuscode 201: no error
+   :statuscode 400: The item could not be created due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to create this resource.
+
+.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/scheduled_exports/(id)/
+
+   Update a scheduled export. You can also use ``PUT`` instead of ``PATCH``. With ``PUT``, you have to provide all fields of
+   the resource, other fields will be reset to default. With ``PATCH``, you only need to provide the fields that you
+   want to change.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/events/sampleconf/scheduled_exports/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 94
+
+      {
+        "export_form_data": {"_format": "xlsx", "date_range": "week_this"},
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "owner": "john@example.com",
+        "export_identifier": "orderlist",
+        "export_form_data": {"_format": "xlsx", "date_range": "week_this"},
+        "locale": "en",
+        "mail_additional_recipients": "mary@example.org",
+        "mail_additional_recipients_cc": "",
+        "mail_additional_recipients_bcc": "",
+        "mail_subject": "Order list",
+        "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+        "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+        "schedule_rrule_time": "04:00:00",
+        "schedule_next_run": "2023-10-26T02:00:00Z",
+        "error_counter": 0
+      }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param event: The ``slug`` field of the event to modify
+   :param id: The ``id`` field of the export to modify
+   :statuscode 200: no error
+   :statuscode 400: The export could not be modified due to invalid submitted data
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to change this resource.
+
+.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/scheduled_exports/(id)/
+
+   Delete a scheduled export.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/scheduled_exports/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 204 No Content
+      Vary: Accept
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param event: The ``slug`` field of the event to modify
+   :param id: The ``id`` field of the export to delete
+   :statuscode 204: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to delete this resource.
+
+Endpoints for organizer exports
+-------------------------------
+
+.. http:get:: /api/v1/organizers/(organizer)/scheduled_exports/
+
+   Returns a list of all scheduled exports the client has access to.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/scheduled_exports/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "id": 1,
+            "owner": "john@example.com",
+            "export_identifier": "orderlist",
+            "export_form_data": {"_format": "xlsx", "date_range": "week_previous"},
+            "locale": "en",
+            "mail_additional_recipients": "mary@example.org",
+            "mail_additional_recipients_cc": "",
+            "mail_additional_recipients_bcc": "",
+            "mail_subject": "Order list",
+            "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+            "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+            "schedule_rrule_time": "04:00:00",
+            "schedule_next_run": "2023-10-26T02:00:00Z",
+            "timezone": "Europe/Berlin",
+            "error_counter": 0
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :query string ordering: Manually set the ordering of results. Valid fields to be used are ``id``, ``export_identifier``, and ``schedule_next_run``.
+                           Default: ``id``
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+
+.. http:get:: /api/v1/organizers/(organizer)/scheduled_exports/(id)/
+
+   Returns information on one scheduled export, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/scheduled_exports/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "owner": "john@example.com",
+        "export_identifier": "orderlist",
+        "export_form_data": {"_format": "xlsx", "date_range": "week_previous"},
+        "locale": "en",
+        "mail_additional_recipients": "mary@example.org",
+        "mail_additional_recipients_cc": "",
+        "mail_additional_recipients_bcc": "",
+        "mail_subject": "Order list",
+        "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+        "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+        "schedule_rrule_time": "04:00:00",
+        "schedule_next_run": "2023-10-26T02:00:00Z",
+        "timezone": "Europe/Berlin",
+        "error_counter": 0
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param id: The ``id`` field of the scheduled export to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+
+.. http:post:: /api/v1/organizers/(organizer)/scheduled_exports/
+
+   Schedule a new export.
+
+   .. note:: See above for special notes on permissions.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/scheduled_exports/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "export_identifier": "orderlist",
+        "export_form_data": {"_format": "xlsx", "date_range": "week_previous"},
+        "locale": "en",
+        "mail_additional_recipients": "mary@example.org",
+        "mail_additional_recipients_cc": "",
+        "mail_additional_recipients_bcc": "",
+        "mail_subject": "Order list",
+        "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+        "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+        "schedule_rrule_time": "04:00:00",
+        "timezone": "Europe/Berlin"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+
+      {
+        "id": 1,
+        "owner": "john@example.com",
+        "export_identifier": "orderlist",
+        "export_form_data": {"_format": "xlsx", "date_range": "week_previous"},
+        "locale": "en",
+        "mail_additional_recipients": "mary@example.org",
+        "mail_additional_recipients_cc": "",
+        "mail_additional_recipients_bcc": "",
+        "mail_subject": "Order list",
+        "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+        "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+        "schedule_rrule_time": "04:00:00",
+        "schedule_next_run": "2023-10-26T02:00:00Z",
+        "timezone": "Europe/Berlin",
+        "error_counter": 0
+      }
+
+   :param organizer: The ``slug`` field of the organizer of the event to create an item for
+   :statuscode 201: no error
+   :statuscode 400: The item could not be created due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to create this resource.
+
+.. http:patch:: /api/v1/organizers/(organizer)/scheduled_exports/(id)/
+
+   Update a scheduled export. You can also use ``PUT`` instead of ``PATCH``. With ``PUT``, you have to provide all fields of
+   the resource, other fields will be reset to default. With ``PATCH``, you only need to provide the fields that you
+   want to change.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/scheduled_exports/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 94
+
+      {
+        "export_form_data": {"_format": "xlsx", "date_range": "week_this"},
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "owner": "john@example.com",
+        "export_identifier": "orderlist",
+        "export_form_data": {"_format": "xlsx", "date_range": "week_this"},
+        "locale": "en",
+        "mail_additional_recipients": "mary@example.org",
+        "mail_additional_recipients_cc": "",
+        "mail_additional_recipients_bcc": "",
+        "mail_subject": "Order list",
+        "mail_template": "Here is last week's order list\n\nCheers\nJohn",
+        "schedule_rrule": "DTSTART:20230118T000000\nRRULE:FREQ=WEEKLY;BYDAY=TU,WE,TH",
+        "schedule_rrule_time": "04:00:00",
+        "schedule_next_run": "2023-10-26T02:00:00Z",
+        "timezone": "Europe/Berlin",
+        "error_counter": 0
+      }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param id: The ``id`` field of the export to modify
+   :statuscode 200: no error
+   :statuscode 400: The export could not be modified due to invalid submitted data
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to change this resource.
+
+.. http:delete:: /api/v1/organizers/(organizer)/scheduled_exports/(id)/
+
+   Delete a scheduled export.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/scheduled_exports/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 204 No Content
+      Vary: Accept
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param id: The ``id`` field of the export to delete
+   :statuscode 204: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to delete this resource.
+
+
+.. _RFC 5545: https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.5.3

doc/api/resources/seats.rst

@@ -0,0 +1,373 @@
+.. _`rest-seats`:
+
+Seats
+=====
+
+The seat resource represents the seats in a seating plan in a specific event or subevent.
+
+Resource description
+--------------------
+
+The seat resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of this seat
+subevent                              integer                    Internal ID of the subevent this seat belongs to
+zone_name                             string                     Name of the zone the seat is in
+row_name                              string                     Name/number of the row the seat is in
+row_label                             string                     Additional label of the row (or ``null``)
+seat_number                           string                     Number of the seat within the row
+seat_label                            string                     Additional label of the seat (or ``null``)
+seat_guid                             string                     Identifier of the seat within the seating plan
+product                               integer                    Internal ID of the product that is mapped to this seat
+blocked                               boolean                    Whether this seat is blocked manually.
+orderposition                         integer / object           Internal ID of an order position reserving this seat.
+cartposition                          integer / object           Internal ID of a cart position reserving this seat.
+voucher                               integer / object           Internal ID of a voucher reserving this seat.
+===================================== ========================== =======================================================
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/seats/
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/subevents/(subevent_id)/seats/
+
+   Returns a list of all seats in the specified event or subevent. Depending on whether the event has subevents, the
+   according endpoint has to be used.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/seats/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+        HTTP/1.1 200 OK
+        Vary: Accept
+        Content-Type: application/json
+
+        {
+            "count": 500,
+            "next": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/seats/?page=2",
+            "previous": null,
+            "results": [
+                {
+                    "id": 1633,
+                    "subevent": null,
+                    "zone_name": "Ground floor",
+                    "row_name": "1",
+                    "row_label": null,
+                    "seat_number": "1",
+                    "seat_label": null,
+                    "seat_guid": "b9746230-6f31-4f41-bbc9-d6b60bdb3342",
+                    "product": 104,
+                    "blocked": false,
+                    "orderposition": null,
+                    "cartposition": null,
+                    "voucher": 51
+                },
+                {
+                    "id": 1634,
+                    "subevent": null,
+                    "zone_name": "Ground floor",
+                    "row_name": "1",
+                    "row_label": null,
+                    "seat_number": "2",
+                    "seat_label": null,
+                    "seat_guid": "1d29fe20-8e1e-4984-b0ee-2773b0d07e07",
+                    "product": 104,
+                    "blocked": true,
+                    "orderposition": 4321,
+                    "cartposition": null,
+                    "voucher": null
+                },
+                // ...
+            ]
+        }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1.
+   :query string zone_name: Only show seats with the given zone_name.
+   :query string row_name: Only show seats with the given row_name.
+   :query string row_label: Only show seats with the given row_label.
+   :query string seat_number: Only show seats with the given seat_number.
+   :query string seat_label: Only show seats with the given seat_label.
+   :query string seat_guid: Only show seats with the given seat_guid.
+   :query boolean blocked: Only show seats with the given blocked status.
+   :query boolean is_available: Only show seats that are (not) currently available.
+   :query string expand: If you pass ``"orderposition"``, ``"cartposition"``, or ``"voucher"``, the respective field will be
+                         shown as a nested value instead of just an ID. This requires permission to access that object.
+                         The nested objects are identical to the respective resources, except that order positions
+                         will have an attribute of the format ``"order": {"code": "ABCDE", "event": "eventslug"}`` to make
+                         matching easier, and won't include the `seat` attribute, as that would be redundant.
+                         The parameter can be given multiple times.
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param subevent_id: The ``id`` field of the subevent to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+   :statuscode 404: Endpoint without subevent id was used for event with subevents, or vice versa.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/seats/(id)/
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/subevents/(subevent_id)/seats/(id)/
+
+   Returns information on one seat, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+        GET /api/v1/organizers/bigevents/events/sampleconf/seats/1634/?expand=orderposition HTTP/1.1
+        Host: pretix.eu
+        Accept: application/json
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+        HTTP/1.1 200 OK
+        Vary: Accept
+        Content-Type: application/json
+
+        {
+            "id": 1634,
+            "subevent": null,
+            "zone_name": "Ground floor",
+            "row_name": "1",
+            "row_label": null,
+            "seat_number": "2",
+            "seat_label": null,
+            "seat_guid": "1d29fe20-8e1e-4984-b0ee-2773b0d07e07",
+            "product": 104,
+            "blocked": true,
+            "orderposition": {
+                "id": 134,
+                "order": {
+                    "code": "U0HW7",
+                    "event": "sampleconf"
+                },
+                "positionid": 1,
+                "item": 104,
+                "variation": 59,
+                "price": "60.00",
+                "attendee_name": "",
+                "attendee_name_parts": {
+                    "_scheme": "given_family"
+                },
+                "company": null,
+                "street": null,
+                "zipcode": null,
+                "city": null,
+                "country": null,
+                "state": null,
+                "discount": null,
+                "attendee_email": null,
+                "voucher": null,
+                "tax_rate": "0.00",
+                "tax_value": "0.00",
+                "secret": "4rfgp263jduratnsvwvy6cc6r6wnptbj",
+                "addon_to": null,
+                "subevent": null,
+                "checkins": [],
+                "downloads": [],
+                "answers": [],
+                "tax_rule": null,
+                "pseudonymization_id": "ZSNYSG3URZ",
+                "canceled": false,
+                "valid_from": null,
+                "valid_until": null,
+                "blocked": null,
+                "voucher_budget_use": null
+            },
+            "cartposition": null,
+            "voucher": null
+        }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param subevent_id: The ``id`` field of the subevent to fetch
+   :param id: The ``id`` field of the seat to fetch
+   :query string expand: If you pass ``"orderposition"``, ``"cartposition"``, or ``"voucher"``, the respective field will be
+                         shown as a nested value instead of just an ID. This requires permission to access that object.
+                         The nested objects are identical to the respective resources, except that order positions
+                         will have an attribute of the format ``"order": {"code": "ABCDE", "event": "eventslug"}`` to make
+                         matching easier, and won't include the `seat` attribute, as that would be redundant.
+                         The parameter can be given multiple times.
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+   :statuscode 404: Seat does not exist; or the endpoint without subevent id was used for event with subevents, or vice versa.
+
+.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/seats/(id)/
+.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/subevents/(id)/seats/(id)/
+
+   Update a seat.
+
+   You can only change the ``blocked`` field.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+        PATCH /api/v1/organizers/bigevents/events/sampleconf/seats/1636/ HTTP/1.1
+        Host: pretix.eu
+        Accept: application/json, text/javascript
+        Content-Type: application/json
+
+        {
+            "blocked": true
+        }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+        HTTP/1.1 200 OK
+        Vary: Accept
+        Content-Type: application/json
+
+        {
+            "id": 1636,
+            "subevent": null,
+            "zone_name": "Ground floor",
+            "row_name": "1",
+            "row_label": null,
+            "seat_number": "4",
+            "seat_label": null,
+            "seat_guid": "6c0e29e5-05d6-421f-99f3-afd01478ecad",
+            "product": 104,
+            "blocked": true,
+            "orderposition": null,
+            "cartposition": null,
+            "voucher": null
+        }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param event: The ``slug`` field of the event to modify
+   :param subevent_id: The ``id`` field of the subevent to modify
+   :param id: The ``id`` field of the seat to modify
+   :statuscode 200: no error
+   :statuscode 400: The seat could not be modified due to invalid submitted data
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer or event does not exist **or** you have no permission to change this resource.
+   :statuscode 404: Seat does not exist; or the endpoint without subevent id was used for event with subevents, or vice versa.
+
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/seats/bulk_block/
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/subevents/(id)/seats/bulk_block/
+
+   Set the ``blocked`` attribute to ``true`` for a large number of seats at once.
+   You can pass either a list of ``id`` values or a list of ``seat_guid`` values.
+   You can pass up to 10,000 seats in one request.
+
+   The endpoint will return an error if you pass a seat ID that does not exist.
+   However, it will not return an error if one of the passed seats is already blocked or sold.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+        PATCH /api/v1/organizers/bigevents/events/sampleconf/seats/bulk_block/ HTTP/1.1
+        Host: pretix.eu
+        Accept: application/json, text/javascript
+        Content-Type: application/json
+
+        {
+            "ids": [12, 45, 56]
+        }
+
+   or
+
+   .. sourcecode:: http
+
+        PATCH /api/v1/organizers/bigevents/events/sampleconf/seats/bulk_block/ HTTP/1.1
+        Host: pretix.eu
+        Accept: application/json, text/javascript
+        Content-Type: application/json
+
+        {
+            "seat_guids": ["6c0e29e5-05d6-421f-99f3-afd01478ecad", "c2899340-e2e7-4d05-8100-000a4b6d7cf4"]
+        }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+        HTTP/1.1 200 OK
+        Vary: Accept
+        Content-Type: application/json
+
+        {}
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param event: The ``slug`` field of the event to modify
+   :param subevent_id: The ``id`` field of the subevent to modify
+   :statuscode 200: no error
+   :statuscode 400: The seat could not be modified due to invalid submitted data
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer or event does not exist **or** you have no permission to change this resource.
+   :statuscode 404: Seat does not exist; or the endpoint without subevent id was used for event with subevents, or vice versa.
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/seats/bulk_unblock/
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/subevents/(id)/seats/bulk_unblock/
+
+   Set the ``blocked`` attribute to ``false`` for a large number of seats at once.
+   You can pass either a list of ``id`` values or a list of ``seat_guid`` values.
+   You can pass up to 10,000 seats in one request.
+
+   The endpoint will return an error if you pass a seat ID that does not exist.
+   However, it will not return an error if one of the passed seat is already unblocked or is sold.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+        PATCH /api/v1/organizers/bigevents/events/sampleconf/seats/bulk_unblock/ HTTP/1.1
+        Host: pretix.eu
+        Accept: application/json, text/javascript
+        Content-Type: application/json
+
+        {
+            "ids": [12, 45, 56]
+        }
+
+   or
+
+   .. sourcecode:: http
+
+        PATCH /api/v1/organizers/bigevents/events/sampleconf/seats/bulk_unblock/ HTTP/1.1
+        Host: pretix.eu
+        Accept: application/json, text/javascript
+        Content-Type: application/json
+
+        {
+            "seat_guids": ["6c0e29e5-05d6-421f-99f3-afd01478ecad", "c2899340-e2e7-4d05-8100-000a4b6d7cf4"]
+        }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+        HTTP/1.1 200 OK
+        Vary: Accept
+        Content-Type: application/json
+
+        {}
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param event: The ``slug`` field of the event to modify
+   :param subevent_id: The ``id`` field of the subevent to modify
+   :statuscode 200: no error
+   :statuscode 400: The seat could not be modified due to invalid submitted data
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer or event does not exist **or** you have no permission to change this resource.
+   :statuscode 404: Seat does not exist; or the endpoint without subevent id was used for event with subevents, or vice versa.

doc/api/resources/sendmail_rules.rst

@@ -1,10 +1,12 @@
-Automated email rules
+Scheduled email rules
 =====================
 
+This feature requires the bundled ``pretix.plugins.sendmail`` plugin to be active for the event in order to work properly.
+
 Resource description
 --------------------
 
-Automated email rules that specify emails that the system will send automatically at a specific point in time, e.g.
+Scheduled email rules that specify emails that the system will send automatically at a specific point in time, e.g.
 the day of the event.
 
 .. rst-class:: rest-resource-table
@@ -18,8 +20,19 @@ subject                               multi-lingual string       The subject of
 template                              multi-lingual string       The body of the email
 all_products                          boolean                    If ``true``, the email is sent to buyers of all products
 limit_products                        list of integers           List of product IDs, if ``all_products`` is not set
-include_pending                       boolean                    If ``true``, the email is sent to pending orders. If ``false``,
+[**DEPRECATED**] include_pending      boolean                    If ``true``, the email is sent to pending orders. If ``false``,
                                                                  only paid orders are considered.
+restrict_to_status                    list                       List of order states to restrict recipients to. Valid
+                                                                 entries are ``p`` for paid, ``e`` for expired, ``c`` for canceled,
+                                                                 ``n__pending_approval`` for pending approval,
+                                                                 ``n__not_pending_approval_and_not_valid_if_pending`` for payment
+                                                                 pending, ``n__valid_if_pending`` for payment pending but already confirmed,
+                                                                 and ``n__pending_overdue`` for pending with payment overdue.
+                                                                 The default is ``["p", "n__valid_if_pending"]``.
+checked_in_status                     string                     Check-in status to restrict recipients to. Valid strings are:
+                                                                 ``null`` for no filtering (default), ``checked_in`` for
+                                                                 limiting to attendees that are or have been checked in, and
+                                                                 ``no_checkin`` for limiting to attendees who have not checked in.
 date_is_absolute                      boolean                    If ``true``, the email is set at a specific point in time.
 send_date                             datetime                   If ``date_is_absolute`` is set: Date and time to send the email.
 send_offset_days                      integer                    If ``date_is_absolute`` is not set, this is the number of days
@@ -38,6 +51,10 @@ send_to                               string                     Can be ``"order
                                                                  date. Otherwise it is relative to the event start date.
 ===================================== ========================== =======================================================
 
+.. versionchanged:: 2023.7
+
+    The ``include_pending`` field has been  deprecated.
+    The ``restrict_to_status`` field has been added.
 
 Endpoints
 ---------
@@ -74,7 +91,12 @@ Endpoints
             "template": {"en": "Don't forget your tickets, download them at {url}"},
             "all_products": true,
             "limit_products": [],
-            "include_pending": false,
+            "restrict_to_status": [
+                "p",
+                "n__not_pending_approval_and_not_valid_if_pending",
+                "n__valid_if_pending"
+            ],
+            "checked_in_status": null,
             "send_date": null,
             "send_offset_days": 1,
             "send_offset_time": "18:00",
@@ -120,7 +142,12 @@ Endpoints
         "template": {"en": "Don't forget your tickets, download them at {url}"},
         "all_products": true,
         "limit_products": [],
-        "include_pending": false,
+        "restrict_to_status": [
+            "p",
+            "n__not_pending_approval_and_not_valid_if_pending",
+            "n__valid_if_pending"
+        ],
+        "checked_in_status": null,
         "send_date": null,
         "send_offset_days": 1,
         "send_offset_time": "18:00",
@@ -157,7 +184,12 @@ Endpoints
         "template": {"en": "Don't forget your tickets, download them at {url}"},
         "all_products": true,
         "limit_products": [],
-        "include_pending": false,
+        "restrict_to_status": [
+            "p",
+            "n__not_pending_approval_and_not_valid_if_pending",
+            "n__valid_if_pending"
+        ],
+        "checked_in_status": "checked_in",
         "send_date": null,
         "send_offset_days": 1,
         "send_offset_time": "18:00",
@@ -182,7 +214,12 @@ Endpoints
         "template": {"en": "Don't forget your tickets, download them at {url}"},
         "all_products": true,
         "limit_products": [],
-        "include_pending": false,
+        "restrict_to_status": [
+            "p",
+            "n__not_pending_approval_and_not_valid_if_pending",
+            "n__valid_if_pending"
+        ],
+        "checked_in_status": "checked_in",
         "send_date": null,
         "send_offset_days": 1,
         "send_offset_time": "18:00",
@@ -235,7 +272,12 @@ Endpoints
         "template": {"en": "Don't forget your tickets, download them at {url}"},
         "all_products": true,
         "limit_products": [],
-        "include_pending": false,
+        "restrict_to_status": [
+            "p",
+            "n__not_pending_approval_and_not_valid_if_pending",
+            "n__valid_if_pending"
+        ],
+        "checked_in_status": "checked_in",
         "send_date": null,
         "send_offset_days": 1,
         "send_offset_time": "18:00",

doc/api/resources/shipping.rst

@@ -1,6 +1,8 @@
 Shipping
 ========
 
+.. note:: This API is only available when the plugin **pretix-shipping** is installed (pretix Hosted and Enterprise only).
+
 The shipping plugin provides a HTTP API that exposes the various layouts used to generate PDF badges.
 
 Shipping address resource

doc/api/resources/shredders.rst

@@ -6,10 +6,6 @@ Data shredders
 pretix and it's plugins include a number of data shredders that allow you to clear personal information from the system.
 This page shows you how to use these shredders through the API.
 
-.. versionchanged:: 4.12
-
-   This feature has been added to the API.
-
 .. warning::
 
    Unlike the user interface, the API will not force you to download tax-relevant data before you delete it.

doc/api/resources/subevents.rst

@@ -59,22 +59,13 @@ seat_category_mapping                 object                     An object mappi
 last_modified                         datetime                   Last modification of this object
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.15
+.. versionchanged:: 2023.8.0
 
-    The ``search`` query parameter has been added to filter sub-events by their name or location in any language.
-
-.. versionchanged:: 5.0
-
-    The ``date_from_before``, ``date_from_after``, ``date_to_before``, and ``date_to_after`` query parameters have been
-    added.
+    For the organizer-wide endpoint, the ``search`` query parameter has been modified to filter sub-events by their parent events slug too.
 
 Endpoints
 ---------
 
-.. versionchanged:: 4.1
-
-    The ``with_availability_for`` parameter has been added.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/subevents/
 
    Returns a list of all sub-events of an event.
@@ -132,6 +123,7 @@ Endpoints
       }
 
    :query page: The page number in case of a multi-page result set, default is 1
+   :query is_public: If set to ``true``/``false``, only subevents with a matching value of ``is_public`` are returned.
    :query active: If set to ``true``/``false``, only events with a matching value of ``active`` are returned.
    :query is_future: If set to ``true`` (``false``), only events that happen currently or in the future are (not) returned.
    :query is_past: If set to ``true`` (``false``), only events that are over are (not) returned.
@@ -463,6 +455,7 @@ Endpoints
       }
 
    :query page: The page number in case of a multi-page result set, default is 1
+   :query is_public: If set to ``true``/``false``, only subevents with a matching value of ``is_public`` are returned.
    :query active: If set to ``true``/``false``, only events with a matching value of ``active`` are returned.
    :query event__live: If set to ``true``/``false``, only events with a matching value of ``live`` on the parent event are returned.
    :query is_future: If set to ``true`` (``false``), only events that happen currently or in the future are (not) returned.
@@ -472,6 +465,7 @@ Endpoints
    :query date_to_after: If set to a date and time, only events that have an end date and end at or after the given time are returned.
    :query date_to_before: If set to a date and time, only events that have an end date and end at or before the given time are returned.
    :query ends_after: If set to a date and time, only events that happen during of after the given time are returned.
+   :query search: Only return events matching a given search query.
    :query sales_channel: If set to a sales channel identifier, the response will only contain subevents from events available on this sales channel.
    :param organizer: The ``slug`` field of a valid organizer
    :param event: The ``slug`` field of the event to fetch

doc/api/resources/taxrules.rst

@@ -1,3 +1,8 @@
+.. spelling:word-list::
+
+   EN16931
+   DSFinV-K
+
 .. _rest-taxrules:
 
 Tax rules
@@ -18,10 +23,14 @@ id                                    integer                    Internal ID of
 name                                  multi-lingual string       The tax rules' name
 internal_name                         string                     An optional name that is only used in the backend
 rate                                  decimal (string)           Tax rate in percent
+code                                  string                     Codified reason for tax rate (or ``null``), see :ref:`rest-taxcodes`.
 price_includes_tax                    boolean                    If ``true`` (default), tax is assumed to be included in
                                                                  the specified product price
-eu_reverse_charge                     boolean                    If ``true``, EU reverse charge rules are applied. Will
-                                                                 be ignored if custom rules are set.
+default                               boolean                    If ``true`` (default), this is the default tax rate for this event
+                                                                 (there can only be one per event).
+eu_reverse_charge                     boolean                    **DEPRECATED**. If ``true``, EU reverse charge rules
+                                                                 are applied. Will be ignored if custom rules are set.
+                                                                 Use custom rules instead.
 home_country                          string                     Merchant country (required for reverse charge), can be
                                                                  ``null`` or empty string
 keep_gross_if_rate_changes            boolean                    If ``true``, changes of the tax rate based on custom
@@ -33,14 +42,50 @@ custom_rules                          object                     Dynamic rules s
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 4.6
-
-    The ``internal_name`` and ``keep_gross_if_rate_changes`` attributes have been added.
-
 .. versionchanged:: 2023.6
 
     The ``custom_rules`` attribute has been added.
 
+.. versionchanged:: 2023.8
+
+    The ``code`` attribute has been added.
+
+.. versionchanged:: 2025.4
+
+    The ``default`` attribute has been added.
+
+.. _rest-taxcodes:
+
+Tax codes
+---------
+
+For integration with external systems, such as electronic invoicing or bookkeeping systems, the tax rate itself is often
+not sufficient information. For example, there could be many different reasons why a sale has a tax rate of 0 %, but the
+external handling of the transaction depends on which reason applies. Therefore, pretix allows to supply a codified
+reason that allows us to understand what the specific legal situation is. These tax codes are modeled after a combination
+of the code lists from the European standard EN16931 and the German standard DSFinV-K.
+
+The following codes are supported:
+
+- ``S/standard`` -- Standard VAT rate in the merchant country
+- ``S/reduced`` -- Reduced VAT rate in the merchant country
+- ``S/averaged`` -- Averaged VAT rate in the merchant country (known use case: agricultural businesses in Germany)
+- ``AE`` -- Reverse charge
+- ``O`` -- Services outside of scope of tax
+- ``E`` -- Exempt from tax (no reason given)
+- ``E/<reason>`` -- Exempt from tax, where ``<reason>`` is one of the codes listed in the `VATEX code list`_ version 5.0.
+- ``Z`` -- Zero-rated goods
+- ``G`` -- Free export item, VAT not charged
+- ``K`` -- VAT exempt for EEA intra-community supply of goods and services
+- ``L`` -- Canary Islands general indirect tax
+- ``M`` -- Tax for production, services and importation in Ceuta and Melilla
+- ``B`` -- Transferred (VAT), only in Italy
+
+The code set in the ``code`` attribute of the tax rule is used by default. When ``eu_reverse_charge`` is active, the
+code is replaced by ``AE`` for reverse charge sales and by ``O`` for non-EU sales. When configuring custom rules, you
+should actively set a ``"code"`` key on each rule. Only for ``"action": "reverse"`` we automatically apply the code
+``AE``, in all other cases the default ``code`` of the tax rule is selected.
+
 Endpoints
 ---------
 
@@ -72,7 +117,9 @@ Endpoints
           {
             "id": 1,
             "name": {"en": "VAT"},
+            "default": true,
             "internal_name": "VAT",
+            "code": "S/standard",
             "rate": "19.00",
             "price_includes_tax": true,
             "eu_reverse_charge": false,
@@ -113,7 +160,9 @@ Endpoints
       {
         "id": 1,
         "name": {"en": "VAT"},
+            "default": true,
         "internal_name": "VAT",
+        "code": "S/standard",
         "rate": "19.00",
         "price_includes_tax": true,
         "eu_reverse_charge": false,
@@ -162,7 +211,9 @@ Endpoints
       {
         "id": 1,
         "name": {"en": "VAT"},
+        "default": false,
         "internal_name": "VAT",
+        "code": "S/standard",
         "rate": "19.00",
         "price_includes_tax": true,
         "eu_reverse_charge": false,
@@ -211,6 +262,7 @@ Endpoints
         "id": 1,
         "name": {"en": "VAT"},
         "internal_name": "VAT",
+        "code": "S/standard",
         "rate": "20.00",
         "price_includes_tax": true,
         "eu_reverse_charge": false,
@@ -257,3 +309,4 @@ Endpoints
    :statuscode 403: The requested organizer/event/rule does not exist **or** you have no permission to change it **or** this tax rule cannot be deleted since it is currently in use.
 
 .. _here: https://github.com/pretix/pretix/blob/master/src/pretix/static/schema/tax-rules-custom.schema.json
+.. _VATEX code list: https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/Registry+of+supporting+artefacts+to+implement+EN16931#RegistryofsupportingartefactstoimplementEN16931-Codelists

doc/api/resources/teams.rst

@@ -22,6 +22,8 @@ id                                    integer                    Internal ID of
 name                                  string                     Team name
 all_events                            boolean                    Whether this team has access to all events
 limit_events                          list                       List of event slugs this team has access to
+require_2fa                           boolean                    Whether members of this team are required to use
+                                                                 two-factor authentication
 can_create_events                     boolean
 can_change_teams                      boolean
 can_change_organizer_settings         boolean
@@ -37,10 +39,6 @@ can_change_vouchers                   boolean
 can_checkin_orders                    boolean
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 4.18
-
-    The ``can_manage_reusable_media`` permission has been added.
-
 Team member resource
 --------------------
 
@@ -122,6 +120,7 @@ Team endpoints
             "name": "Admin team",
             "all_events": true,
             "limit_events": [],
+            "require_2fa": true,
             "can_create_events": true,
             ...
           }
@@ -159,6 +158,7 @@ Team endpoints
         "name": "Admin team",
         "all_events": true,
         "limit_events": [],
+        "require_2fa": true,
         "can_create_events": true,
         ...
       }
@@ -186,6 +186,7 @@ Team endpoints
         "name": "Admin team",
         "all_events": true,
         "limit_events": [],
+        "require_2fa": true,
         "can_create_events": true,
         ...
       }
@@ -203,6 +204,7 @@ Team endpoints
         "name": "Admin team",
         "all_events": true,
         "limit_events": [],
+        "require_2fa": true,
         "can_create_events": true,
         ...
       }
@@ -246,6 +248,7 @@ Team endpoints
         "name": "Admin team",
         "all_events": true,
         "limit_events": [],
+        "require_2fa": true,
         "can_create_events": true,
         ...
       }

doc/api/resources/ticketoutputpdf.rst

@@ -1,7 +1,7 @@
 PDF ticket output
 =================
 
-The PDF ticket output plugin provides a HTTP API that exposes the various layouts used
+The build-in PDF ticket output plugin provides a HTTP API that exposes the various layouts used
 to generate PDF tickets.
 
 Resource description
@@ -29,8 +29,8 @@ item_assignments                      list of objects            Products this l
 ===================================== ========================== =======================================================
 
 
-Endpoints
----------
+Layout endpoints
+----------------
 
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/ticketlayouts/
 
@@ -268,5 +268,75 @@ Endpoints
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to delete this resource.
 
+Ticket rendering endpoint
+-----------------------------
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/ticketpdfrenderer/render_batch/
+
+   With this API call, you can instruct the system to render a set of tickets into one combined PDF file. To specify
+   which tickets to render, you need to submit a list of "parts". For every part, the following fields are supported:
+
+   * ``orderposition`` (``integer``, required): The ID of the order position to render.
+   * ``override_channel`` (``string``, optional): The sales channel ID to be used for layout selection instead of the
+     original channel of the order.
+   * ``override_layout`` (``integer``, optional): The ticket layout ID to be used instead of the auto-selected one.
+
+   If your input parameters validate correctly, a ``202 Accepted`` status code is returned.
+   The body points you to the download URL of the result. Running a ``GET`` request on that result URL will
+   yield one of the following status codes:
+
+    * ``200 OK`` – The export succeeded. The body will be your resulting file. Might be large!
+    * ``409 Conflict`` – Your export is still running. The body will be JSON with the structure ``{"status": "running"}``. ``status`` can be ``waiting`` before the task is actually being processed. Please retry, but wait at least one second before you do.
+    * ``410 Gone`` – Running the export has failed permanently. The body will be JSON with the structure ``{"status": "failed", "message": "Error message"}``
+    * ``404 Not Found`` – The export does not exist / is expired.
+
+   .. warning:: This endpoint is considered **experimental**. It might change at any time without prior notice.
+
+   .. note:: To avoid performance issues, a maximum number of 1000 parts is currently allowed.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/ticketpdfrenderer/render_batch/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "parts": [
+          {
+            "orderposition": 55412
+          },
+          {
+            "orderposition": 55412,
+            "override_channel": "web"
+          },
+          {
+            "orderposition": 55412,
+            "override_layout": 56
+          }
+        ]
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "download": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/ticketpdfrenderer/download/29891ede-196f-4942-9e26-d055a36e98b8/3f279f13-c198-4137-b49b-9b360ce9fcce/"
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :statuscode 202: no error
+   :statuscode 400: Invalid input options
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+
 
 .. _here: https://github.com/pretix/pretix/blob/master/src/pretix/static/schema/pdf-layout.schema.json

doc/api/resources/transactions.rst

@@ -0,0 +1,232 @@
+.. _rest-transactions:
+
+Transactions
+============
+
+Transactions are an additional way to think about orders. They are are an immutable, filterable view into an order's
+history and are a good basis for financial reporting.
+
+Our financial model
+-------------------
+
+You can think of a pretix order similar to a debtor account in double-entry bookkeeping. For example, the flow of an
+order could look like this:
+
+===================================================== ==================== =====================
+Transaction                                           Debit                Credit
+===================================================== ==================== =====================
+Order is placed with two tickets                      € 500
+Order is paid partially with a gift card                                   € 200
+Remainder is paid with a credit card                                       € 300
+One of the tickets is canceled                        **-** € 250
+Refund is made to the credit card                                          **-** € 250
+**Balance**                                           **€ 250**            **€ 250**
+===================================================== ==================== =====================
+
+If an order is fully settled, the sums of both columns match. However, as the movements in both columns do not always
+happen at the same time, at some times during the lifecycle of an order the sums are not balanced, in which case we
+consider an order to be "pending payment" or "overpaid".
+
+In the API, the "Debit" column is represented by the "transaction" resource listed on this page.
+In many cases, the left column *usually* also matches the data returned by the :ref:`rest-invoices` resource, but there
+are two important differences:
+
+- pretix may be configured such that an invoice is not always generated for an order. In this case, only the transactions
+  return the full data set.
+
+- pretix does not enforce a new invoice to be created e.g. when a ticket is changed to a different subevent. However,
+  pretix always creates a new transaction whenever there is a change to a ticket that concerns the **price**, **tax rate**,
+  **product**, or **date** (in an event series).
+
+The :ref:`rest-orders` themselves are not a good representation of the "Debit" side of the table for accounting
+purposes since they are not immutable:
+They will only tell you the current state of the order, not what it was a week ago.
+
+The "Credit" column is represented by the :ref:`order-payment-resource` and :ref:`order-refund-resource`.
+
+
+Resource description
+--------------------
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of the transaction
+order                                 string                     Order code the transaction was created from
+event                                 string                     Event slug, only present on organizer-level API calls
+created                               datetime                   The creation time of the transaction in the database
+datetime                              datetime                   The time at which the transaction is financially relevant.
+                                                                 This is usually the same as created, but may vary for
+                                                                 retroactively created transactions after software bugs or
+                                                                 for data that preceeds this data model.
+positionid                            integer                    Number of the position within the order this refers to,
+                                                                 is ``null`` for transactions that refer to a fee
+count                                 integer                    Number of items purchased, is negative for cancellations
+item                                  integer                    The internal ID of the item purchased (or ``null`` for fees)
+variation                             integer                    The internal ID of the variation purchased (or ``null``)
+subevent                              integer                    The internal ID of the event series date (or ``null``)
+price                                 money (string)             Gross price of the transaction
+tax_rate                              decimal (string)           Tax rate applied in transaction
+tax_rule                              integer                    The internal ID of the tax rule used (or ``null``)
+tax_code                              string                     The selected tax code (or ``null``)
+tax_value                             money (string)             The computed tax value
+fee_type                              string                     The type of fee (or ``null`` for products)
+internal_type                         string                     Additional type classification of the fee (or ``null`` for products)
+===================================== ========================== =======================================================
+
+.. versionchanged:: 2025.7.0
+
+   This resource was added to the API.
+
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/transactions/
+
+   Returns a list of all transactions of an event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/transactions/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "id": 123,
+            "order": "FOO",
+            "count": 1,
+            "created": "2017-12-01T10:00:00Z",
+            "datetime": "2017-12-01T10:00:00Z",
+            "item": null,
+            "variation": null,
+            "positionid": 1,
+            "price": "23.00",
+            "subevent": null,
+            "tax_code": "E",
+            "tax_rate": "0.00",
+            "tax_rule": 23,
+            "tax_value": "0.00",
+            "fee_type": null,
+            "internal_type": null
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :query string order: Only return transactions matching the given order code.
+   :query datetime_since: Only return transactions with a datetime at or after the given time.
+   :query datetime_before: Only return transactions with a datetime before the given time.
+   :query created_since: Only return transactions with a creation time at or after the given time.
+   :query created_before: Only return transactions with a creation time before the given time.
+   :query item: Only return transactions that match the given item ID.
+   :query item__in: Only return transactions that match one of the given item IDs (separated with a comma).
+   :query variation: Only return transactions that match the given variation ID.
+   :query variation__in: Only return transactions that match one of the given variation IDs (separated with a comma).
+   :query subevent: Only return transactions that match the given subevent ID.
+   :query subevent__in: Only return transactions that match one of the given subevent IDs (separated with a comma).
+   :query tax_rule: Only return transactions that match the given tax rule ID.
+   :query tax_rule__in: Only return transactions that match one of the given tax rule IDs (separated with a comma).
+   :query tax_code: Only return transactions that match the given tax code.
+   :query tax_code__in: Only return transactions that match one of the given tax codes (separated with a comma).
+   :query tax_rate: Only return transactions that match the given tax rate.
+   :query tax_rate__in: Only return transactions that match one of the given tax rates (separated with a comma).
+   :query fee_type: Only return transactions that match the given fee type.
+   :query fee_type__in: Only return transactions that match one of the given fee types (separated with a comma).
+   :query string ordering: Manually set the ordering of results. Valid fields to be used are ``datetime``, ``created``, and ``id``.
+   :param organizer: The ``slug`` field of a valid organizer
+   :param event: The ``slug`` field of a valid event
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer or event does not exist **or** you have no permission to view it.
+
+.. http:get:: /api/v1/organizers/(organizer)/transactions/
+
+   Returns a list of all transactions of an organizer that you have access to.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/transactions/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "id": 123,
+            "event": "sampleconf",
+            "order": "FOO",
+            "count": 1,
+            "created": "2017-12-01T10:00:00Z",
+            "datetime": "2017-12-01T10:00:00Z",
+            "item": null,
+            "variation": null,
+            "positionid": 1,
+            "price": "23.00",
+            "subevent": null,
+            "tax_code": "E",
+            "tax_rate": "0.00",
+            "tax_rule": 23,
+            "tax_value": "0.00",
+            "fee_type": null,
+            "internal_type": null
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :query string event: Only return transactions matching the given event slug.
+   :query string order: Only return transactions matching the given order code.
+   :query datetime_since: Only return transactions with a datetime at or after the given time.
+   :query datetime_before: Only return transactions with a datetime before the given time.
+   :query created_since: Only return transactions with a creation time at or after the given time.
+   :query created_before: Only return transactions with a creation time before the given time.
+   :query item: Only return transactions that match the given item ID.
+   :query item__in: Only return transactions that match one of the given item IDs (separated with a comma).
+   :query variation: Only return transactions that match the given variation ID.
+   :query variation__in: Only return transactions that match one of the given variation IDs (separated with a comma).
+   :query subevent: Only return transactions that match the given subevent ID.
+   :query subevent__in: Only return transactions that match one of the given subevent IDs (separated with a comma).
+   :query tax_rule: Only return transactions that match the given tax rule ID.
+   :query tax_rule__in: Only return transactions that match one of the given tax rule IDs (separated with a comma).
+   :query tax_code: Only return transactions that match the given tax code.
+   :query tax_code__in: Only return transactions that match one of the given tax codes (separated with a comma).
+   :query tax_rate: Only return transactions that match the given tax rate.
+   :query tax_rate__in: Only return transactions that match one of the given tax rates (separated with a comma).
+   :query fee_type: Only return transactions that match the given fee type.
+   :query fee_type__in: Only return transactions that match one of the given fee types (separated with a comma).
+   :query string ordering: Manually set the ordering of results. Valid fields to be used are ``datetime``, ``created``, and ``id``.
+   :param organizer: The ``slug`` field of a valid organizer
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view it.

doc/api/resources/vouchers.rst

@@ -14,6 +14,7 @@ The voucher resource contains the following public fields:
 Field                                 Type                       Description
 ===================================== ========================== =======================================================
 id                                    integer                    Internal ID of the voucher
+created                               datetime                   The creation date of the voucher. For vouchers created before pretix 2025.7.0, this is guessed retroactively and might not be accurate.
 code                                  string                     The voucher code that is required to redeem the voucher
 max_usages                            integer                    The maximum number of times this voucher can be
                                                                  redeemed (default: 1).
@@ -49,8 +50,14 @@ subevent                              integer                    ID of the date
 show_hidden_items                     boolean                    Only if set to ``true``, this voucher allows to buy products with the property ``hide_without_voucher``. Defaults to ``true``.
 all_addons_included                   boolean                    If set to ``true``, all add-on products for the product purchased with this voucher are included in the base price.
 all_bundles_included                  boolean                    If set to ``true``, all bundled products for the product purchased with this voucher are added without their designated price.
+budget                                money (string)             The budget a voucher is allowed to consume before being used up (or ``null``)
+budget_used                           money (string)             The amount of budget the voucher has already used up.
 ===================================== ========================== =======================================================
 
+.. versionchanged:: 2025.7
+
+    The attributes ``created``, ``budget``, and ``budget_used`` have been added.
+
 
 Endpoints
 ---------
@@ -82,6 +89,7 @@ Endpoints
         "results": [
           {
             "id": 1,
+            "created": "2020-09-18T14:17:40.971519Z",
             "code": "43K6LKM37FBVR2YG",
             "max_usages": 1,
             "redeemed": 0,
@@ -99,7 +107,9 @@ Endpoints
             "subevent": null,
             "show_hidden_items": false,
             "all_addons_included": false,
-            "all_bundles_included": false
+            "all_bundles_included": false,
+            "budget": None,
+            "budget_used": "0.00"
           }
         ]
       }
@@ -152,6 +162,7 @@ Endpoints
 
       {
         "id": 1,
+        "created": "2020-09-18T14:17:40.971519Z",
         "code": "43K6LKM37FBVR2YG",
         "max_usages": 1,
         "redeemed": 0,
@@ -169,7 +180,9 @@ Endpoints
         "subevent": null,
         "show_hidden_items": false,
         "all_addons_included": false,
-        "all_bundles_included": false
+        "all_bundles_included": false,
+        "budget": None,
+        "budget_used": "0.00"
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -222,6 +235,7 @@ Endpoints
 
       {
         "id": 1,
+        "created": "2020-09-18T14:17:40.971519Z",
         "code": "43K6LKM37FBVR2YG",
         "max_usages": 1,
         "redeemed": 0,
@@ -239,7 +253,9 @@ Endpoints
         "subevent": null,
         "show_hidden_items": false,
         "all_addons_included": false,
-        "all_bundles_included": false
+        "all_bundles_included": false,
+        "budget": None,
+        "budget_used": "0.00"
       }
 
    :param organizer: The ``slug`` field of the organizer to create a voucher for
@@ -313,6 +329,7 @@ Endpoints
       [
         {
           "id": 1,
+          "created": "2020-09-18T14:17:40.971519Z",
           "code": "43K6LKM37FBVR2YG",
           …
         }, …
@@ -359,6 +376,7 @@ Endpoints
 
       {
         "id": 1,
+        "created": "2020-09-18T14:17:40.971519Z",
         "code": "43K6LKM37FBVR2YG",
         "max_usages": 1,
         "redeemed": 0,
@@ -376,7 +394,9 @@ Endpoints
         "subevent": null,
         "show_hidden_items": false,
         "all_addons_included": false,
-        "all_bundles_included": false
+        "all_bundles_included": false,
+        "budget": None,
+        "budget_used": "0.00"
       }
 
    :param organizer: The ``slug`` field of the organizer to modify

doc/api/resources/webhooks.rst

@@ -41,6 +41,7 @@ The following values for ``action_types`` are valid with pretix core:
     * ``pretix.event.order.modified``
     * ``pretix.event.order.contact.changed``
     * ``pretix.event.order.changed.*``
+    * ``pretix.event.order.deleted`` (can only occur for test mode orders)
     * ``pretix.event.order.refund.created``
     * ``pretix.event.order.refund.created.externally``
     * ``pretix.event.order.refund.requested``
@@ -59,6 +60,12 @@ The following values for ``action_types`` are valid with pretix core:
     * ``pretix.event.added``
     * ``pretix.event.changed``
     * ``pretix.event.deleted``
+    * ``pretix.giftcards.created``
+    * ``pretix.giftcards.modified``
+    * ``pretix.giftcards.transaction.*``
+    * ``pretix.voucher.added``
+    * ``pretix.voucher.changed``
+    * ``pretix.voucher.deleted``
     * ``pretix.subevent.added``
     * ``pretix.subevent.changed``
     * ``pretix.subevent.deleted``
@@ -67,6 +74,9 @@ The following values for ``action_types`` are valid with pretix core:
     * ``pretix.event.live.deactivated``
     * ``pretix.event.testmode.activated``
     * ``pretix.event.testmode.deactivated``
+    * ``pretix.customer.created``
+    * ``pretix.customer.changed``
+    * ``pretix.customer.anonymized``
 
 Installed plugins might register more valid values.
 
@@ -112,6 +122,7 @@ Endpoints
       }
 
    :query integer page: The page number in case of a multi-page result set, default is 1
+   :query boolean enabled: Only show webhooks that are or are not enabled
    :param organizer: The ``slug`` field of the organizer to fetch
    :statuscode 200: no error
    :statuscode 401: Authentication failure

doc/conf.py

@@ -69,7 +69,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = 'pretix'
-copyright = '2014-{}, Raphael Michel'.format(date.today().year)
+copyright = '2014-{}, rami.io GmbH'.format(date.today().year)
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -233,8 +233,8 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    ('index', 'pretix.tex', 'pretix Documentation',
-     'Raphael Michel', 'manual'),
+    ('index', 'pretix.tex', 'pretix Developer Documentation',
+     'rami.io GmbH', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -263,8 +263,8 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'pretix', 'pretix Documentation',
-     ['Raphael Michel'], 1)
+    ('index', 'pretix', 'pretix Developer Documentation',
+     ['rami.io GmbH'], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -277,8 +277,8 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'pretix', 'pretix Documentation',
-     'Raphael Michel', 'pretix', 'One line description of project.',
+    ('index', 'pretix', 'pretix Developer Documentation',
+     'rami.io GmbH', 'pretix', 'One line description of project.',
      'Miscellaneous'),
 ]
 

doc/contents.rst

@@ -4,10 +4,6 @@ Table of contents
 .. toctree::
    :maxdepth: 3
 
-   user/index
-   admin/index
    api/index
    development/index
-   plugins/index
-   license/faq
 

doc/development/algorithms/pricing.rst

@@ -178,3 +178,124 @@ Flowchart
 ---------
 
 .. image:: /images/cart_pricing.png
+
+
+.. _`algorithms-rounding`:
+
+Rounding of taxes
+-----------------
+
+pretix internally always stores taxes on a per-line level, like this:
+
+ ========== ========== =========== ======= =============
+   Product   Tax rate   Net price     Tax   Gross price
+ ========== ========== =========== ======= =============
+  Ticket A       19 %       84.03   15.97        100.00
+  Ticket B       19 %       84.03   15.97        100.00
+  Ticket C       19 %       84.03   15.97        100.00
+  Ticket D       19 %       84.03   15.97        100.00
+  Ticket E       19 %       84.03   15.97        100.00
+       Sum                 420.15   79.85        500.00
+ ========== ========== =========== ======= =============
+
+Whether the net price is computed from the gross price or vice versa is configured on the tax rule and may differ for every line.
+
+The line-based computation has a few significant advantages:
+
+- We can report both net and gross prices for every individual ticket.
+
+- We can report both net and gross prices for every filter imaginable, such as the gross sum of all sales of Ticket A
+  or the net sum of all sales for a specific date in an event series. All numbers will be exact.
+
+- When splitting the order into two, both net price and gross price are split without any changes in rounding.
+
+The main disadvantage is that the tax looks "wrong" when computed from the sum. Taking the sum of net prices (420.15)
+and multiplying it with the tax rate (19%) yields a tax amount of 79.83 (instead of 79.85) and a gross sum of 499.98
+(instead of 500.00). This becomes a problem when juristictions, data formats, or external systems expect this calculation
+to work on the level of the entire order. A prominent example is the EN 16931 standard for e-invoicing that
+does not allow the computation as created by pretix.
+
+However, calculating the tax rate from the net total has significant disadvantages:
+
+- It is impossible to guarantee a stable gross price this way, i.e. if you advertise a price of €100 per ticket to
+  consumers, they will be confused when they only need to pay €499.98 for 5 tickets.
+
+- Some prices are impossible, e.g. you cannot sell a ticket for a gross price of €99.99 at a 19% tax rate, since there
+  is no two-decimal net price that would be computed to a gross price of €99.99.
+
+- When splitting an order into two, the combined of the new orders is not guaranteed to be the same as the total of the
+  original order. Therefore, additional payments or refunds of very small amounts might be necessary.
+
+To allow organizers to make their own choices on this matter, pretix provides the following options:
+
+Compute taxes for every line individually
+"""""""""""""""""""""""""""""""""""""""""
+
+Algorithm identifier: ``line``
+
+This is our original algorithm where the tax value is rounded for every line individually.
+
+**This is our current default algorithm and we recommend it whenever you do not have different requirements** (see below).
+For the example above:
+
+ ========== ========== =========== ======= =============
+   Product   Tax rate   Net price     Tax   Gross price
+ ========== ========== =========== ======= =============
+  Ticket A       19 %       84.03   15.97        100.00
+  Ticket B       19 %       84.03   15.97        100.00
+  Ticket C       19 %       84.03   15.97        100.00
+  Ticket D       19 %       84.03   15.97        100.00
+  Ticket E       19 %       84.03   15.97        100.00
+       Sum                 420.15   79.85        500.00
+ ========== ========== =========== ======= =============
+
+
+Compute taxes based on net total
+""""""""""""""""""""""""""""""""
+
+Algorithm identifier: ``sum_by_net``
+
+In this algorithm, the tax value and gross total are computed from the sum of the net prices. To accomplish this within
+our data model, the gross price and tax of some of the tickets will be changed by the minimum currency unit (e.g. €0.01).
+The net price of the tickets always stay the same.
+
+**This is the algorithm intended by EN 16931 invoices and our recommendation to use for e-invoicing when (primarily) business customers are involved.**
+
+The main downside is that it might be confusing when selling to consumers, since the amounts to be paid change in unexpected ways.
+For the example above, the customer expects to pay 5 times 100.00, but they are are in fact charged 499.98:
+
+ ========== ========== =========== ============================== ==============================
+   Product   Tax rate   Net price                            Tax                    Gross price
+ ========== ========== =========== ============================== ==============================
+  Ticket A       19 %       84.03   15.96 (incl. -0.01 rounding)   99.99 (incl. -0.01 rounding)
+  Ticket B       19 %       84.03   15.96 (incl. -0.01 rounding)   99.99 (incl. -0.01 rounding)
+  Ticket C       19 %       84.03                          15.97                         100.00
+  Ticket D       19 %       84.03                          15.97                         100.00
+  Ticket E       19 %       84.03                          15.97                         100.00
+       Sum                 420.15                          78.83                         499.98
+ ========== ========== =========== ============================== ==============================
+
+Compute taxes based on net total with stable gross prices
+"""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+Algorithm identifier: ``sum_by_net_keep_gross``
+
+In this algorithm, the tax value and gross total are computed from the sum of the net prices. However, the net prices
+of some of the tickets will be changed automatically by the minimum currency unit (e.g. €0.01) such that the resulting
+gross prices stay the same.
+
+**This is less confusing to consumers and the end result is still compliant to EN 16931, so we recommend this for e-invoicing when (primarily) consumers are involved.**
+
+The main downside is that it might be confusing when selling to business customers, since the prices of the identical tickets appear to be different.
+Full computation for the example above:
+
+ ========== ========== ============================= ============================== =============
+   Product   Tax rate                     Net price                            Tax   Gross price
+ ========== ========== ============================= ============================== =============
+  Ticket A       19 %   84.04 (incl. 0.01 rounding)   15.96 (incl. -0.01 rounding)        100.00
+  Ticket B       19 %   84.04 (incl. 0.01 rounding)   15.96 (incl. -0.01 rounding)        100.00
+  Ticket C       19 %                         84.03                          15.97        100.00
+  Ticket D       19 %                         84.03                          15.97        100.00
+  Ticket E       19 %                         84.03                          15.97        100.00
+       Sum                                   420.17                          79.83        500.00
+ ========== ========== ============================= ============================== =============

doc/development/api/cookieconsent.rst

@@ -17,6 +17,7 @@ First, you need to declare that you are using non-essential cookies by respondin
 signal:
 
 .. automodule:: pretix.presale.signals
+   :no-index:
    :members: register_cookie_providers
 
 You are expected to return a list of ``CookieProvider`` objects instantiated from the following class:

doc/development/api/customview.rst

@@ -178,13 +178,6 @@ You can then implement a view as you would normally do. It will be automatically
 * Your plugin is enabled
 * The locale is set correctly
 
-.. versionchanged:: 1.7
-
-   The ``event_url()`` wrapper has been added in 1.7 to replace the former ``@event_view`` decorator. The
-   ``event_url()`` wrapper is optional and using ``url()`` still works, but you will not be able to set the
-   ``require_live`` setting any more via the decorator. The ``@event_view`` decorator is now deprecated and
-   does nothing.
-
 REST API viewsets
 -----------------
 

doc/development/api/datasync.rst

@@ -0,0 +1,207 @@
+.. highlight:: python
+   :linenothreshold: 5
+
+Data sync providers
+===================
+
+.. warning:: This feature is considered **experimental**. It might change at any time without prior notice.
+
+pretix provides connectivity to many external services through plugins. A common requirement
+is unidirectionally sending (order, customer, ticket, ...) data into external systems.
+The transfer is usually triggered by signals provided by pretix core (e.g. :data:`order_placed`),
+but performed asynchronously.
+
+Such plugins should use the :class:`OutboundSyncProvider` API to utilize the queueing, retry and mapping 
+mechanisms as well as the user interface for configuration and monitoring. Sync providers are registered 
+in the :py:attr:`pretix.base.datasync.datasync.datasync_providers` :ref:`registry <registries>`.
+
+An :class:`OutboundSyncProvider` for subscribing event participants to a mailing list could start
+like this, for example:
+
+.. code-block:: python
+
+    from pretix.base.datasync.datasync import (OutboundSyncProvider, datasync_providers)
+
+    @datasync_providers.register
+    class MyListSyncProvider(OutboundSyncProvider):
+        identifier = "my_list"
+        display_name = "My Mailing List Service"
+        # ...
+
+
+The plugin must register listeners in `signals.py` for all signals that should to trigger a sync and
+within it has to call :meth:`MyListSyncProvider.enqueue_order` to enqueue the order for synchronization:
+
+.. code-block:: python
+
+    @receiver(order_placed, dispatch_uid="mylist_order_placed")
+    def on_order_placed(sender, order, **kwargs):
+        MyListSyncProvider.enqueue_order(order, "order_placed")
+
+
+Property mappings
+-----------------
+
+Most of these plugins need to translate data from some pretix objects (e.g. orders)
+into an external system's data structures. Sometimes, there is only one reasonable way or the
+plugin author makes an opinionated decision what information from which objects should be
+transferred into which data structures in the external system.
+
+Otherwise, you can use a :class:`PropertyMappingFormSet` to let the user set up a mapping from pretix model fields
+to external data fields. You could store the mapping information either in the event settings, or in a separate
+data model. Your implementation of :attr:`OutboundSyncProvider.mappings`
+needs to provide a list of mappings, which can be e.g. static objects or model instances, as long as they
+have at least the properties defined in
+:class:`pretix.base.datasync.datasync.StaticMapping`.
+
+.. code-block:: python
+
+    # class MyListSyncProvider, contd.
+        def mappings(self):
+            return [
+                StaticMapping(
+                    id=1, pretix_model='Order', external_object_type='Contact',
+                    pretix_id_field='email', external_id_field='email',
+                    property_mappings=self.event.settings.mylist_order_mapping,
+                ))
+            ]
+
+
+Currently, we support `orders` and `order positions` as data sources, with the data fields defined in
+:func:`pretix.base.datasync.sourcefields.get_data_fields`.
+
+To perform the actual sync, implement :func:`sync_object_with_properties` and optionally
+:func:`finalize_sync_order`. The former is called for each object to be created according to the ``mappings``.
+For each order that was enqueued using :func:`enqueue_order`:
+
+- each Mapping with ``pretix_model == "Order"`` results in one call to :func:`sync_object_with_properties`,
+- each Mapping with ``pretix_model == "OrderPosition"`` results in one call to
+  :func:`sync_object_with_properties` per order position,
+- :func:`finalize_sync_order` is called one time after all calls to :func:`sync_object_with_properties`.
+
+
+Implementation examples
+-----------------------
+
+For example implementations, see the test cases in :mod:`tests.base.test_datasync`.
+
+In :class:`SimpleOrderSync`, a basic data transfer of order data only is
+shown. Therein, a ``sync_object_with_properties`` method is defined as follows:
+
+.. code-block:: python
+
+    from pretix.base.datasync.utils import assign_properties
+
+    # class MyListSyncProvider, contd.
+    def sync_object_with_properties(
+            self, external_id_field, id_value, properties: list, inputs: dict,
+            mapping, mapped_objects: dict, **kwargs,
+    ):
+        # First, we query the external service if our object-to-sync already exists there.
+        # This is necessary to make sure our method is idempotent, i.e. handles already synced
+        # data gracefully.
+        pre_existing_object = self.fake_api_client.retrieve_object(
+            mapping.external_object_type,
+            external_id_field,
+            id_value
+        )
+
+        # We use the helper function ``assign_properties`` to update a pre-existing object.
+        update_values = assign_properties(
+            new_values=properties,
+            old_values=pre_existing_object or {},
+            is_new=pre_existing_object is None,
+            list_sep=";",
+        )
+
+        # Then we can send our new data to the external service. The specifics of course depends
+        # on your API, e.g. you may need to use different endpoints for creating or updating an
+        # object, or pass the identifier separately instead of in the same dictionary as the
+        # other properties.
+        result = self.fake_api_client.create_or_update_object(mapping.external_object_type, {
+            **update_values,
+            external_id_field: id_value,
+            "_id": pre_existing_object and pre_existing_object.get("_id"),
+        })
+
+        # Finally, return a dictionary containing at least `object_type`, `external_id_field`,
+        # `id_value`, `external_link_href`, and `external_link_display_name` keys.
+        # Further keys may be provided for your internal use. This dictionary is provided
+        # in following calls in the ``mapped_objects`` dict, to allow creating associations
+        # to this object.
+        return {
+            "object_type": mapping.external_object_type,
+            "external_id_field": external_id_field,
+            "id_value": id_value,
+            "external_link_href": f"https://example.org/external-system/{mapping.external_object_type}/{id_value}/",
+            "external_link_display_name": f"Contact #{id_value} - Jane Doe",
+            "my_result": result,
+        }
+
+.. note:: The result dictionaries of earlier invocations of :func:`sync_object_with_properties` are
+          only provided in subsequent calls of the same sync run, such that a mapping can
+          refer to e.g. the external id of an object created by a preceding mapping.
+          However, the result dictionaries are currently not provided across runs. This will
+          likely change in a future revision of this API, to allow easier integration of external
+          systems that do not allow retrieving/updating data by a pretix-provided key.
+
+``mapped_objects`` is a dictionary of lists of dictionaries. The keys to the dictionary are
+the mapping identifiers (``mapping.id``), the lists contain the result dictionaries returned
+by :func:`sync_object_with_properties`.
+
+
+In :class:`OrderAndTicketAssociationSync`, an example is given where orders, order positions,
+and the association between them are transferred.
+
+
+The OutboundSyncProvider base class
+-----------------------------------
+
+.. autoclass:: pretix.base.datasync.datasync.OutboundSyncProvider
+   :members:
+
+
+Property mapping format
+-----------------------
+
+To allow the user to configure property mappings, you can use the PropertyMappingFormSet,
+which will generate the required ``property_mappings`` value automatically. If you need
+to specify the property mappings programmatically, you can refer to the description below
+on their format.
+
+.. autoclass:: pretix.control.forms.mapping.PropertyMappingFormSet
+   :members: to_property_mappings_json
+
+A simple JSON-serialized ``property_mappings`` list for mapping some order information can look like this:
+
+.. code-block:: json
+
+      [
+        {
+            "pretix_field": "email",
+            "external_field": "orderemail",
+            "value_map": "",
+            "overwrite": "overwrite",
+        },
+        {
+            "pretix_field": "order_status",
+            "external_field": "status",
+            "value_map": "{\"n\": \"pending\", \"p\": \"paid\", \"e\": \"expired\", \"c\": \"canceled\", \"r\": \"refunded\"}",
+            "overwrite": "overwrite",
+        },
+        {
+            "pretix_field": "order_total",
+            "external_field": "total",
+            "value_map": "",
+            "overwrite": "overwrite",
+        }
+      ]
+
+
+Translating mappings on Event copy
+----------------------------------
+
+Property mappings can contain references to event-specific primary keys. Therefore, plugins must register to the
+event_copy_data signal and call translate_property_mappings on all property mappings they store.
+
+.. autofunction:: pretix.base.datasync.utils.translate_property_mappings

doc/development/api/general.rst

@@ -11,9 +11,10 @@ Core
 ----
 
 .. automodule:: pretix.base.signals
-   :members: periodic_task, event_live_issues, event_copy_data, email_filter, register_notification_types,
-      item_copy_data, register_sales_channels, register_global_settings, quota_availability, global_email_filter,
-      register_ticket_secret_generators, gift_card_transaction_display
+   :members: periodic_task, event_live_issues, event_copy_data, email_filter, register_notification_types, notification,
+      item_copy_data, register_sales_channel_types, register_global_settings, quota_availability, global_email_filter,
+      register_ticket_secret_generators, gift_card_transaction_display,
+      register_text_placeholders, register_mail_placeholders, device_info_updated
 
 Order events
 """"""""""""
@@ -21,35 +22,40 @@ Order events
 There are multiple signals that will be sent out in the ordering cycle:
 
 .. automodule:: pretix.base.signals
-   :members: validate_cart, validate_cart_addons, validate_order, order_valid_if_pending, order_fee_calculation, order_paid, order_placed, order_canceled, order_reactivated, order_expired, order_modified, order_changed, order_approved, order_denied, order_fee_type_name, allow_ticket_download, order_split, order_gracefully_delete, invoice_line_text
+   :no-index:
+   :members: validate_cart, validate_cart_addons, validate_order, order_valid_if_pending, order_fee_calculation, order_paid, order_placed, order_canceled, order_reactivated, order_expired, order_expiry_changed, order_modified, order_changed, order_approved, order_denied, order_fee_type_name, allow_ticket_download, order_split, order_gracefully_delete, build_invoice_data, invoice_line_text
 
 Check-ins
 """""""""
 
 .. automodule:: pretix.base.signals
-   :members: checkin_created
+   :no-index:
+   :members: checkin_created, checkin_annulled
 
 
 Frontend
 --------
 
 .. automodule:: pretix.presale.signals
-   :members: html_head, html_footer, footer_link, global_footer_link, front_page_top, front_page_bottom, front_page_bottom_widget, fee_calculation_for_cart, contact_form_fields, question_form_fields, contact_form_fields_overrides, question_form_fields_overrides, checkout_confirm_messages, checkout_confirm_page_content, checkout_all_optional, html_page_header, sass_preamble, sass_postamble, render_seating_plan, checkout_flow_steps, position_info, position_info_top, item_description, global_html_head, global_html_footer, global_html_page_header
+   :members: html_head, html_footer, footer_link, global_footer_link, front_page_top, front_page_bottom, front_page_bottom_widget, fee_calculation_for_cart, contact_form_fields, question_form_fields, contact_form_fields_overrides, question_form_fields_overrides, checkout_confirm_messages, checkout_confirm_page_content, checkout_all_optional, html_page_header, render_seating_plan, checkout_flow_steps, position_info, position_info_top, item_description, global_html_head, global_html_footer, global_html_page_header, seatingframe_html_head, filter_subevents
 
 
 .. automodule:: pretix.presale.signals
-   :members: order_info, order_info_top, order_meta_from_request
+   :no-index:
+   :members: order_info, order_info_top, order_meta_from_request, order_api_meta_from_request
 
 Request flow
 """"""""""""
 
 .. automodule:: pretix.presale.signals
+   :no-index:
    :members: process_request, process_response
 
 Vouchers
 """"""""
 
 .. automodule:: pretix.presale.signals
+   :no-index:
    :members: voucher_redeem_info
 
 Backend
@@ -61,24 +67,28 @@ Backend
              item_formsets, order_search_filter_q, order_search_forms
 
 .. automodule:: pretix.base.signals
+   :no-index:
    :members: logentry_display, logentry_object_link, requiredaction_display, timeline_events, orderposition_blocked_display, customer_created, customer_signed_in
 
 Vouchers
 """"""""
 
 .. automodule:: pretix.control.signals
+   :no-index:
    :members: item_forms, voucher_form_class, voucher_form_html, voucher_form_validation
 
 Dashboards
 """"""""""
 
 .. automodule:: pretix.control.signals
+   :no-index:
    :members: event_dashboard_widgets, user_dashboard_widgets, event_dashboard_top
 
 Ticket designs
 """"""""""""""
 
 .. automodule:: pretix.base.signals
+   :no-index:
    :members: layout_text_variables, layout_image_variables
 
 .. automodule:: pretix.plugins.ticketoutputpdf.signals
@@ -88,4 +98,9 @@ API
 ---
 
 .. automodule:: pretix.base.signals
+   :no-index:
    :members: validate_event_settings, api_event_settings_fields
+
+.. automodule:: pretix.api.signals
+   :no-index:
+   :members: register_device_security_profile, order_api_details, orderposition_api_details

doc/development/api/import.rst

@@ -3,11 +3,12 @@
 
 .. _`importcol`:
 
-Extending the order import process
-==================================
+Extending the import process
+============================
 
-It's possible through the backend to import orders into pretix, for example from a legacy ticketing system. If your
-plugins defines additional data structures around orders, it might be useful to make it possible to import them as well.
+It's possible through the backend to import objects into pretix, for example orders from a legacy ticketing system. If
+your plugin defines additional data structures around those objects, it might be useful to make it possible to import
+them as well.
 
 Import process
 --------------
@@ -40,7 +41,7 @@ Column registration
 
 The import API does not make a lot of usage from signals, however, it
 does use a signal to get a list of all available import columns. Your plugin
-should listen for this signal and return the subclass of ``pretix.base.orderimport.ImportColumn``
+should listen for this signal and return the subclass of ``pretix.base.modelimport.ImportColumn``
 that we'll provide in this plugin:
 
 .. sourcecode:: python
@@ -56,10 +57,17 @@ that we'll provide in this plugin:
             EmailColumn(sender),
         ]
 
+Similar signals exist for other objects:
+
+.. automodule:: pretix.base.signals
+   :no-index:
+   :members: voucher_import_columns
+
+
 The column class API
 --------------------
 
-.. class:: pretix.base.orderimport.ImportColumn
+.. class:: pretix.base.modelimport.ImportColumn
 
    The central object of each import extension is the subclass of ``ImportColumn``.
 

doc/development/api/index.rst

@@ -10,14 +10,15 @@ Contents:
    exporter
    ticketoutput
    payment
-   payment_2.0
    email
    placeholder
    invoice
+   invoicetransmission
    shredder
    import
    customview
    cookieconsent
    auth
+   datasync
    general
    quality

doc/development/api/invoicetransmission.rst

@@ -0,0 +1,65 @@
+.. highlight:: python
+   :linenothreshold: 5
+
+Writing an invoice transmission plugin
+======================================
+
+An invoice transmission provider transports an invoice from the sender to the recipient.
+There are pre-defined types of invoice transmission in pretix, currently ``"email"``, ``"peppol"``, and ``"it_sdi"``.
+You can find more information about them at :ref:`rest-transmission-types`.
+
+New transmission types can not be added by plugins but need to be added to pretix itself.
+However, plugins can provide implementations for the actual transmission.
+Please read :ref:`Creating a plugin <pluginsetup>` first, if you haven't already.
+
+Output registration
+-------------------
+
+New invoice transmission providers can be registered through the :ref:`registry <registries>` mechanism
+
+.. code-block:: python
+
+   from pretix.base.invoicing.transmission import transmission_providers, TransmissionProvider
+
+   @transmission_providers.new()
+   class SdiTransmissionProvider(TransmissionProvider):
+       identifier = "fatturapa_providerabc"
+       type = "it_sdi"
+       verbose_name = _("FatturaPA through provider ABC")
+       ...
+
+
+The provider class
+------------------
+
+.. class:: pretix.base.invoicing.transmission.TransmissionProvider
+
+   .. autoattribute:: identifier
+
+      This is an abstract attribute, you **must** override this!
+
+   .. autoattribute:: type
+
+      This is an abstract attribute, you **must** override this!
+
+   .. autoattribute:: verbose_name
+
+      This is an abstract attribute, you **must** override this!
+
+   .. autoattribute:: priority
+
+   .. autoattribute:: testmode_supported
+
+   .. automethod:: is_ready
+
+      This is an abstract method, you **must** override this!
+
+   .. automethod:: is_available
+
+      This is an abstract method, you **must** override this!
+
+   .. automethod:: transmit
+
+      This is an abstract method, you **must** override this!
+
+   .. automethod:: settings_url

doc/development/api/payment_2.0.rst

@@ -1,129 +0,0 @@
-.. highlight:: python
-   :linenothreshold: 5
-
-.. _`payment2.0`:
-
-Porting a payment provider from pretix 1.x to pretix 2.x
-========================================================
-
-In pretix 2.x, we changed large parts of the payment provider API. This documentation details the changes we made
-and shows you how you can make an existing pretix 1.x payment provider compatible with pretix 2.x
-
-Conceptual overview
--------------------
-
-In pretix 1.x, an order was always directly connected to a payment provider for the full life of an order. As long as
-an order was unpaid, this could still be changed in some cases, but once an order was paid, no changes to the payment
-provider were possible any more. Additionally, the internal state of orders allowed orders only to be fully paid or
-not paid at all. This leads to a couple of consequences:
-
-* Payment-related functions (like "execute payment" or "do a refund") always operated on full orders.
-
-* Changing the total of an order was basically impossible once an order was paid, since there was no concept of
-  partial payments or partial refunds.
-
-* Payment provider plugins needed to take complicated steps to detect cases that require human intervention, like e.g.
-
-  * An order has expired, no quota is left to revive it, but a payment has been received
-
-  * A payment has been received for a canceled order
-
-  * A payment has been received for an order that has already been paid with a different payment method
-
-  * An external payment service notified us of a refund/dispute
-
-  We noticed that we copied and repeated large portions of code in all our official payment provider plugins, just
-  to deal with some of these cases.
-
-* Sometimes, there is the need to mark an order as refunded within pretix, without automatically triggering a refund
-  with an external API. Every payment method needed to implement a user interface for this independently.
-
-* If a refund was not possible automatically, there was no way user to track which payments actually have been refunded
-  manually and which are still left to do.
-
-* When the payment with one payment provider failed and the user changed to a different payment provider, all
-  information about the first payment was lost from the order object and could only be retrieved from order log data,
-  which also made it hard to design a data shredder API to get rid of this data.
-
-In pretix 2.x, we introduced two new models, :py:class:`OrderPayment <pretix.base.models.OrderPayment>` and
-:py:class:`OrderRefund <pretix.base.models.OrderRefund>`. Each instance of these is connected to an order and
-represents one single attempt to pay or refund a specific amount of money. Each one of these has an individual state,
-can individually fail or succeed, and carries an amount variable that can differ from the order total.
-
-This has the following advantages:
-
-* The system can now detect orders that are over- or underpaid, independent of the payment providers in use.
-
-* Therefore, we can now allow partial payments, partial refunds, and changing paid orders, and automatically detect
-  the cases listed above and notify the user.
-
-Payment providers now interact with those payment and refund objects more than with orders.
-
-Your to-do list
----------------
-
-Payment processing
-""""""""""""""""""
-
-* The method ``BasePaymentProvider.order_pending_render`` has been removed and replaced by a new
-  ``BasePaymentProvider.payment_pending_render(request, payment)`` method that is passed an ``OrderPayment``
-  object instead of an ``Order``.
-
-* The method ``BasePaymentProvider.payment_form_render`` now receives a new ``total`` parameter.
-
-* The method ``BasePaymentProvider.payment_perform`` has been removed and replaced by a new method
-  ``BasePaymentProvider.execute_payment(request, payment)`` that is passed an ``OrderPayment``
-  object instead of an ``Order``.
-
-* The function ``pretix.base.services.mark_order_paid`` has been removed, instead call ``payment.confirm()``
-  on a pending ``OrderPayment`` object. If no further payments are required for this order, this will also
-  mark the order as paid automatically. Note that ``payment.confirm()`` can still throw a ``QuotaExceededException``,
-  however it will still mark the payment as complete (not the order!), so you should catch this exception and
-  inform the user, but not abort the transaction.
-
-* A new property ``BasePaymentProvider.abort_pending_allowed`` has been introduced. Only if set, the user will
-  be able to retry a payment or switch the payment method when the order currently has a payment object in
-  state ``"pending"``. This replaces ``BasePaymentProvider.order_can_retry``, which no longer exists.
-
-* The methods ``BasePaymentProvider.retry_prepare`` and ``BasePaymentProvider.order_prepare`` have both been
-  replaced by a new method ``BasePaymentProvider.payment_prepare(request, payment)`` that is passed an ``OrderPayment``
-  object instead of an ``Order``. **Keep in mind that this payment object might have an amount property that
-  differs from the order total, if the order is already partially paid.**
-
-* The method ``BasePaymentProvider.order_paid_render`` has been removed.
-
-* The method ``BasePaymentProvider.order_control_render`` has been removed and replaced by a new method
-  ``BasePaymentProvider.payment_control_render(request, payment)`` that is passed an ``OrderPayment``
-  object instead of an ``Order``.
-
-* There's no need to manually deal with excess payments or duplicate payments anymore, just setting the ``OrderPayment``
-  methods to the correct state will do the job.
-
-Creating refunds
-""""""""""""""""
-
-* The methods ``BasePaymentProvider.order_control_refund_render`` and ``BasePaymentProvider.order_control_refund_perform``
-  have been removed.
-
-* Two new boolean methods ``BasePaymentProvider.payment_refund_supported(payment)`` and ``BasePaymentProvider.payment_partial_refund_supported(payment)``
-  have been introduced. They should be set to return ``True`` if and only if the payment API allows to *automatically*
-  transfer the money back to the customer.
-
-* A new method ``BasePaymentProvider.execute_refund(refund)`` has been introduced. This method is called using a
-  ``OrderRefund`` object in ``"created"`` state and is expected to transfer the money back and confirm success with
-  calling ``refund.done()``. This will only ever be called if either ``BasePaymentProvider.payment_refund_supported(payment)``
-  or ``BasePaymentProvider.payment_partial_refund_supported(payment)`` return ``True``.
-
-Processing external refunds
-"""""""""""""""""""""""""""
-
-* If e.g. a webhook API notifies you that a payment has been disputed or refunded with the external API, you are
-  expected to call ``OrderPayment.create_external_refund(self, amount, execution_date, info='{}')`` on this payment.
-  This will create and return an appropriate ``OrderRefund`` object and send out a notification. However, it will not
-  mark the order as refunded, but will ask the event organizer for a decision.
-
-Data shredders
-""""""""""""""
-
-* The method ``BasePaymentProvider.shred_payment_info`` is no longer passed an order, but instead **either**
-  an ``OrderPayment`` **or** an ``OrderRefund``.

doc/development/api/placeholder.rst

@@ -1,10 +1,11 @@
 .. highlight:: python
    :linenothreshold: 5
 
-Writing an e-mail placeholder plugin
-====================================
+Writing a template placeholder plugin
+=====================================
 
-An email placeholder is a dynamic value that pretix users can use in their email templates.
+A template placeholder is a dynamic value that pretix users can use in their email templates and in other
+configurable texts.
 
 Please read :ref:`Creating a plugin <pluginsetup>` first, if you haven't already.
 
@@ -12,31 +13,31 @@ Placeholder registration
 ------------------------
 
 The placeholder API does not make a lot of usage from signals, however, it
-does use a signal to get a list of all available email placeholders. Your plugin
-should listen for this signal and return an instance of a subclass of ``pretix.base.email.BaseMailTextPlaceholder``:
+does use a signal to get a list of all available placeholders. Your plugin
+should listen for this signal and return an instance of a subclass of ``pretix.base.services.placeholders.BaseTextPlaceholder``:
 
 .. code-block:: python
 
     from django.dispatch import receiver
 
-    from pretix.base.signals import register_mail_placeholders
+    from pretix.base.signals import register_text_placeholders
 
 
-    @receiver(register_mail_placeholders, dispatch_uid="placeholder_custom")
-    def register_mail_renderers(sender, **kwargs):
-        from .email import MyPlaceholderClass
+    @receiver(register_text_placeholders, dispatch_uid="placeholder_custom")
+    def register_placeholder_renderers(sender, **kwargs):
+        from .placeholders import MyPlaceholderClass
         return MyPlaceholder()
 
 
 Context mechanism
 -----------------
 
-Emails are sent in different "contexts" within pretix. For example, many emails are sent in the
-the context of an order, but some are not, such as the notification of a waiting list voucher.
+Templates are used in different "contexts" within pretix. For example, many emails are rendered from
+templates in the context of an order, but some are not, such as the notification of a waiting list voucher.
 
-Not all placeholders make sense in every email, and placeholders usually depend some parameters
+Not all placeholders make sense everywhere, and placeholders usually depend on some parameters
 themselves, such as the ``Order`` object. Therefore, placeholders are expected to explicitly declare
-what values they depend on and they will only be available in an email if all those dependencies are
+what values they depend on and they will only be available in a context where all those dependencies are
 met. Currently, placeholders can depend on the following context parameters:
 
 * ``event``
@@ -51,7 +52,7 @@ There are a few more that are only to be used internally but not by plugins.
 The placeholder class
 ---------------------
 
-.. class:: pretix.base.email.BaseMailTextPlaceholder
+.. class:: pretix.base.services.placeholders.BaseTextPlaceholder
 
    .. autoattribute:: identifier
 
@@ -77,7 +78,18 @@ functions:
 
 .. code-block:: python
 
-     placeholder = SimpleFunctionalMailTextPlaceholder(
+     placeholder = SimpleFunctionalTextPlaceholder(
          'code', ['order'], lambda order: order.code, sample='F8VVL'
      )
 
+Signals
+-------
+
+.. automodule:: pretix.base.signals
+   :no-index:
+   :members: register_text_placeholders
+
+.. automodule:: pretix.base.signals
+   :no-index:
+   :members: register_mail_placeholders
+

doc/development/api/plugins.rst

@@ -56,6 +56,20 @@ restricted         boolean (optional)   ``False`` by default, restricts a plugin
                                         for an event by system administrators / superusers.
 experimental       boolean (optional)   ``False`` by default, marks a plugin as an experimental feature in the plugins list.
 compatibility      string               Specifier for compatible pretix versions.
+level              string               System level the plugin can be activated at.
+                                        Set to ``pretix.base.plugins.PLUGIN_LEVEL_EVENT`` for plugins that can be activated
+                                        at event level and then be active for that event only.
+                                        Set to ``pretix.base.plugins.PLUGIN_LEVEL_ORGANIZER`` for plugins that can be
+                                        activated only for the organizer as a whole and are active for any event within
+                                        that organizer.
+                                        Set to ``pretix.base.plugins.PLUGIN_LEVEL_EVENT_ORGANIZER_HYBRID`` for plugins that
+                                        can be activated at organizer level but are considered active only within events
+                                        for which they have also been specifically activated.
+                                        More levels, e.g. user-level plugins, might be invented in the future.
+settings_links     list                 List of ``((menu name, submenu name, …), urlname, url_kwargs)`` tuples that point
+                                        to the plugin's settings.
+navigation_links   list                 List of ``((menu name, submenu name, …), urlname, url_kwargs)`` tuples that point
+                                        to the plugin's system pages.
 ================== ==================== ===========================================================
 
 A working example would be:
@@ -63,9 +77,9 @@ A working example would be:
 .. code-block:: python
 
     try:
-        from pretix.base.plugins import PluginConfig
+        from pretix.base.plugins import PluginConfig, PLUGIN_LEVEL_EVENT
     except ImportError:
-        raise RuntimeError("Please use pretix 2.7 or above to run this plugin!")
+        raise RuntimeError("Please use pretix 2025.7 or above to run this plugin!")
     from django.utils.translation import gettext_lazy as _
 
 
@@ -79,11 +93,14 @@ A working example would be:
             version = '1.0.0'
             category = 'PAYMENT'
             picture = 'pretix_paypal/paypal_logo.svg'
+            level = PLUGIN_LEVEL_EVENT
             visible = True
             featured = False
             restricted = False
             description = _("This plugin allows you to receive payments via PayPal")
             compatibility = "pretix>=2.7.0"
+            settings_links = []
+            navigation_links = []
 
 
     default_app_config = 'pretix_paypal.PaypalApp'
@@ -121,6 +138,7 @@ This will automatically make pretix discover this plugin as soon as it is instal
 through ``pip``. During development, you can just run ``python setup.py develop`` inside
 your plugin source directory to make it discoverable.
 
+.. _`signals`:
 Signals
 -------
 
@@ -139,20 +157,39 @@ method to make your receivers available:
             from . import signals  # NOQA
 
 You can optionally specify code that is executed when your plugin is activated for an event
-in the ``installed`` method:
+or organizer in the ``installed`` method:
 
 .. code-block:: python
 
     class PaypalApp(AppConfig):
         …
 
-        def installed(self, event):
+        def installed(self, event_or_organizer):
             pass  # Your code here
 
 
 Note that ``installed`` will *not* be called if the plugin is indirectly activated for an event
 because the event is created with settings copied from another event.
 
+.. _`registries`:
+Registries
+----------
+
+Many signals in pretix are used so that plugins can "register" a class, e.g. a payment provider or a
+ticket renderer.
+
+However, for some of them (types of :ref:`Log Entries <logging>`) we use a different method to keep track of them:
+In a ``Registry``, classes are collected at application startup, along with a unique key (in case
+of LogEntryType, the ``action_type``) as well as which plugin registered them.
+
+To register a class, you can use one of several decorators provided by the Registry object:
+
+.. autoclass:: pretix.base.logentrytypes.LogEntryTypeRegistry
+   :members: register, new, new_from_dict
+
+All files in which classes are registered need to be imported in the ``AppConfig.ready`` as explained
+in `Signals <signals>`_ above.
+
 Views
 -----
 
@@ -165,6 +202,28 @@ your Django app label.
    with checking that the calling user is logged in, has appropriate permissions,
    etc. We plan on providing native support for this in a later version.
 
+To make your plugin views easily discoverable, you can specify links for "Go to"
+and "Settings" buttons next to your entry on the plugin page. These links should be
+added to the ``navigation_links`` and ``settings_links``, respectively, in the
+``PretixPluginMeta`` class.
+
+Each array entry consists of a tuple ``(label, urlname, kwargs)``. For the label,
+either a string or a tuple of strings can be specified. In the latter case, the provided
+strings will be merged with a separator indicating they are successive navigation steps
+the user would need to take to reach the page via the regular menu
+(e.g. "Payment > Bank transfer" as below).
+
+.. code-block:: python
+
+        settings_links = [
+            ((_("Payment"), _("Bank transfer")), "control:event.settings.payment.provider", {"provider": "banktransfer"}),
+        ]
+        navigation_links = [
+            ((_("Bank transfer"), _("Import bank data")), "plugins:banktransfer:import", {}),
+            ((_("Bank transfer"), _("Export refunds")), "plugins:banktransfer:refunds.list", {}),
+        ]
+
+
 .. _Django app: https://docs.djangoproject.com/en/3.0/ref/applications/
 .. _signal dispatcher: https://docs.djangoproject.com/en/3.0/topics/signals/
 .. _namespace packages: https://legacy.python.org/dev/peps/pep-0420/

doc/development/concepts.rst

@@ -17,7 +17,7 @@ The project pretix is split into several components. The main components are:
     create and manage their events, items, orders and tickets.
 
 **presale**
-    This is the ticket-shop itself, containing all of the parts visible to the
+    This is the ticket shop itself, containing all of the parts visible to the
     end user. Also called "frontend" in parts of this documentation.
 
 **api**

doc/development/implementation/i18n.rst

@@ -37,7 +37,7 @@ you to execute a piece of code with a different locale:
 This is very useful e.g. when sending an email to a user that has a different language than the user performing the
 action that causes the mail to be sent.
 
-.. _translation features: https://docs.djangoproject.com/en/1.9/topics/i18n/translation/
+.. _translation features: https://docs.djangoproject.com/en/4.2/topics/i18n/translation/
 .. _GNU gettext: https://www.gnu.org/software/gettext/
 .. _strings: https://django-i18nfield.readthedocs.io/en/latest/strings.html
 .. _database fields: https://django-i18nfield.readthedocs.io/en/latest/quickstart.html

doc/development/implementation/index.rst

@@ -18,3 +18,5 @@ Contents:
    email
    permissions
    logging
+   locking
+   timemachine

doc/development/implementation/locking.rst

@@ -0,0 +1,69 @@
+.. highlight:: python
+
+Resource locking
+================
+
+.. versionchanged:: 2023.8
+
+   Our locking mechanism changed heavily in version 2023.8. Read `this PR`_ for background information.
+
+One of pretix's core objectives as a ticketing system could be described as the management of scarce resources.
+Specifically, the following types of scarce-ness exist in pretix:
+
+- Quotas can limit the number of tickets available
+- Seats can only be booked once
+- Vouchers can only be used a limited number of times
+- Some memberships can only be used a limited number of times
+
+For all of these, it is critical that we prevent race conditions.
+While for some events it wouldn't be a big deal to sell a ticket more or less, for some it would be problematic and selling the same seat twice would always be catastrophic.
+
+We therefore implement a standardized locking approach across the system to limit concurrency in cases where it could
+be problematic.
+
+To acquire a lock on a set of quotas to create a new order that uses that quota, you should follow the following pattern::
+
+    with transaction.atomic(durable=True):
+        quotas = Quota.objects.filter(...)
+        lock_objects(quotas, shared_lock_objects=[event])
+        check_quota(quotas)
+        create_ticket()
+
+The lock will automatically be released at the end of your database transaction.
+
+Generally, follow the following guidelines during your development:
+
+- **Always** acquire a lock on every **quota**, **voucher** or **seat** that you "use" during your transaction. "Use"
+  here means any action after which the quota, voucher or seat will be **less available**, such as creating a cart
+  position, creating an order, creating a blocking voucher, etc.
+
+  - There is **no need** to acquire a lock if you **free up** capacity, e.g. by canceling an order, deleting a voucher, etc.
+
+- **Always** acquire a shared lock on the ``event`` you are working in whenever you acquire a lock on a quota, voucher,
+  or seat.
+
+- Only call ``lock_objects`` **once** per transaction. If you violate this rule, `deadlocks`_ become possible.
+
+- For best performance, call ``lock_objects`` as **late** in your transaction as possible, but always before you check
+  if the desired resource is still available in sufficient quantity.
+
+Behind the scenes, the locking is implemented through `PostgreSQL advisory locks`_. You should also be aware of the following
+properties of our system:
+
+- In some situations, an exclusive lock on the ``event`` is used, such as when the system can't determine for sure which
+  seats will become unavailable after the transaction.
+
+- An exclusive lock on the event is also used if you pass more than 20 objects to ``lock_objects``. This is a performance
+  trade-off because it would take long to acquire all of the individual locks.
+
+- If ``lock_objects`` is unable to acquire a lock within 3 seconds, a ``LockTimeoutException`` will be thrown.
+
+.. note::
+
+   We currently do not use ``lock_objects`` for memberships. Instead, we use ``select_for_update()`` on the membership
+   model. This might change in the future, but you should usually not be concerned about it since
+   ``validate_memberships_in_order(lock=True)`` will handle it for you.
+
+.. _this PR: https://github.com/pretix/pretix/pull/2408
+.. _deadlocks: https://www.postgresql.org/docs/current/explicit-locking.html#LOCKING-DEADLOCKS
+.. _PostgreSQL advisory locks: https://www.postgresql.org/docs/11/explicit-locking.html#ADVISORY-LOCKS

doc/development/implementation/logging.rst

@@ -20,7 +20,8 @@ To actually log an action, you can just call the ``log_action`` method on your o
 
 .. code-block:: python
 
-   order.log_action('pretix.event.order.canceled', user=user, data={})
+   order.log_action('pretix.event.order.comment', user=user,
+                    data={"new_comment": "Hello, world."})
 
 The positional ``action`` argument should represent the type of action and should be globally unique, we
 recommend to prefix it with your package name, e.g. ``paypal.payment.rejected``. The ``user`` argument is
@@ -72,24 +73,101 @@ following ready-to-include template::
    {% include "pretixcontrol/includes/logs.html" with obj=order %}
 
 We now need a way to translate the action codes like ``pretix.event.changed`` into human-readable
-strings. The :py:attr:`pretix.base.signals.logentry_display` signals allows you to do so. A simple
+strings. The :py:attr:`pretix.base.logentrytypes.log_entry_types` :ref:`registry <registries>` allows you to do so. A simple
 implementation could look like:
 
 .. code-block:: python
 
     from django.utils.translation import gettext as _
-    from pretix.base.signals import logentry_display
+    from pretix.base.logentrytypes import log_entry_types
+
+
+    @log_entry_types.new_from_dict({
+        'pretix.event.order.comment': _('The order\'s internal comment has been updated to: {new_comment}'),
+        'pretix.event.order.paid': _('The order has been marked as paid.'),
+        # ...
+    })
+    class CoreOrderLogEntryType(OrderLogEntryType):
+        pass
+
+Please note that you always need to define your own inherited ``LogEntryType`` class in your plugin. If you would just
+register an instance of a ``LogEntryType`` class defined in pretix core, it cannot be automatically detected as belonging
+to your plugin, leading to confusing user interface situations.
+
+
+Customizing log entry display
+"""""""""""""""""""""""""""""
+
+The base ``LogEntryType`` classes allow for varying degree of customization in their descendants.
+
+If you want to add another log message for an existing core object (e.g. an :class:`Order <pretix.base.models.Order>`,
+:class:`Item <pretix.base.models.Item>`, or :class:`Voucher <pretix.base.models.Voucher>`), you can inherit
+from its predefined :class:`LogEntryType <pretix.base.logentrytypes.LogEntryType>`, e.g.
+:class:`OrderLogEntryType <pretix.base.logentrytypes.OrderLogEntryType>`, and just specify a new plaintext string.
+You can use format strings to insert information from the LogEntry's `data` object as shown in the section above.
+
+If you define a new model object in your plugin, you should make sure proper object links in the user interface are
+displayed for it. If your model object belongs logically to a pretix :class:`Event <pretix.base.models.Event>`, you can inherit from :class:`EventLogEntryType <pretix.base.logentrytypes.EventLogEntryType>`,
+and set the ``object_link_*`` fields accordingly. ``object_link_viewname`` refers to a django url name, which needs to
+accept the arguments `organizer` and `event`, containing the respective slugs, and additional arguments provided by
+``object_link_args``. The default implementation of ``object_link_args`` will return an argument named by
+````object_link_argname``, with a value of ``content_object.pk`` (the primary key of the model object).
+If you want to customize the name displayed for the object (instead of the result of calling ``str()`` on it),
+overwrite ``object_link_display_name``.
+
+
+.. code-block:: python
+
+    class ItemLogEntryType(EventLogEntryType):
+        object_link_wrapper = _('Product {val}')
+
+        # link will be generated as reverse('control:event.item', {'organizer': ..., 'event': ..., 'item': item.pk})
+        object_link_viewname = 'control:event.item'
+        object_link_argname = 'item'
+
+
+.. code-block:: python
+
+    class OrderLogEntryType(EventLogEntryType):
+        object_link_wrapper = _('Order {val}')
+
+        # link will be generated as reverse('control:event.order', {'organizer': ..., 'event': ..., 'code': order.code})
+        object_link_viewname = 'control:event.order'
+
+        def object_link_args(self, order):
+            return {'code': order.code}
+
+        def object_link_display_name(self, order):
+            return order.code
+
+To show more sophisticated message strings, e.g. varying the message depending on information from the :class:`LogEntry <pretix.base.models.log.LogEntry>`'s
+`data` object, override the `display` method:
+
+.. code-block:: python
+
+    @log_entry_types.new()
+    class PaypalEventLogEntryType(EventLogEntryType):
+        action_type = 'pretix.plugins.paypal.event'
+
+        def display(self, logentry):
+            event_type = logentry.parsed_data.get('event_type')
+            text = {
+                'PAYMENT.SALE.COMPLETED': _('Payment completed.'),
+                'PAYMENT.SALE.DENIED': _('Payment denied.'),
+                # ...
+            }.get(event_type, f"({event_type})")
+            return _('PayPal reported an event: {}').format(text)
+
+.. automethod:: pretix.base.logentrytypes.LogEntryType.display
+
+If your new model object does not belong to an :class:`Event <pretix.base.models.Event>`, you need to inherit directly from ``LogEntryType`` instead
+of ``EventLogEntryType``, providing your own implementation of ``get_object_link_info`` if object links should be
+displayed.
+
+.. autoclass:: pretix.base.logentrytypes.LogEntryType
+   :members: get_object_link_info
+
 
-    @receiver(signal=logentry_display)
-    def pretixcontrol_logentry_display(sender, logentry, **kwargs):
-        plains = {
-            'pretix.event.order.paid': _('The order has been marked as paid.'),
-            'pretix.event.order.refunded': _('The order has been refunded.'),
-            'pretix.event.order.canceled': _('The order has been canceled.'),
-            ...
-        }
-        if logentry.action_type in plains:
-            return plains[logentry.action_type]
 
 Sending notifications
 ---------------------

doc/development/implementation/settings.rst

@@ -15,7 +15,7 @@ includes serializers for serializing the following types:
 * Built-in types: ``int``, ``float``, ``decimal.Decimal``, ``dict``, ``list``, ``bool``
 * ``datetime.date``, ``datetime.datetime``, ``datetime.time``
 * ``LazyI18nString``
-* References to Django ``File`` objects that are already stored in a storage backend
+* References to Django ``File`` objects that are already stored in a storage backend [#f1]_
 * References to model instances
 
 In code, we recommend to always use the ``.get()`` method on the settings object to access a value, but for
@@ -55,6 +55,9 @@ You can simply use it like this:
                        "preserve his reservation."),
        )
 
+
+.. _settings-defaults-in-plugins:
+
 Defaults in plugins
 -------------------
 
@@ -70,3 +73,9 @@ Make sure that you include this code in a module that is imported at app loading
 
 .. _django-hierarkey: https://github.com/raphaelm/django-hierarkey
 .. _documentation: https://django-hierarkey.readthedocs.io/en/latest/
+
+.. rubric:: Footnotes
+
+.. [#f1] If you store ``File`` instances in per-event settings, make sure to always register them with ``add_default``
+         as described above in :ref:`settings-defaults-in-plugins`. Otherwise, the file won't get copied properly if the
+         user copies the settings of an existing event to a new one.