PDF: fix offset in mediabox of background-pdf

Currently translated at 99.9% (5361 of 5362 strings)

Translation: pretix/pretix
Translate-URL: https://translate.pretix.eu/projects/pretix/pretix/de_Informal/

powered by weblate

.clabot

@@ -0,0 +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!",
+  "label": "cla-signed"
+}

.gitattributes

@@ -6,6 +6,7 @@ src/pretix/static/datetimepicker/* linguist-vendored
 src/pretix/static/colorpicker/* linguist-vendored
 src/pretix/static/fileupload/* linguist-vendored
 src/pretix/static/vuejs/* linguist-vendored
+src/pretix/static/d3/* linguist-vendored
 src/pretix/static/select2/* linguist-vendored
 src/pretix/static/charts/* linguist-vendored
 src/pretix/static/rrule/* linguist-vendored

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,53 @@
+name: Bug report
+description: Please only create issues for bug reports. Feature requests or general questions should start as a "Discussion" on GitHub.
+body:
+  - type: markdown
+    attributes:
+      value: Please make sure to search our issues for similar bugs first! If bug has been reported already, react with a thumbs-up, and/or leave a comment providing further details.
+  - type: textarea
+    id: current
+    attributes:
+      label: Problem and impact
+      description: What problem you're running into? What impact does it have on you / your event?
+      placeholder: When trying to do ____, pretix suddenly shows me an error saying "...".
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behaviour
+      description: Sometimes bugs are subtle and the expected behaviour may need some explanation. Leave empty if it's just "Don't be broken."
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to reproduce
+      description: "Please give as much context as possible: Are there any settings that impact this behaviour?"
+      placeholder: |
+        1.
+        2.
+        3.
+        4.
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: If possible, show screenshots of the problem.
+  - type: input
+    id: link
+    attributes:
+      label: Link
+      description: Link to the page where the bug occurs
+  - type: input
+    id: browser
+    attributes:
+      label: Browser (software, desktop or mobile?) and version
+      description: Leave empty for backend problems
+  - type: input
+    id: os
+    attributes:
+      label: Operating system, dependency versions
+      description: Leave empty for frontend problems
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: The pretix version in use. (Leave empty if unknown.)
+

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Community Support
+    url: https://github.com/pretix/pretix/discussions/categories/q-a
+    about: Not sure how to do Y? Please post your support requests in the Q&A section of our GitHub Discussions instead!
+  - name: Feature ideas
+    url: https://github.com/pretix/pretix/discussions/categories/ideas
+    about: Please post your idea in the Ideas section of our GitHub Discussions instead!

.github/dependabot.yml

@@ -0,0 +1,16 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    versioning-strategy: increase
+  - package-ecosystem: "npm"
+    directory: "/src/pretix/static/npm_dir"
+    schedule:
+      interval: "monthly"

.github/workflows/build.yml

@@ -0,0 +1,49 @@
+name: Build
+
+on:
+  push:
+    branches: [ master ]
+    paths-ignore:
+      - 'doc/**'
+      - 'src/pretix/locale/**'
+  pull_request:
+    branches: [ master ]
+    paths-ignore:
+      - 'doc/**'
+      - 'src/pretix/locale/**'
+
+permissions:
+  contents: read  #  to fetch code (actions/checkout)
+
+env:
+  FORCE_COLOR: 1
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+    name: Packaging
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - uses: actions/cache@v1
+        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
+      - name: Install Python dependencies
+        run: pip3 install -U setuptools build pip check-manifest
+      - name: Run check-manifest
+        run: check-manifest
+      - name: Run build
+        run: python -m build
+      - name: Check files
+        run: unzip -l dist/pretix*whl | grep node_modules || exit 1

.github/workflows/docs.yml

@@ -14,16 +14,22 @@ on:
       - 'src/pretix/static/**'
       - 'src/tests/**'
 
+permissions:
+  contents: read  #  to fetch code (actions/checkout)
+
+env:
+  FORCE_COLOR: 1
+
 jobs:
   spelling:
     name: Spellcheck
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.8
+      - name: Set up Python 3.11
         uses: actions/setup-python@v1
         with:
-          python-version: 3.8
+          python-version: 3.11
       - uses: actions/cache@v1
         with:
           path: ~/.cache/pip
@@ -31,9 +37,10 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system packages
-        run: sudo apt update && sudo apt install enchant hunspell aspell-en
+        run: sudo apt update && sudo apt install enchant-2 hunspell aspell-en
       - name: Install Dependencies
-        run: pip3 install --no-use-pep517 -Ur doc/requirements.txt
+        run: pip3 install -Ur requirements.txt
+        working-directory: ./doc
       - name: Spellcheck docs
         run: make spelling
         working-directory: ./doc

.github/workflows/strings.yml

@@ -12,16 +12,22 @@ on:
       - 'doc/**'
       - 'src/pretix/locale/**'
 
+permissions:
+  contents: read  #  to fetch code (actions/checkout)
+
+env:
+  FORCE_COLOR: 1
+
 jobs:
   compile:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     name: Check gettext syntax
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.8
+      - name: Set up Python 3.11
         uses: actions/setup-python@v1
         with:
-          python-version: 3.8
+          python-version: 3.11
       - uses: actions/cache@v1
         with:
           path: ~/.cache/pip
@@ -31,7 +37,7 @@ jobs:
       - name: Install system packages
         run: sudo apt update && sudo apt install gettext
       - name: Install Dependencies
-        run: pip3 install --no-use-pep517 -Ur src/requirements.txt
+        run: pip3 install -e ".[dev]"
       - name: Compile messages
         run: python manage.py compilemessages
         working-directory: ./src
@@ -39,14 +45,14 @@ jobs:
         run: python manage.py compilejsi18n
         working-directory: ./src
   spelling:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     name: Spellcheck
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.8
+      - name: Set up Python 3.11
         uses: actions/setup-python@v1
         with:
-          python-version: 3.8
+          python-version: 3.11
       - uses: actions/cache@v1
         with:
           path: ~/.cache/pip
@@ -54,9 +60,9 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system packages
-        run: sudo apt update && sudo apt install enchant hunspell hunspell-de-de aspell-en aspell-de
+        run: sudo apt update && sudo apt install enchant-2 hunspell hunspell-de-de aspell-en aspell-de
       - name: Install Dependencies
-        run: pip3 install --no-use-pep517 -Ur src/requirements/dev.txt
+        run: pip3 install -e ".[dev]"
       - name: Spellcheck translations
         run: potypo
         working-directory: ./src

.github/workflows/style.yml

@@ -12,16 +12,22 @@ on:
       - 'src/pretix/locale/**'
       - 'src/pretix/static/**'
 
+permissions:
+  contents: read  #  to fetch code (actions/checkout)
+
+env:
+  FORCE_COLOR: 1
+
 jobs:
   isort:
     name: isort
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.8
+      - name: Set up Python 3.11
         uses: actions/setup-python@v1
         with:
-          python-version: 3.8
+          python-version: 3.11
       - uses: actions/cache@v1
         with:
           path: ~/.cache/pip
@@ -29,19 +35,19 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install Dependencies
-        run: pip3 install --no-use-pep517 -Ur src/requirements/dev.txt
+        run: pip3 install -e ".[dev]" psycopg2-binary
       - name: Run isort
         run: isort -c .
         working-directory: ./src
   flake:
     name: flake8
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.8
+      - name: Set up Python 3.11
         uses: actions/setup-python@v1
         with:
-          python-version: 3.8
+          python-version: 3.11
       - uses: actions/cache@v1
         with:
           path: ~/.cache/pip
@@ -49,7 +55,24 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install Dependencies
-        run: pip3 install -r src/requirements.txt --no-use-pep517 -Ur src/requirements/dev.txt
+        run: pip3 install -e ".[dev]" psycopg2-binary
       - name: Run flake8
         run: flake8 .
         working-directory: ./src
+  licenseheader:
+    name: licenseheaders
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.11
+      - name: Install Dependencies
+        run: pip3 install licenseheaders
+      - name: Run licenseheaders
+        run: licenseheaders -t ../.licenseheader -E .py -x "*/migrations/*.py"
+        working-directory: ./src
+      - name: Check for changes
+        run: git diff --exit-code
+        working-directory: ./src

.github/workflows/tests.yml

@@ -12,31 +12,27 @@ on:
       - 'doc/**'
       - 'src/pretix/locale/**'
 
+permissions:
+  contents: read  #  to fetch code (actions/checkout)
+
+env:
+  FORCE_COLOR: 1
+
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     name: Tests
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
-        database: [sqlite, postgres, mysql]
+        python-version: ["3.9", "3.10", "3.11"]
+        database: [sqlite, postgres]
         exclude:
-          - database: mysql
-            python-version: 3.7
           - database: sqlite
-            python-version: 3.7
-          - database: mysql
-            python-version: 3.6
+            python-version: "3.9"
           - database: sqlite
-            python-version: 3.6
+            python-version: "3.10"
     steps:
       - uses: actions/checkout@v2
-      - uses: getong/mariadb-action@v1.1
-        with:
-          mariadb version: '10.4'
-          mysql database: 'pretix'
-          mysql root password: ''
-        if: matrix.database == 'mysql'
       - uses: harmon758/postgresql-action@v1
         with:
           postgresql version: '11'
@@ -55,12 +51,15 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-pip-
       - name: Install system dependencies
-        run: sudo apt update && sudo apt install gettext mysql-client
+        run: sudo apt update && sudo apt install gettext
       - name: Install Python dependencies
-        run: pip3 install -r src/requirements.txt --no-use-pep517 -Ur src/requirements/dev.txt mysqlclient psycopg2-binary
+        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
       - name: Run checks
         run: python manage.py check
         working-directory: ./src
+      - name: Install JS dependencies
+        working-directory: ./src
+        run: make npminstall
       - name: Compile
         working-directory: ./src
         run: make all compress
@@ -71,5 +70,6 @@ jobs:
         uses: codecov/codecov-action@v1
         with:
           file: src/coverage.xml
+          token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
-        if: matrix.database == 'postgres' && matrix.python-version == '3.8'
+        if: matrix.database == 'postgres' && matrix.python-version == '3.11'

.gitignore

@@ -1,4 +1,6 @@
 env/
+build/
+dist/
 .coverage
 htmlcov/
 .ropeproject

.gitlab-ci.yml

@@ -5,7 +5,7 @@ tests:
         - virtualenv env
         - source env/bin/activate
         - pip install -U pip wheel setuptools
-        - XDG_CACHE_HOME=/cache pip3 install -r src/requirements.txt --no-use-pep517 -Ur src/requirements/dev.txt
+        - XDG_CACHE_HOME=/cache pip3 install -e ".[dev]"
         - cd src
         - python manage.py check
         - make all compress
@@ -21,14 +21,16 @@ pypi:
         - virtualenv env
         - source env/bin/activate
         - pip install -U pip wheel setuptools check-manifest twine
-        - XDG_CACHE_HOME=/cache pip3 install -Ur src/requirements.txt -r src/requirements/dev.txt
-        - cd src
+        - XDG_CACHE_HOME=/cache pip3 install -e ".[dev]"
         - python setup.py sdist
         - pip install dist/pretix-*.tar.gz
         - python -m pretix migrate
         - python -m pretix check
+        - cd src
+        - make npminstall
+        - cd ..
         - check-manifest
-        - python setup.py sdist bdist_wheel
+        - python -m build
         - twine check dist/*
         - twine upload dist/*
     tags:

.licenseheader

@@ -0,0 +1,19 @@
+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
+
+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.
+
+ADDITIONAL TERMS APPLY: Pursuant to Section 7 of the GNU Affero General Public License, additional terms are
+applicable granting you additional permissions and placing additional restrictions on your usage of this software.
+Please refer to the pretix LICENSE file to obtain the full terms applicable to this work. If you did not receive
+this file, see <https://pretix.eu/about/en/license>.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
+warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
+details.
+
+You should have received a copy of the GNU Affero General Public License along with this program.  If not, see
+<https://www.gnu.org/licenses/>.

.readthedocs.requirements.txt

@@ -1 +0,0 @@
--r doc/requirements.txt

.readthedocs.yaml

@@ -0,0 +1,15 @@
+version: 2
+sphinx:
+   configuration: doc/conf.py
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+    nodejs: "16"
+  apt_packages:
+    - gettext
+python:
+  install:
+    - method: pip
+      path: ./src/
+    - requirements: doc/requirements.rtd.txt

AUTHORS

@@ -1,37 +0,0 @@
-Here is an inevitably incomplete list of much-appreciated contributors --
-people who have submitted patches, reported bugs, added translations, helped
-answer newbie questions, improved the documentation, and generally made pretix
-an awesome project. Thank you all!
-
-	Adam K. Sumner <asumner101@gmail.com>
-	Ahrdie <robert.deppe@me.com>
-	Alexander Brock <Brock.Alexander@web.de>
-	Brandon Pineda
-	Bolutife Lawrence
-	Christian Franke <nobody@nowhere.ws>
-	Christopher Dambamuromo <me@chridam.com>
-	chotee <chotee@openended.eu>
-	Cpt. Foo
-	Daniel Rosenblüh
-	Enrique Saez
-	Flavia Bastos
-	informancer <informancer@web.de>
-	Jakob Schnell <github@ezelo.de>
-	Jan Felix Wiebe <git@jfwie.be>
-	Jan Weiß
-	Jason Estibeiro <jasonestibeiro@live.com>
-	jlwt90
-	Jonas Große Sundrup <cherti@letopolis.de>
-	Kevin Nelson
-	Leah Oswald
-	Lukas Martini
-	Nathan Mattes
-	Nicole Klünder
-	Marc-Pascal Clement
-	Martin Gross <martin@pc-coholic.de>
-	Raphael Michel <mail@raphaelmichel.de>
-	Team MRMCD
-	Tobias Kunze <rixx@cutebit.de>
-	Oliver Knapp <github@oliverknapp.de>
-	Vishal Sodani <vishalsodani@rediffmail.com>
-	Jan Felix Wiebe <git@jfwie.be>

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/en/latest/development/contribution/) together with notes on the [development setup](https://docs.pretix.eu/en/latest/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/en/latest/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/).
 

COPYRIGHT

@@ -1,32 +0,0 @@
-Copyright 2014-2016 Raphael Michel
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-   http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-
-This project includes the work of others, namely:
-
-* Django, (c) Django Software Foundation and contributors, BSD License
-* Font Awesome, (c) Dave Gandy, SIL Open Font License and MIT License
-* Bootstrap, (c) Twitter, Inc., MIT License
-* jQuery, (c) jQuery Foundation and contributors, MIT License
-* django-formset-js, (c) Ionata Web Solutions, BSD License
-* CleanerVersion, (c) Jean-Christophe Zulian, Brian King, Andrea Marcacci, Manuel Jeckelmann, Apache License
-* django-bootstrap3, (c) Dylan Verheul, Apache License
-* pytz, (c) Stuart Bishop, MIT License
-* python-dateutil, (c) Yaron de Leeuw, BSD License
-* startbootstrap-sb-admin-2, (c) Iron Summit Media Strategies, LLC, Apache License
-* metismenu, (c) Osman Nuri Okumus, MIT License
-* easy-thumbnails, (c) Chris Beaven and contributors
-* reportlab, (c) ReportLab Europe Ltd, BSD License
-* django-compressor, (c) Jannis Leidel and contributors, MIT License
-* static3, (c) Roman Mohr and contributors, LGPL License
-* Lightbox, (c) Lokesh Dhakar, MIT License

Dockerfile

@@ -1,9 +1,8 @@
-FROM python:3.8
+FROM python:3.11-bullseye
 
 RUN apt-get update && \
     apt-get install -y --no-install-recommends \
             build-essential \
-            default-libmysqlclient-dev \
             gettext \
             git \
             libffi-dev \
@@ -15,11 +14,12 @@ RUN apt-get update && \
             libxslt1-dev \
             locales \
             nginx \
-            python-dev \
-            python-virtualenv \
+            python3-virtualenv \
             python3-dev \
             sudo \
             supervisor \
+            libmaxminddb0 \
+            libmaxminddb-dev \
             zlib1g-dev && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/* && \
@@ -31,35 +31,34 @@ RUN apt-get update && \
     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
+    mkdir /etc/supervisord && \
+	curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash - && \
+    apt-get install -y nodejs
+
 
 ENV LC_ALL=C.UTF-8 \
     DJANGO_SETTINGS_MODULE=production_settings
 
-# To copy only the requirements files needed to install from PIP
-COPY src/requirements /pretix/src/requirements
-COPY src/requirements.txt /pretix/src
-RUN pip3 install -U \
-        pip \
-        setuptools \
-        wheel && \
-    cd /pretix/src && \
-    pip3 install \
-        -r requirements.txt \
-        -r requirements/memcached.txt \
-        -r requirements/mysql.txt \
-        gunicorn django-extensions ipython && \
-    rm -rf ~/.cache/pip
-
 COPY deployment/docker/pretix.bash /usr/local/bin/pretix
 COPY deployment/docker/supervisord /etc/supervisord
 COPY deployment/docker/supervisord.all.conf /etc/supervisord.all.conf
 COPY deployment/docker/supervisord.web.conf /etc/supervisord.web.conf
 COPY deployment/docker/nginx.conf /etc/nginx/nginx.conf
+COPY deployment/docker/nginx-max-body-size.conf /etc/nginx/conf.d/nginx-max-body-size.conf
 COPY deployment/docker/production_settings.py /pretix/src/production_settings.py
+COPY pyproject.toml /pretix/pyproject.toml
+COPY _build /pretix/_build
 COPY src /pretix/src
 
-RUN cd /pretix/src && pip3 install .
+RUN pip3 install -U \
+        pip \
+        setuptools \
+        wheel && \
+    cd /pretix && \
+    PRETIX_DOCKER_BUILD=TRUE pip3 install \
+        -e ".[memcached]" \
+        gunicorn django-extensions ipython && \
+    rm -rf ~/.cache/pip
 
 RUN chmod +x /usr/local/bin/pretix && \
     rm /etc/nginx/sites-enabled/default && \

MANIFEST.in

@@ -0,0 +1,48 @@
+include LICENSE
+include README.rst
+include src/Makefile
+include _build/backend.py
+global-include *.proto
+recursive-include src/pretix/static *
+recursive-include src/pretix/static.dist *
+recursive-include src/pretix/locale *
+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/banktransfer/templates *
+recursive-include src/pretix/plugins/banktransfer/static *
+recursive-include src/pretix/plugins/manualpayment/templates *
+recursive-include src/pretix/plugins/manualpayment/static *
+recursive-include src/pretix/plugins/paypal/templates *
+recursive-include src/pretix/plugins/paypal/static *
+recursive-include src/pretix/plugins/paypal2/templates *
+recursive-include src/pretix/plugins/paypal2/static *
+recursive-include src/pretix/plugins/src/pretixdroid/templates *
+recursive-include src/pretix/plugins/src/pretixdroid/static *
+recursive-include src/pretix/plugins/sendmail/templates *
+recursive-include src/pretix/plugins/statistics/templates *
+recursive-include src/pretix/plugins/statistics/static *
+recursive-include src/pretix/plugins/stripe/templates *
+recursive-include src/pretix/plugins/stripe/static *
+recursive-include src/pretix/plugins/ticketoutputpdf/templates *
+recursive-include src/pretix/plugins/ticketoutputpdf/static *
+recursive-include src/pretix/plugins/badges/templates *
+recursive-include src/pretix/plugins/badges/static *
+recursive-include src/pretix/plugins/returnurl/templates *
+recursive-include src/pretix/plugins/returnurl/static *
+recursive-include src/pretix/plugins/webcheckin/templates *
+recursive-include src/pretix/plugins/webcheckin/static *
+recursive-include src *.cfg
+recursive-include src *.csv
+recursive-include src *.gitkeep
+recursive-include src *.jpg
+recursive-include src *.json
+recursive-include src *.py
+recursive-include src *.svg
+recursive-include src *.txt
+recursive-include src Makefile
+
+recursive-exclude doc *
+recursive-exclude deployment *
+recursive-exclude res *

README.rst

@@ -52,11 +52,9 @@ including issues, pull requests, etc.
 
 License
 -------
-The code in this repository is published under the terms of the Apache License. 
-See the LICENSE file for the complete license text.
 
-This project is maintained by Raphael Michel. See the AUTHORS file for a list of all
-the awesome folks who contributed to this project.
+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

SECURITY.md

@@ -0,0 +1,20 @@
+# Security policy
+
+## 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.
+
+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. 
+
+## Version support
+
+Security support is provided for the current stable release as well as the two previous stable releases.
+Be sure to keep your pretix installation up to date.
+
+New releases and security issues will be announced on our [blog](https://pretix.eu/about/en/blog/). If you
+subscribe to our [newsletter](https://pretix.eu/about/en/blog/) in the "News about self-hosting pretix"
+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).

_build/backend.py

@@ -0,0 +1,12 @@
+import tomli
+from setuptools import build_meta as _orig
+from setuptools.build_meta import *
+
+
+def get_requires_for_build_wheel(config_settings=None):
+    with open("pyproject.toml", "rb") as f:
+        p = tomli.load(f)
+    return [
+        *_orig.get_requires_for_build_wheel(config_settings),
+        *p['project']['dependencies']
+    ]

deployment/docker/nginx-max-body-size.conf

@@ -0,0 +1 @@
+client_max_body_size 100M;

deployment/docker/nginx.conf

@@ -16,7 +16,6 @@ http {
 	charset utf-8;
 	tcp_nopush on;
 	tcp_nodelay on;
-	client_max_body_size 100M;
 
 	log_format private '[$time_local] $host "$request" $status $body_bytes_sent';
 
@@ -33,7 +32,7 @@ http {
 
 	gzip on;
 	gzip_disable "msie6";
-	gzip_types text/plain text/html text/css application/json application/javascript application/x-javascript text/javascript text/xml application/xml application/rss+xml application/atom+xml application/rdf+xml image/svg+xml;
+	gzip_types text/plain text/css application/json application/javascript application/x-javascript text/javascript text/xml application/xml application/rss+xml application/atom+xml application/rdf+xml image/svg+xml;
 	gzip_vary on;
 	gzip_proxied any;
 	gzip_comp_level 6;
@@ -66,9 +65,18 @@ http {
             access_log off;
             expires 365d;
             add_header Cache-Control "public";
+            add_header Access-Control-Allow-Origin "*";
+            gzip on;
         }
         location / {
-            proxy_pass http://unix:/tmp/pretix.sock:/;
+            # Very important:
+            #   proxy_pass http://unix:/tmp/pretix.sock:;
+            # is not the same as
+            #   proxy_pass http://unix:/tmp/pretix.sock:/;
+            # In the latter case, nginx will apply its URL parsing, in the former it doesn't.
+            # There are situations in which pretix' API will deal with "file names" containing %2F%2F, which
+            # nginx will normalize to %2F, which can break ticket validation.
+            proxy_pass http://unix:/tmp/pretix.sock:;
             proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
         	proxy_set_header Host $http_host;
         }

deployment/docker/supervisord/base.conf

@@ -2,9 +2,9 @@
 file=/tmp/supervisor.sock
 
 [supervisord]
-logfile=/tmp/supervisord.log
-logfile_maxbytes=50MB
-logfile_backups=10
+environment = AUTOMIGRATE="skip"
+logfile=/dev/stdout
+logfile_maxbytes=0
 loglevel=info
 pidfile=/tmp/supervisord.pid
 nodaemon=false

deployment/docker/supervisord/nginx.conf

@@ -3,5 +3,7 @@ command=/usr/sbin/nginx
 autostart=true
 autorestart=true
 priority=10
-stdout_events_enabled=true
-stderr_events_enabled=true
+stdout_logfile=/dev/fd/1
+stdout_logfile_maxbytes=0
+stderr_logfile=/dev/fd/2
+stderr_logfile_maxbytes=0

deployment/docker/supervisord/pretixtask.conf

@@ -4,3 +4,7 @@ autostart=true
 autorestart=true
 priority=5
 user=pretixuser
+stdout_logfile=/dev/fd/1
+stdout_logfile_maxbytes=0
+stderr_logfile=/dev/fd/2
+stderr_logfile_maxbytes=0

deployment/docker/supervisord/pretixweb.conf

@@ -5,3 +5,7 @@ autorestart=true
 priority=5
 user=pretixuser
 environment=HOME=/pretix
+stdout_logfile=/dev/fd/1
+stdout_logfile_maxbytes=0
+stderr_logfile=/dev/fd/2
+stderr_logfile_maxbytes=0

doc/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

doc/_themes/pretix_theme/layout.html

@@ -18,67 +18,82 @@
   <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
   {% endblock %}
 
-  {# FAVICON #}
-  {% if favicon %}
-    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
-  {% endif %}
-  {# CANONICAL URL #}
-  {% if theme_canonical_url %}
+
+  {#- 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 %} />
+    {%- else %}
+      <link rel="stylesheet" href="{{ pathto(css, 1) }}" type="text/css" />
+    {%- endif %}
+  {%- endfor %}
+
+  {%- for cssfile in extra_css_files %}
+    <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
+  {%- endfor -%}
+
+  {#- 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 %}
     <link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
-  {% endif %}
+  {%- endif -%}
 
-  {# CSS #}
+  {#- CANONICAL URL #}
+  {%- if pageurl %}
+    <link rel="canonical" href="{{ pageurl|e }}" />
+  {%- endif -%}
 
-  {# OPENSEARCH #}
-  {% if not embedded %}
-    {% 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 %}
+  {#- 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 %}
+    <script src="{{ pathto('_static/js/theme.js', 1) }}"></script>
 
-  {% endif %}
-
-  {# RTD hosts this file, so just load on non RTD builds #}
-    <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
-
-  {% for cssfile in css_files %}
-    <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
-  {% endfor %}
-
-  {% for cssfile in extra_css_files %}
-    <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
-  {% endfor %}
+    {#- 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 %}
 
   {%- block linktags %}
     {%- if hasdoc('about') %}
-        <link rel="author" title="{{ _('About these documents') }}"
-              href="{{ pathto('about') }}"/>
+    <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
     {%- endif %}
     {%- if hasdoc('genindex') %}
-        <link rel="index" title="{{ _('Index') }}"
-              href="{{ pathto('genindex') }}"/>
+    <link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
     {%- endif %}
     {%- if hasdoc('search') %}
-        <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}"/>
+    <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
     {%- endif %}
     {%- 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 }}"/>
+    <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
     {%- endif %}
     {%- if next %}
-        <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}"/>
+    <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 }}"/>
+    <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
     {%- endif %}
   {%- endblock %}
   {%- block extrahead %} {% endblock %}
 
-  {# Keep modernizr in head - http://modernizr.com/docs/#installing #}
-  <script src="{{ pathto('_static/js/modernizr.min.js', 1) }}"></script>
-
 </head>
 
 <body class="wy-body-for-nav" role="document">
@@ -92,16 +107,14 @@
         <div class="wy-side-nav-search">
           {% block sidebartitle %}
 
-          {% if logo and theme_logo_only %}
-            <a href="{{ pathto('index') }}">
-          {% else %}
-            <a href="{{ pathto('index') }}" class="icon icon-home"> {{ project }}
-          {% endif %}
-
-          {% if logo %}
-            {# Not strictly valid HTML, but it's the only way to display/scale it properly, without weird scripting or heaps of work #}
-            <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" />
-          {% endif %}
+          {# 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 logo or logo_url %}
+              <img src="{{ _logo_url }}" class="logo" alt="{{ _('Logo') }}"/>
+            {%- endif %}
           </a>
 
           {% include "searchbox.html" %}
@@ -157,7 +170,7 @@
         <div class="rst-content">
           {% include "breadcrumbs.html" %}
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
-           <div itemprop="articleBody">
+           <div itemprop="articleBody" class="section">
             {% block body %}{% endblock %}
            </div>
            <div class="articleComments">

doc/_themes/pretix_theme/search.html

@@ -5,31 +5,37 @@
     Template for the search page.
 
     :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
+    :license: BSD, see https://github.com/sphinx-doc/sphinx/blob/master/LICENSE for details.
 #}
 {%- extends "layout.html" %}
 {% set title = _('Search') %}
-{% set script_files = script_files + ['_static/searchtools.js'] %}
+{% set display_vcs_links = False %}
+{%- block scripts %}
+    {{ super() }}
+    <script src="{{ pathto('_static/searchtools.js', 1) }}"></script>
+    <script src="{{ pathto('_static/language_data.js', 1) }}"></script>
+{%- endblock %}
 {% block footer %}
-  <script type="text/javascript">
+  <script>
     jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); });
   </script>
   {# this is used when loading the search index using $.ajax fails,
      such as on Chrome for documents on localhost #}
-  <script type="text/javascript" id="searchindexloader"></script>
+  <script id="searchindexloader"></script>
   {{ super() }}
 {% endblock %}
 {% block body %}
   <noscript>
   <div id="fallback" class="admonition warning">
     <p class="last">
-      {% trans %}Please activate JavaScript to enable the search
+      {% trans trimmed %}Please activate JavaScript to enable the search
       functionality.{% endtrans %}
     </p>
   </div>
   </noscript>
 
   {% if search_performed %}
+    {# Translators: Search is a noun, not a verb #}
     <h2>{{ _('Search Results') }}</h2>
     {% if not search_results %}
       <p>{{ _('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.') }}</p>
@@ -47,4 +53,4 @@
     </ul>
   {% endif %}
   </div>
-{% endblock %}
+{% endblock %}

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

@@ -3155,14 +3155,14 @@ a .fa, a .wy-menu-vertical li span.toctree-expand, .wy-menu-vertical li a span.t
     vertical-align: -15%
 }
 
-.wy-alert, .rst-content .note, .rst-content .attention, .rst-content .caution, .rst-content .danger, .rst-content .error, .rst-content .hint, .rst-content .important, .rst-content .tip, .rst-content .warning, .rst-content .seealso, .rst-content .admonition-todo {
+.wy-alert, .rst-content .note, .rst-content .attention, .rst-content .caution, .rst-content .danger, .rst-content .error, .rst-content .hint, .rst-content .important, .rst-content .tip, .rst-content .warning, .rst-content .seealso, .rst-content .admonition-todo, .rst-content div.deprecated {
     padding: 12px;
     line-height: 24px;
     margin-bottom: 24px;
     background: #e7f2fa
 }
 
-.wy-alert-title, .rst-content .admonition-title {
+.wy-alert-title, .rst-content .admonition-title, .rst-content .deprecated .versionmodified {
     color: #fff;
     font-weight: bold;
     display: block;
@@ -6067,6 +6067,10 @@ url('../opensans_regular_macroman/OpenSans-Regular-webfont.svg#open_sansregular'
 img.screenshot, a.screenshot img {
     box-shadow: 0 4px 18px 0 rgba(0,0,0,0.1), 0 6px 20px 0 rgba(0,0,0,0.09);
 }
+section > a.screenshot {
+    display: block;
+    margin-bottom: 24px;
+}
 
 /* Changes */
 .versionchanged {

doc/admin/config.rst

@@ -2,7 +2,7 @@
 
 .. _`config`:
 
-.. spelling:: Galera
+.. spelling:word-list:: Galera
 
 Configuration file
 ==================
@@ -65,6 +65,9 @@ Example::
     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``.
 
@@ -81,7 +84,7 @@ Example::
     Enables or disables the "keep me logged in" button. Defaults to ``on``.
 
 ``ecb_rates``
-    By default, pretix periodically downloads a XML file from the European Central Bank to retrieve exchange 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``.
 
@@ -103,6 +106,11 @@ Example::
     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``.
 
@@ -114,6 +122,9 @@ Example::
 ``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
 ---------------
 
@@ -135,7 +146,7 @@ Database settings
 Example::
 
     [database]
-    backend=mysql
+    backend=postgresql
     name=pretix
     user=pretix
     password=abcd
@@ -143,23 +154,15 @@ Example::
     port=3306
 
 ``backend``
-    One of ``mysql``, ``sqlite3``, ``oracle`` and ``postgresql``.
+    One of ``sqlite3`` and ``postgresql``.
     Default: ``sqlite3``.
 
-    If you use MySQL, be sure to create your database using
-    ``CREATE DATABASE <dbname> CHARACTER SET utf8;``. Otherwise, Unicode
-    support will not properly work.
-
 ``name``
     The database's name. Default: ``db.sqlite3``.
 
 ``user``, ``password``, ``host``, ``port``
     Connection details for the database connection. Empty by default.
 
-``galera``
-    Indicates if the database backend is a MySQL/MariaDB Galera cluster and
-    turns on some optimizations/special case handlers. Default: ``False``
-
 .. _`config-replica`:
 
 Database replica settings
@@ -188,7 +191,7 @@ Example::
 
     [urls]
     media=/media/
-    static=/media/
+    static=/static/
 
 ``media``
     The URL to be used to serve user-uploaded content. You should not need to modify
@@ -220,12 +223,30 @@ Example::
 ``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``
 
-``tls``, ``ssl``
-    Use STARTTLS or SSL for the SMTP connection. Off by default.
+``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.
@@ -282,7 +303,7 @@ You can use an existing memcached server as pretix's caching backend::
 ``location``
     The location of memcached, either a host:port combination or a socket file.
 
-If no memcached is configured, pretix will use Django's built-in local-memory caching method.
+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
@@ -297,6 +318,12 @@ 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
 
 ``location``
     The location of redis, as a URL of the form ``redis://[:password]@localhost:6379/0``
@@ -305,13 +332,34 @@ to speed up various operations::
 ``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.
+
 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. Some of them are marked as "incubating", which means
+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::
 
@@ -337,11 +385,22 @@ an AMQP server (e.g. RabbitMQ) as a broker and redis or your database as a resul
     [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`_.
+
+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
 ------
 
@@ -350,10 +409,18 @@ application. If you want to use sentry, you need to set a DSN in the configurati
 
     [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
 -------
@@ -388,3 +455,36 @@ pretix can make use of some external tools if they are installed. Currently, the
 
 .. _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

@@ -0,0 +1,40 @@
+.. _`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

@@ -9,7 +9,10 @@ This documentation is for everyone who wants to install pretix on a server.
    :maxdepth: 2
 
    installation/index
+   updates
    config
    maintainance
    scaling
+   errors
+   mysql2postgres
    indexes

doc/admin/indexes.rst

@@ -45,10 +45,12 @@ Here is the currently recommended set of commands::
     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_scret
+    CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_secret
         ON pretixbase_orderposition
         USING gin (upper("secret") gin_trgm_ops);
     CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_email
@@ -60,6 +62,14 @@ Here is the currently recommended set of commands::
     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::

doc/admin/installation/dev_version.rst

@@ -16,7 +16,7 @@ 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&subdirectory=src"
+    (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

doc/admin/installation/docker_smallscale.rst

@@ -14,7 +14,7 @@ This has some trade-offs in terms of performance and isolation but allows a rath
              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 8.0** but it should work very similar on other
+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
@@ -26,7 +26,7 @@ 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`_ 9.5+, `MySQL`_ 5.7+, or MariaDB 10.2.7+ database server
+* 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
@@ -36,8 +36,9 @@ Linux and firewalls, we recommend that you start with `ufw`_.
           SSL certificates can be obtained for free these days. We also *do not* provide support for HTTP-only
           installations except for evaluation purposes.
 
-.. warning:: We recommend **PostgreSQL**. If you go for MySQL, make sure you run **MySQL 5.7 or newer** or
-             **MariaDB 10.2.7 or newer**.
+.. 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
 -------------
@@ -58,7 +59,12 @@ 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. For PostgreSQL, we would do::
+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
@@ -77,11 +83,6 @@ Restart PostgreSQL after you changed these files::
 
 If you have a firewall running, you should also make sure that port 5432 is reachable from the ``172.17.0.1/16`` subnet.
 
-For MySQL, you can either also use network-based connections or mount the ``/var/run/mysqld/mysqld.sock`` socket into the docker container.
-When using MySQL, make sure you set the character set of the database to ``utf8mb4``, e.g. like this::
-
-    mysql > CREATE DATABASE pretix DEFAULT CHARACTER SET utf8mb4 DEFAULT COLLATE utf8mb4_unicode_ci;
-
 Redis
 -----
 
@@ -97,6 +98,18 @@ 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
@@ -129,15 +142,13 @@ Fill the configuration file ``/etc/pretix/pretix.cfg`` with the following conten
     trust_x_forwarded_proto=on
 
     [database]
-    ; Replace postgresql with mysql for MySQL
     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. Adjuts
-    ; this to wherever your database is running, e.g. the name of a linked container
-    ; or of a mounted MySQL socket.
+    ; 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]
@@ -178,7 +189,7 @@ named ``/etc/systemd/system/pretix.service`` with the following content::
     TimeoutStartSec=0
     ExecStartPre=-/usr/bin/docker kill %n
     ExecStartPre=-/usr/bin/docker rm %n
-    ExecStart=/usr/bin/docker run --name %n -p 8345:80 \
+    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 \
@@ -189,8 +200,6 @@ named ``/etc/systemd/system/pretix.service`` with the following content::
     [Install]
     WantedBy=multi-user.target
 
-When using MySQL and socket mounting, you'll need the additional flag ``-v /var/run/mysqld:/var/run/mysqld`` in the command.
-
 You can now run the following commands
 to enable and start the service::
 
@@ -217,6 +226,9 @@ The following snippet is an example on how to configure a nginx proxy for pretix
         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;
@@ -228,7 +240,7 @@ The following snippet is an example on how to configure a nginx proxy for pretix
         ssl_certificate_key /path/to/key.pem;
 
         location / {
-            proxy_pass http://localhost:8345/;
+            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;
@@ -247,6 +259,8 @@ create an event and start selling tickets!
 
 You should probably read :ref:`maintainance` next.
 
+.. _`docker_updates`:
+
 Updates
 -------
 
@@ -262,6 +276,8 @@ Restarting the service can take a few seconds, especially if the update requires
 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
@@ -305,12 +321,11 @@ 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-16-04
+.. _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/
-.. _MySQL: https://dev.mysql.com/doc/refman/5.7/en/linux-installation-apt-repo.html
-.. _PostgreSQL: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-20-04
+.. _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

doc/admin/installation/general.rst

@@ -1,6 +1,6 @@
 .. highlight:: ini
 
-.. spelling:: SQL
+.. spelling:word-list:: SQL
 
 General remarks
 ===============
@@ -16,14 +16,11 @@ To use pretix, you will need the following things:
 * 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** or **MySQL/MariaDB**. If you do not provide one, pretix will run on SQLite, which is useful
+  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.
 
-  .. warning:: We recommend **PostgreSQL**. If you go for MySQL, make sure you run **MySQL 5.7 or newer** or
-               **MariaDB 10.2.7 or newer**.
-
 * 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.

doc/admin/installation/manual_smallscale.rst

@@ -12,7 +12,7 @@ solution with many things readily set-up, look at :ref:`dockersmallscale`.
              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 10.0** but it should work very similar on other
+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
@@ -21,10 +21,12 @@ 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`_ 9.5+, `MySQL`_ 5.7+, or MariaDB 10.2.7+ database server
+* 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`_.
@@ -33,9 +35,6 @@ Linux and firewalls, we recommend that you start with `ufw`_.
           SSL certificates can be obtained for free these days. We also *do not* provide support for HTTP-only
           installations except for evaluation purposes.
 
-.. warning:: We recommend **PostgreSQL**. If you go for MySQL, make sure you run **MySQL 5.7 or newer** or
-             **MariaDB 10.2.7 or newer**.
-
 Unix user
 ---------
 
@@ -50,15 +49,16 @@ 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. For PostgreSQL, we would do::
+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
 
-When using MySQL, make sure you set the character set of the database to ``utf8mb4``, e.g. like this::
-
-    mysql > CREATE DATABASE pretix DEFAULT CHARACTER SET utf8mb4 DEFAULT COLLATE utf8mb4_unicode_ci;
-
 Package dependencies
 --------------------
 
@@ -66,7 +66,7 @@ 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 libmariadbclient-dev libjpeg-dev libopenjp2-7-dev
+                      gettext libpq-dev libjpeg-dev libopenjp2-7-dev
 
 Config file
 -----------
@@ -89,16 +89,12 @@ Fill the configuration file ``/etc/pretix/pretix.cfg`` with the following conten
     trust_x_forwarded_proto=on
 
     [database]
-    ; For MySQL, replace with "mysql"
     backend=postgresql
     name=pretix
     user=pretix
-    ; For MySQL, enter the user password. For PostgreSQL on the same host,
-    ; we don't need one because we can use peer authentification if our
-    ; PostgreSQL user matches our unix user.
+    ; 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 MySQL, use local socket, e.g. /var/run/mysqld/mysqld.sock
-    ; For a remote host, supply an IP address
     ; For local postgres authentication, you can leave it empty
     host=
 
@@ -128,12 +124,11 @@ python installation::
     $ source /var/pretix/venv/bin/activate
     (venv)$ pip3 install -U pip setuptools wheel
 
-We now install pretix, its direct dependencies and gunicorn. Replace ``postgres`` with ``mysql`` in the following
-command if you're running MySQL::
+We now install pretix, its direct dependencies and gunicorn::
 
-    (venv)$ pip3 install "pretix[postgres]" gunicorn
+    (venv)$ pip3 install pretix gunicorn
 
-Note that you need Python 3.6 or newer. You can find out your Python version using ``python -V``.
+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::
 
@@ -214,6 +209,9 @@ The following snippet is an example on how to configure a nginx proxy for pretix
         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;
@@ -228,7 +226,7 @@ The following snippet is an example on how to configure a nginx proxy for pretix
         add_header X-Content-Type-Options nosniff;
 
         location / {
-            proxy_pass http://localhost:8345/;
+            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;
@@ -250,14 +248,14 @@ The following snippet is an example on how to configure a nginx proxy for pretix
         }
 
         location /static/ {
-            alias /var/pretix/venv/lib/python3.5/site-packages/pretix/static.dist/;
+            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.5`` in the ``/static/`` path in the config 
+.. 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.
@@ -271,21 +269,23 @@ 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 (again, replace
-``postgres`` with ``mysql`` if necessary)::
+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 pretix[postgres] gunicorn
+    (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`:
 
@@ -302,13 +302,34 @@ example::
     (venv)$ python -m pretix rebuild
     # systemctl restart pretix-web pretix-worker
 
+System updates
+--------------
 
-.. _Postfix: https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-postfix-as-a-send-only-smtp-server-on-ubuntu-16-04
+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/
-.. _MySQL: https://dev.mysql.com/doc/refman/5.7/en/linux-installation-apt-repo.html
-.. _PostgreSQL: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-20-04
+.. _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

@@ -9,17 +9,19 @@ If you host your own pretix instance, you also need to care about the availabili
 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 (MySQL or PostgreSQL). 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 MySQL, see ``mysqldump`` and for PostgreSQL, see the ``pg_dump`` tool. You probably
-    want to create a cronjob that does the backups for you on a regular schedule.
+    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
@@ -95,6 +97,12 @@ pretix_model_instances
     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

@@ -0,0 +1,241 @@
+.. 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

@@ -25,7 +25,7 @@ and what you should think of.
 Scaling reasons
 ---------------
 
-There's mainly two reasons to scale up a pretix installation beyond a single server:
+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.
 
@@ -42,7 +42,7 @@ A pretix installation usually consists of the following components which run per
 
 * ``pretix-worker`` is a Celery-based application that processes tasks that should be run asynchronously outside of the web application process.
 
-* A **SQL database** keeps all the important data and processes the actual transactions. We recommend using PostgreSQL, but MySQL/MariaDB works as well.
+* 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``.
 
@@ -74,7 +74,7 @@ We recommend reading up on tuning your web server for high concurrency. For ngin
 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 us of more CPU resources, while memory usage will stay comparatively low,
+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)
@@ -92,7 +92,7 @@ them from a different URL <config-urls>`.
 pretix-web
 """"""""""
 
-The ``pretix-web`` process does not carry any internal state can be easily started on as many machines as you like, and you can
+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
@@ -154,7 +154,7 @@ 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 a 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.
+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`_.
 
@@ -171,12 +171,12 @@ you configure, so make sure to set this memory usage as high as you can afford.
 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 to have a replica of your database for availability reasons. In case your primary
+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 gains is much more complicated. When using
+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 and it is important
+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::
@@ -187,7 +187,7 @@ that you have a deep understanding of the semantics of your replication mechanis
    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 out-of-data data and you can end up with more tickets sold than configured. Similarly,
+   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>`.
@@ -204,9 +204,9 @@ 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 in case of e.g. lots of tasks queuing up during a traffic peak, but we wouldn't expect ever needing more than a gigabyte of it.
+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 won't need it for performance in a long time.
+Feel free to set up a redis cluster for availability – but you probably won't need it for performance.
 
 The limitations
 ---------------
@@ -228,9 +228,9 @@ 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 to reduce the number of cases in which this is relevant and thereby improve the 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/
+.. _object storage cluster: https://behind.pretix.eu/2018/03/20/high-available-cdn/

doc/admin/updates.rst

@@ -0,0 +1,51 @@
+.. _`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

@@ -32,6 +32,8 @@ as well as the type of underlying hardware. Example:
        "token": "kpp4jn8g2ynzonp6",
        "hardware_brand": "Samsung",
        "hardware_model": "Galaxy S",
+       "os_name": "Android",
+       "os_version": "2.3.6",
        "software_brand": "pretixdroid",
        "software_version": "4.0.0"
    }
@@ -98,12 +100,46 @@ following endpoint:
    {
        "hardware_brand": "Samsung",
        "hardware_model": "Galaxy S",
+       "os_name": "Android",
+       "os_version": "2.3.6",
        "software_brand": "pretixdroid",
-       "software_version": "4.1.0"
+       "software_version": "4.1.0",
+       "info": {"arbitrary": "data"}
    }
 
 You will receive a response equivalent to the response of your initialization request.
 
+Device Information
+------------------
+
+You can request information about your device and the server with one call:
+
+.. sourcecode:: http
+
+   GET /api/v1/device/info HTTP/1.1
+   Host: pretix.eu
+
+The response will look like this:
+
+.. sourcecode:: http
+
+   HTTP/1.1 200 OK
+   Content-Type: application/json
+
+   {
+     "device": {
+       "organizer": "foo",
+       "device_id": 5,
+       "unique_serial": "HHZ9LW9JWP390VFZ",
+       "api_token": "1kcsh572fonm3hawalrncam4l1gktr2rzx25a22l8g9hx108o9oi0rztpcvwnfnd",
+       "name": "Bar",
+       "gate": {
+         "id": 3,
+         "name": "South entrance"
+       }
+     }
+   }
+
 Creating a new API key
 ----------------------
 
@@ -193,4 +229,3 @@ You can get three response codes:
       "subevent": 23,
       "checkinlist": 5
    }
-

doc/api/fundamentals.rst

@@ -43,13 +43,16 @@ Possible permissions are:
 * Can view vouchers
 * Can change vouchers
 
+.. _`rest-compat`:
+
 Compatibility
 -------------
 
-We currently see pretix' API as a beta-stage feature. We therefore do not give any guarantees
-for compatibility between feature releases of pretix (such as 1.5 and 1.6). However, as always,
-we try not to break things when we don't need to. Any backwards-incompatible changes will be
-prominently noted in the release notes.
+We try to avoid any breaking changes to our API to avoid hassle on your end. If possible, we'll
+build new features in a way that keeps all pre-existing API usage unchanged. In some cases,
+this might not be possible or only possible with restrictions. In these case, any
+backwards-incompatible changes will be prominently noted in the "Changes to the REST API"
+section of our release notes. If possible, we will announce them multiple releases in advance.
 
 We treat the following types of changes as *backwards-compatible* so we ask you to make sure
 that your clients can deal with them properly:
@@ -58,6 +61,8 @@ that your clients can deal with them properly:
 * Support of new HTTP methods for a given API endpoint
 * Support of new query parameters for a given API endpoint
 * New fields contained in API responses
+* New possible values of enumeration-like fields
+* Response body structure or message texts on failed requests (``4xx``, ``5xx`` response codes)
 
 We treat the following types of changes as *backwards-incompatible*:
 
@@ -87,7 +92,8 @@ respectively, or ``null`` if there is no such page. You can use those URLs to re
 respective page.
 
 The field ``results`` contains a list of objects representing the first results. For most
-objects, every page contains 50 results.
+objects, every page contains 50 results. You can specify a lower pagination size using the
+``page_size`` query parameter, but no more than 50.
 
 Conditional fetching
 --------------------
@@ -183,6 +189,12 @@ Relative date         *either* String in ISO 8601  ``"2017-12-27"``,
                       constructed from a number of
                       days before the base point
                       and the base point.
+File                  URL in responses, ``file:``  ``"https://…"``, ``"file:…"``
+                      specifiers in requests
+                      (see below).
+Date range            *either* two dates separated ``2022-03-18/2022-03-23``, ``2022-03-18/``,
+                      by ``/`` *or* the name of a  ``/2022-03-23``, ``week_this``, ``week_next``,
+                      defined range.               ``month_this``
 ===================== ============================ ===================================
 
 Query parameters
@@ -210,13 +222,16 @@ Please note that this also goes for most error responses. For example, if we ret
 error and you retry with the same ``X-Idempotency-Key``, you will get the same error again, even if you were granted
 permission in the meantime! This includes internal server errors on our side that might have been fixed in the meantime.
 
-There are only three exceptions to the rule:
+There are only the following exceptions to the rule:
 
 * Responses with status code ``409 Conflict`` are not cached. If you send the request again, it will be executed as a
   new request, since these responses are intended to be retried.
 
 * Rate-limited responses with status code ``429 Too Many Requests`` are not cached and you can safely retry them.
 
+* Responses with status code ``500 Internal Server Error`` are not cached and you can retry them. This is not guaranteed
+  to be safe in all theoretical cases,  but 500 by definition is an unforeseen situation and we need to have some way out.
+
 * Responses with status code ``503 Service Unavailable`` are not cached and you can safely retry them.
 
 If you send a request with an ``X-Idempotency-Key`` header that we have seen before but that has not yet received a
@@ -227,4 +242,48 @@ We store idempotency keys for 24 hours, so you should never retry a request afte
 All ``POST``, ``PUT``, ``PATCH``, or ``DELETE`` api calls support idempotency keys. Adding an idempotency key to a
 ``GET``, ``HEAD``, or ``OPTIONS`` request has no effect.
 
+
+File upload
+-----------
+
+In some places, the API supports working with files, for example when setting the picture of a product. In this case,
+you will first need to make a separate request to our file upload endpoint:
+
+.. sourcecode:: http
+
+   POST /api/v1/upload HTTP/1.1
+   Host: pretix.eu
+   Authorization: Token e1l6gq2ye72thbwkacj7jbri7a7tvxe614ojv8ybureain92ocub46t5gab5966k
+   Content-Type: image/png
+   Content-Disposition: attachment; filename="logo.png"
+   Content-Length: 1234
+
+   <raw file content>
+
+Note that the ``Content-Type`` and ``Content-Disposition`` headers are required. If the upload was successful, you will
+receive a JSON response with the ID of the file:
+
+.. sourcecode:: http
+
+   HTTP/1.1 201 Created
+   Content-Type: application/json
+
+   {
+     "id": "file:1cd99455-1ebd-4cda-b1a2-7a7d2a969ad1"
+   }
+
+You can then use this file ID in the request you want to use it in. File IDs are currently valid for 24 hours and can only
+be used using the same authorization method and user that was used to upload them.
+
+.. sourcecode:: http
+
+   PATCH /api/v1/organizers/test/events/test/items/3/ HTTP/1.1
+   Host: pretix.eu
+   Content-Type: application/json
+
+   {
+     "picture": "file:1cd99455-1ebd-4cda-b1a2-7a7d2a969ad1"
+   }
+
+
 .. _CSRF policies: https://docs.djangoproject.com/en/1.11/ref/csrf/#ajax

doc/api/guides/custom_checkout.rst

@@ -97,7 +97,8 @@ For example, if you want users to be redirected to ``https://example.org/order/r
 either enter ``https://example.org`` or ``https://example.org/order/``.
 
 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**. Make sure you use our API to check if the payment actually
+**regardless of whether it was successful or not**. We will append an ``error=…`` query parameter with an error
+message, but you should not rely on that and instead make sure you use our API to check if the payment actually
 worked! Your final URL could look like this::
 
     https://test.pretix.eu/democon/3vjrh/order/NSLEZ/ujbrnsjzbq4dzhck/pay/123/?return_url=https%3A%2F%2Fexample.org%2Forder%2Freturn%3Ftx_id%3D1234

doc/api/guides/index.rst

@@ -8,4 +8,5 @@ This part of the documentation contains how-to guides on some special use cases
 .. toctree::
    :maxdepth: 2
 
+   order_lifecycle
    custom_checkout

doc/api/guides/order_lifecycle.rst

@@ -0,0 +1,56 @@
+Understanding the life cycle of orders
+======================================
+
+When integrating pretix with other systems, it is important that you understand how orders and related objects
+such as order positions, fees, payments, refunds, and invoices work together, in order to react to their changes
+properly and map them to processes in your system.
+
+Order states
+------------
+
+Generally, an order can be in six states. For compatibility reasons, the ``status`` field only allows four values
+and the two remaining states are modeled through the ``require_approval`` field and the number of positions within
+an order. The states and their allowed changes are shown in the following graph:
+
+.. image:: /images/order_states.png
+
+
+Object types
+------------
+
+Order
+    One order represents one purchase. It's the main object you interact with and bundles all the other objects
+    together. Orders can change in many ways during their lifetime, but will never be deleted (unless ``testmode``
+    is set to ``true``).
+
+Order position
+    An order position represents one product contained in the order. Orders can usually have multiple positions.
+    There might be a parent-child relation between order positions if one position is an add-on to another position.
+    Order positions can change in many ways during their lifetime, and can also be removed or added to an order.
+
+Order fees
+    A fee represents a charge that is not related to a product. Examples include shipping fees, service fees, and
+    cancellation fees.
+    Order fees can change in many ways during their lifetime, and can also be removed or added to an order.
+
+Order payment
+    An order payment represents one payment attempt with a specific payment method and amount. An order can have
+    multiple payments attached.
+    Order payments have their own state diagram. Apart from their state and their meta information (e.g. used
+    credit card, …) they usually don't change. They may be added at any time, but will never be deleted.
+
+Order refund
+    An order payment represents one refund attempt with a specific payment method and amount. An order can have
+    multiple refunds attached.
+    Order refunds have their own state diagram. Apart from their state and their meta information (e.g. used
+    credit card, …) they usually don't change. They may be added at any time, but will never be deleted.
+
+Invoice
+    An invoice represents a legal document stating the contents of an order. While the backend technically allows
+    to update an invoice in some situations, invoices are generally considered immutable. Once they are issued,
+    they no longer change. If the order changes substantially (e.g. prices change), an invoice is canceled through
+    creation of a new invoice with the opposite amount, plus the issuance of a new invoice.
+
+Here's an example of how they all play together:
+
+.. image:: /images/order_objects.png

doc/api/oauth.rst

@@ -107,9 +107,9 @@ You can supply a valid access token as a ``Bearer``-type token in the ``Authoriz
 .. sourcecode:: http
    :emphasize-lines: 3
 
-       GET /api/v1/organizers/ HTTP/1.1
-       Host: pretix.eu
-       Authorization: Bearer i3ytqTSRWsKp16fqjekHXa4tdM4qNC
+   GET /api/v1/organizers/ HTTP/1.1
+   Host: pretix.eu
+   Authorization: Bearer i3ytqTSRWsKp16fqjekHXa4tdM4qNC
 
 Refreshing an access token
 --------------------------

doc/api/resources/carts.rst

@@ -17,8 +17,8 @@ The cart position resource contains the following public fields:
 Field                                 Type                       Description
 ===================================== ========================== =======================================================
 id                                    integer                    Internal ID of the cart position
-cart_id                               string                     Identifier of the cart this belongs to. Needs to end
-                                                                 in "@api" for API-created positions.
+cart_id                               string                     Identifier of the cart this belongs to, needs to end
+                                                                 in "@api" for API-created positions
 datetime                              datetime                   Time of creation
 expires                               datetime                   The cart position will expire at this time and no longer block quota
 item                                  integer                    ID of the item
@@ -29,26 +29,23 @@ attendee_name_parts                   object of strings          Composition of
 attendee_email                        string                     Specified attendee email address for this position (or ``null``)
 voucher                               integer                    Internal ID of the voucher used for this position (or ``null``)
 addon_to                              integer                    Internal ID of the position this position is an add-on for (or ``null``)
-subevent                              integer                    ID of the date inside an event series this position belongs to (or ``null``).
+is_bundled                            boolean                    If ``addon_to`` is set, this shows whether this is a bundled product or an addon product
+subevent                              integer                    ID of the date inside an event series this position belongs to (or ``null``)
 answers                               list of objects            Answers to user-defined questions
 ├ question                            integer                    Internal ID of the answered question
 ├ answer                              string                     Text representation of the answer
 ├ question_identifier                 string                     The question's ``identifier`` field
 ├ options                             list of integers           Internal IDs of selected option(s)s (only for choice types)
 └ option_identifiers                  list of strings            The ``identifier`` fields of the selected option(s)s
-seat                                  objects                    The assigned seat. Can be ``null``.
+seat                                  objects                    The assigned seat (or ``null``)
 ├ id                                  integer                    Internal ID of the seat instance
 ├ name                                string                     Human-readable seat name
 └ seat_guid                           string                     Identifier of the seat within the seating plan
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.17
+.. versionchanged:: 4.14
 
-   This resource has been added.
-
-.. versionchanged:: 3.0
-
-   This ``seat`` attribute has been added.
+   This ``is_bundled`` attribute has been added and the cart creation endpoints have been updated.
 
 
 Cart position endpoints
@@ -91,6 +88,7 @@ Cart position endpoints
             "attendee_email": null,
             "voucher": null,
             "addon_to": null,
+            "is_bundled": false,
             "subevent": null,
             "datetime": "2018-06-11T10:00:00Z",
             "expires": "2018-06-11T10:00:00Z",
@@ -137,6 +135,7 @@ Cart position endpoints
         "attendee_email": null,
         "voucher": null,
         "addon_to": null,
+        "is_bundled": false,
         "subevent": null,
         "datetime": "2018-06-11T10:00:00Z",
         "expires": "2018-06-11T10:00:00Z",
@@ -172,16 +171,16 @@ Cart position endpoints
 
        * does not validate if the event's ticket sales are already over or haven't started
 
-       * does not support add-on products at the moment
+       * does not validate constraints on add-on products at the moment
 
        * does not check or calculate prices but believes any prices you send
 
-       * does not support the redemption of vouchers
-
        * does not prevent you from buying items that can only be bought with a voucher
 
        * does not support file upload questions
 
+       Note that more validation might be added in the future, so please do not rely on missing validation.
+
    You can supply the following fields of the resource:
 
    * ``cart_id`` (optional, needs to end in ``@api``)
@@ -193,8 +192,11 @@ Cart position endpoints
    * ``attendee_email`` (optional)
    * ``subevent`` (optional)
    * ``expires`` (optional)
-   * ``includes_tax`` (optional)
+   * ``includes_tax`` (optional, **deprecated**, do not use, will be removed)
    * ``sales_channel`` (optional)
+   * ``voucher`` (optional, expect a voucher code)
+   * ``addons`` (optional, expect a list of nested objects of cart positions)
+   * ``bundled`` (optional, expect a list of nested objects of cart positions)
    * ``answers``
 
       * ``question``
@@ -226,6 +228,12 @@ Cart position endpoints
             "options": []
           }
         ],
+        "addons": [
+          {
+            "item": 2,
+            "variation": null,
+          }
+        ],
         "subevent": null
       }
 
@@ -237,7 +245,7 @@ Cart position endpoints
       Vary: Accept
       Content-Type: application/json
 
-      (Full cart position resource, see above.)
+      (Full cart position resource, see above, with additional nested objects "addons" and "bundled".)
 
    :param organizer: The ``slug`` field of the organizer of the event to create a position for
    :param event: The ``slug`` field of the event to create a position for
@@ -247,6 +255,99 @@ Cart position endpoints
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to create this
          order.
 
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/cartpositions/bulk_create/
+
+   Creates multiple new cart position. **This operation is deliberately not atomic, so each cart position can succeed
+   or fail individually, so the response code of the response is not the only thing to look at!**
+
+   .. warning:: This endpoint is considered **experimental**. It might change at any time without prior notice.
+
+   .. warning:: The same limitations as with the regular creation endpoint apply.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/cartpositions/bulk_create/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      [
+        {
+          "item": 1,
+          "variation": null,
+          "price": "23.00",
+          "attendee_name_parts": {
+            "given_name": "Peter",
+            "family_name": "Miller"
+          },
+          "attendee_email": null,
+          "answers": [
+            {
+              "question": 1,
+              "answer": "23",
+              "options": []
+            }
+          ],
+          "subevent": null
+        },
+        {
+          "item": 1,
+          "variation": null,
+          "price": "23.00",
+          "attendee_name_parts": {
+            "given_name": "Maria",
+            "family_name": "Miller"
+          },
+          "attendee_email": null,
+          "answers": [
+            {
+              "question": 1,
+              "answer": "23",
+              "options": []
+            }
+          ],
+          "subevent": null
+        }
+      ]
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "results": [
+          {
+            "success": true,
+            "errors": null,
+            "data": {
+              "id": 1,
+              ...
+            },
+          },
+          {
+            "success": "false",
+            "errors": {
+              "non_field_errors": ["There is not enough quota available on quota \"Tickets\" to perform the operation."]
+            },
+            "data": null
+          }
+        ]
+      }
+
+   :param organizer: The ``slug`` field of the organizer of the event to create positions for
+   :param event: The ``slug`` field of the event to create positions for
+   :statuscode 200: See response for success
+   :statuscode 400: Your input could not be parsed
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to create this
+         order.
+
 .. http:delete:: /api/v1/organizers/(organizer)/events/(event)/cartpositions/(id)/
 
    Deletes a cart position, identified by its internal ID.

doc/api/resources/categories.rst

@@ -25,14 +25,6 @@ is_addon                              boolean                    If ``true``, it
                                                                  defining add-ons for other products.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.14
-
-   The operations POST, PATCH, PUT and DELETE have been added.
-
-.. versionchanged:: 1.16
-
-   The field ``internal_name`` has been added.
-
 
 Endpoints
 ---------

doc/api/resources/checkin.rst

@@ -0,0 +1,354 @@
+.. spelling:word-list:: checkin
+
+.. _rest-checkin:
+
+Check-in
+========
+
+This page describes special APIs built for ticket scanning apps. For managing check-in configuration or other operations,
+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
+--------------------
+
+.. http:post:: /api/v1/organizers/(organizer)/checkinrpc/redeem/
+
+   Tries to redeem an order position, i.e. checks the attendee in (or out). This is the recommended endpoint to use
+   if you build any kind of scanning app that performs check-ins for scanned barcodes. It is safe to use with untrusted
+   inputs in the ``secret`` field.
+
+   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.
+
+   :<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.
+   :<json string type: Send ``"exit"`` for an exit and ``"entry"`` (default) for an entry.
+   :<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,
+                         because there's no point in validating them since they happened whether they are valid or not. Defaults to ``false``.
+   :<json boolean questions_supported: When this parameter is set to ``true``, handling of questions is supported. If
+                                       you do not implement question handling in your user interface, you **must**
+                                       set this to ``false``. In that case, questions will just be ignored. Defaults
+                                       to ``true``.
+   :<json boolean ignore_unpaid: Specifies that the check-in should succeed even if the order is in pending state.
+                                 Defaults to ``false`` and only works when ``include_pending`` is set on the check-in
+                                 list.
+   :<json object answers: If questions are supported/required, you may/must supply a mapping of question IDs to their
+                          respective answers. The answers should always be strings. In case of (multiple-)choice-type
+                          answers, the string should contain the (comma-separated) IDs of the selected options.
+   :<json string nonce: You can set this parameter to a unique random value to identify this check-in. If you're sending
+                        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 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.
+   :>json object position: Copy of the matching order position (if any was found). The contents are the same as the
+                           :ref:`order-position-resource`, with the following differences: (1) The ``checkins`` value
+                           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.
+   :>json boolean require_attention: Whether or not the ``require_attention`` flag is set on the item or order.
+   :>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"``.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/checkinrpc/redeem/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+      {
+        "secret": "M5BO19XmFwAjLd4nDYUAL9ISjhti0e9q",
+        "source_type": "barcode",
+        "lists": [1],
+        "force": false,
+        "ignore_unpaid": false,
+        "nonce": "Pvrk50vUzQd0DhdpNRL4I4OcXsvg70uA",
+        "datetime": null,
+        "questions_supported": true,
+        "answers": {
+          "4": "XS"
+        }
+      }
+
+   **Example successful response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "status": "ok",
+        "position": {
+          …
+        },
+        "require_attention": false,
+        "list": {
+          "id": 1,
+          "name": "Default check-in list",
+          "event": "sampleconf",
+          "subevent": null,
+          "include_pending": false
+        }
+      }
+
+   **Example response with required questions**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 400 Bad Request
+      Content-Type: text/json
+
+      {
+        "status": "incomplete",
+        "position": {
+          …
+        },
+        "require_attention": false,
+        "list": {
+          "id": 1,
+          "name": "Default check-in list",
+          "event": "sampleconf",
+          "subevent": null,
+          "include_pending": false
+        },
+        "questions": [
+          {
+            "id": 1,
+            "question": {"en": "T-Shirt size"},
+            "type": "C",
+            "required": false,
+            "items": [1, 2],
+            "position": 1,
+            "identifier": "WY3TP9SL",
+            "ask_during_checkin": true,
+            "options": [
+              {
+                "id": 1,
+                "identifier": "LVETRWVU",
+                "position": 0,
+                "answer": {"en": "S"}
+              },
+              {
+                "id": 2,
+                "identifier": "DFEMJWMJ",
+                "position": 1,
+                "answer": {"en": "M"}
+              },
+              {
+                "id": 3,
+                "identifier": "W9AH7RDE",
+                "position": 2,
+                "answer": {"en": "L"}
+              }
+            ]
+          }
+        ]
+      }
+
+   **Example error response (invalid ticket)**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 404 Not Found
+      Content-Type: text/json
+
+      {
+        "detail": "Not found.",
+        "status": "error",
+        "reason": "invalid",
+        "reason_explanation": null,
+        "require_attention": false
+      }
+
+   **Example error response (known, but invalid ticket)**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Content-Type: text/json
+
+      {
+        "status": "error",
+        "reason": "unpaid",
+        "reason_explanation": null,
+        "require_attention": false,
+        "list": {
+          "id": 1,
+          "name": "Default check-in list",
+          "event": "sampleconf",
+          "subevent": null,
+          "include_pending": false
+        },
+        "position": {
+          …
+        }
+      }
+
+   Possible error reasons:
+
+   * ``invalid`` - Ticket is not known.
+   * ``unpaid`` - Ticket is not paid for.
+   * ``blocked`` - Ticket has been blocked.
+   * ``invalid_time`` - Ticket is not valid at this time.
+   * ``canceled`` – Ticket is canceled or expired.
+   * ``already_redeemed`` - Ticket already has been redeemed.
+   * ``product`` - Tickets with this product may not be scanned at this device.
+   * ``rules`` - Check-in prevented by a user-defined rule.
+   * ``ambiguous`` - Multiple tickets match scan, rejected.
+   * ``revoked`` - Ticket code has been revoked.
+   * ``error`` - Internal error.
+
+   In case of reason ``rules`` and ``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``.
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :statuscode 201: 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 order position does not exist.
+
+Performing a ticket search
+--------------------------
+
+.. http:get:: /api/v1/organizers/(organizer)/checkinrpc/search/
+
+   Returns a list of all order positions matching a given search request. The result is the same as
+   the :ref:`order-position-resource`, with the following differences:
+
+   * The ``checkins`` value will only include check-ins for the selected list.
+
+   * An additional boolean property ``require_attention`` will inform you whether either the order or the item
+     have the ``checkin_attention`` flag set.
+
+   * If ``attendee_name`` is empty, it will automatically fall back to values from a parent product or from invoice
+     addresses.
+
+   This endpoint supports passing multiple check-in lists to perform a multi-event search. However, each check-in list
+   passed needs to be from a distinct event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/checkinrpc/search/?list=1&search=Peter 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": 23442,
+            "order": "ABC12",
+            "positionid": 1,
+            "item": 1345,
+            "variation": null,
+            "price": "23.00",
+            "attendee_name": "Peter",
+            "attendee_name_parts": {
+              "full_name": "Peter",
+            },
+            "attendee_email": null,
+            "voucher": null,
+            "tax_rate": "0.00",
+            "tax_rule": null,
+            "tax_value": "0.00",
+            "secret": "z3fsn8jyufm5kpk768q69gkbyr5f4h6w",
+            "addon_to": null,
+            "subevent": null,
+            "pseudonymization_id": "MQLJvANO3B",
+            "seat": null,
+            "checkins": [
+              {
+                "list": 1,
+                "type": "entry",
+                "gate": null,
+                "device": 2,
+                "datetime": "2017-12-25T12:45:23Z",
+                "auto_checked_in": true
+              }
+            ],
+            "answers": [
+              {
+                "question": 12,
+                "answer": "Foo",
+                "options": []
+              }
+            ],
+            "downloads": [
+              {
+                "output": "pdf",
+                "url": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/pdf/"
+              }
+            ]
+          }
+        ]
+      }
+
+   :query string search: Fuzzy search matching the attendee name, order code, invoice address name as well as to the beginning of the secret.
+   :query integer list: The check-in list to search on, can be passed multiple times.
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :query string ignore_status: If set to ``true``, results will be returned regardless of the state of
+                                 the order they belong to and you will need to do your own filtering by order status.
+   :query string ordering: Manually set the ordering of results. Valid fields to be used are ``order__code``,
+                           ``order__datetime``, ``positionid``, ``attendee_name``, ``last_checked_in`` and ``order__email``. Default:
+                           ``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 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.
+   :query integer variation__in: Only return positions with one of the purchased item variation matching the given
+                                 comma-separated IDs.
+   :query string attendee_name: Only return positions with the given value in the attendee_name field. Also, add-on
+                                products positions are shown if they refer to an attendee with the given name.
+   :query string secret: Only return positions with the given ticket secret.
+   :query string order__status: Only return positions with the given order status.
+   :query string order__status__in: Only return positions with one the given comma-separated order status.
+   :query boolean has_checkin: If set to ``true`` or ``false``, only return positions that have or have not been
+                               checked in already.
+   :query integer subevent: Only return positions of the sub-event with the given ID
+   :query integer subevent__in: Only return positions of one of the sub-events with the given comma-separated IDs
+   :query integer addon_to: Only return positions that are add-ons to the position with the given ID.
+   :query integer addon_to__in: Only return positions that are add-ons to one of the positions with the given
+                                      comma-separated IDs.
+   :query string voucher: Only return positions with a specific voucher.
+   :query string voucher__code: Only return positions with a specific voucher code.
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :statuscode 200: no error
+   :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.

doc/api/resources/checkinlists.rst

@@ -1,4 +1,6 @@
-.. spelling:: checkin
+.. spelling:word-list:: checkin
+
+.. _rest-checkinlists:
 
 Check-in lists
 ==============
@@ -34,44 +36,16 @@ allow_multiple_entries                boolean                    If ``true``, su
 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.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.10
+.. versionchanged:: 4.12
 
-   This resource has been added.
-
-.. versionchanged:: 1.11
-
-   The ``positions`` endpoints have been added.
-
-.. versionchanged:: 1.13
-
-   The ``include_pending`` field has been added.
-
-.. versionchanged:: 3.2
-
-    The ``auto_checkin_sales_channels`` field has been added.
-
-.. versionchanged:: 3.9
-
-    The ``subevent`` attribute may now be ``null`` inside event series. The ``allow_multiple_entries``,
-    ``allow_entry_after_exit``, and ``rules`` attributes have been added.
-
-.. versionchanged:: 3.11
-
-    The ``subevent_match`` and ``exclude`` query parameters have been added.
-
-.. versionchanged:: 3.12
-
-    The ``exit_all_at`` attribute has been added.
+    The ``addon_match`` attribute has been added.
 
 Endpoints
 ---------
 
-.. versionchanged:: 1.15
-
-   The ``../status/`` detail endpoint has been added.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/checkinlists/
 
    Returns a list of all check-in lists within a given event.
@@ -110,6 +84,7 @@ Endpoints
             "allow_entry_after_exit": true,
             "exit_all_at": null,
             "rules": {},
+            "addon_match": false,
             "auto_checkin_sales_channels": [
               "pretixpos"
             ]
@@ -120,7 +95,11 @@ Endpoints
    :query integer page: The page number in case of a multi-page result set, default is 1
    :query integer subevent: Only return check-in lists of the sub-event with the given ID
    :query integer subevent_match: Only return check-in lists that are valid for the sub-event with the given ID (i.e. also lists valid for all subevents)
+   :query string ends_after: Exclude all check-in lists attached to a sub-event that is already in the past at the given time.
+   :query string expand: Expand a field into a full object. Currently only ``subevent`` is supported. Can be passed multiple times.
    :query string exclude: Exclude a field from the output, e.g. ``checkin_count``. Can be used as a performance optimization. Can be passed multiple times.
+   :query string ordering: Manually set the ordering of results. Valid fields to be used are ``id``, ``name``, and ``subevent__date_from``,
+                           Default: ``subevent__date_from,name``
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
    :statuscode 200: no error
@@ -160,6 +139,7 @@ Endpoints
         "allow_entry_after_exit": true,
         "exit_all_at": null,
         "rules": {},
+        "addon_match": false,
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -259,6 +239,7 @@ Endpoints
         "subevent": null,
         "allow_multiple_entries": false,
         "allow_entry_after_exit": true,
+        "addon_match": false,
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -283,6 +264,7 @@ Endpoints
         "subevent": null,
         "allow_multiple_entries": false,
         "allow_entry_after_exit": true,
+        "addon_match": false,
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -337,6 +319,7 @@ Endpoints
         "subevent": null,
         "allow_multiple_entries": false,
         "allow_entry_after_exit": true,
+        "addon_match": false,
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -376,33 +359,46 @@ Endpoints
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to delete this resource.
 
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/checkinlists/(list)/failed_checkins/
+
+   Stores a failed check-in. Only necessary for statistical purposes if you perform scan validation offline.
+
+   :<json boolean error_reason: One of ``canceled``, ``invalid``, ``unpaid``, ``product``, ``rules``, ``revoked``,
+                                ``incomplete``, ``already_redeemed``, ``blocked``, ``invalid_time``, or ``error``. Required.
+   :<json raw_barcode: The raw barcode you scanned. Required.
+   :<json datetime: Date and time of the scan. Optional.
+   :<json type: Type of scan, defaults to ``"entry"``.
+   :<json position: Internal ID of an order position you matched. Optional.
+   :<json raw_item: Internal ID of an item you matched. Optional.
+   :<json raw_variation: Internal ID of an item variation you matched. Optional.
+   :<json raw_subevent: Internal ID of an event series date you matched. Optional.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/checkinlists/1/failed_checkins/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+      {
+        "raw_barcode": "Pvrk50vUzQd0DhdpNRL4I4OcXsvg70uA",
+        "error_reason": "canceled"
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param list: The ID of the check-in list to save for
+   :statuscode 201: no error
+   :statuscode 400: Invalid request
+   :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 order position or check-in list does not exist.
+
 
 Order position endpoints
 ------------------------
 
-.. versionchanged:: 1.15
-
-   The order positions endpoint has been extended by the filter queries ``item__in``, ``variation__in``,
-   ``order__status__in``, ``subevent__in``, ``addon_to__in``, and ``search``. The search for attendee names and order
-   codes is now case-insensitive.
-
-   The ``.../redeem/`` endpoint has been added.
-
-.. versionchanged:: 2.0
-
-   The order positions endpoint has been extended by the filter queries ``voucher`` and ``voucher__code``.
-
-.. versionchanged:: 2.7
-
-   The resource now contains the new attributes ``require_attention`` and ``order__status`` and accepts the new
-   ``ignore_status`` filter. The ``attendee_name`` field is now "smart" (see below) and the redemption endpoint
-   returns ``400`` instead of ``404`` on tickets which are known but not paid.
-
-.. versionchanged:: 3.2
-
-    The ``checkins`` dict now also contains a ``auto_checked_in`` value to indicate if the check-in has been performed
-    automatically by the system.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/checkinlists/(list)/positions/
 
    Returns a list of all order positions within a given event. The result is the same as
@@ -416,6 +412,9 @@ Order position endpoints
    * If ``attendee_name`` is empty, it will automatically fall back to values from a parent product or from invoice
      addresses.
 
+   You can use this endpoint to implement a ticket search. We also provide a dedicated search input as part of our
+   :ref:`check-in API <rest-checkin>` that supports search across multiple events.
+
    **Example request**:
 
    .. sourcecode:: http
@@ -461,6 +460,9 @@ Order position endpoints
             "checkins": [
               {
                 "list": 1,
+                "type": "entry",
+                "gate": null,
+                "device": 2,
                 "datetime": "2017-12-25T12:45:23Z",
                 "auto_checked_in": true
               }
@@ -490,6 +492,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 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.
@@ -530,8 +533,6 @@ Order position endpoints
    * If ``attendee_name`` is empty, it will automatically fall back to values from a parent product or from invoice
      addresses.
 
-   **Instead of an ID, you can also use the ``secret`` field as the lookup parameter.**
-
    **Example request**:
 
    .. sourcecode:: http
@@ -573,6 +574,9 @@ Order position endpoints
           {
             "list": 1,
             "datetime": "2017-12-25T12:45:23Z",
+            "type": "entry",
+            "gate": null,
+            "device": 2,
             "auto_checked_in": true
           }
         ],
@@ -605,8 +609,18 @@ Order position endpoints
    Tries to redeem an order position, identified by its internal ID, i.e. checks the attendee in. This endpoint
    accepts a number of optional requests in the body.
 
-   **Instead of an ID, you can also use the ``secret`` field as the lookup parameter.**
+   **Tip:** Instead of an ID, you can also use the ``secret`` field as the lookup parameter. In this case, you should
+   always set ``untrusted_input=true`` as a query parameter to avoid security issues.
 
+   .. note::
+
+      We no longer recommend using this API if you're building a ticket scanning application, as it has a few design
+      flaws that can lead to `security issues`_ or compatibility issues due to barcode content characters that are not
+      URL-safe. We recommend to use our new :ref:`check-in API <rest-checkin>` instead.
+
+   :query boolean untrusted_input: If set to true, the lookup parameter is **always** interpreted as a ``secret``, never
+                                   as an ``id``. This should be always set if you are passing through untrusted, scanned
+                                   data to avoid guessing of ticket IDs.
    :<json boolean questions_supported: When this parameter is set to ``true``, handling of questions is supported. If
                                        you do not implement question handling in your user interface, you **must**
                                        set this to ``false``. In that case, questions will just be ignored. Defaults
@@ -614,8 +628,9 @@ Order position endpoints
    :<json boolean canceled_supported: When this parameter is set to ``true``, the response code ``canceled`` may be
                                       returned. Otherwise, canceled orders will return ``unpaid``.
    :<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 previous check-ins or required
-                         questions that have not been filled. Defaults to ``false``.
+   :<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,
+                         because there's no point in validating them since they happened whether they are valid or not. Defaults to ``false``.
    :<json string type: Send ``"exit"`` for an exit and ``"entry"`` (default) for an entry.
    :<json boolean ignore_unpaid: Specifies that the check-in should succeed even if the order is in pending state.
                                  Defaults to ``false`` and only works when ``include_pending`` is set on the check-in
@@ -726,12 +741,20 @@ Order position endpoints
 
    Possible error reasons:
 
-   * ``unpaid`` - Ticket is not paid for
-   * ``canceled`` – Ticket is canceled or expired. This reason is only sent when your request sets
+   * ``invalid`` - Ticket code not known.
+   * ``unpaid`` - Ticket is not paid for.
+   * ``blocked`` - Ticket has been blocked.
+   * ``invalid_time`` - Ticket is not valid at this time.
+   * ``canceled`` – Ticket is canceled or expired. This reason is only sent when your request sets.
      ``canceled_supported`` to ``true``, otherwise these orders return ``unpaid``.
-   * ``already_redeemed`` - Ticket already has been redeemed
-   * ``product`` - Tickets with this product may not be scanned at this device
-   * ``rules`` - Check-in prevented by a user-defined rule
+   * ``already_redeemed`` - Ticket already has been redeemed.
+   * ``product`` - Tickets with this product may not be scanned at this device.
+   * ``rules`` - Check-in prevented by a user-defined rule.
+   * ``ambiguous`` - Multiple tickets match scan, rejected.
+   * ``revoked`` - Ticket code has been revoked.
+
+   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``.
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
@@ -742,3 +765,6 @@ Order position endpoints
    :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 order position or check-in list does not exist.
+
+
+.. _security issues: https://pretix.eu/about/de/blog/20220705-release-4111/

doc/api/resources/customers.rst

@@ -0,0 +1,260 @@
+.. _`rest-customers`:
+
+Customers
+=========
+
+Resource description
+--------------------
+
+The customer resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+identifier                            string                     Internal ID of the customer
+external_identifier                   string                     External ID of the customer (or ``null``). This field can
+                                                                 be changed for customers created manually or through
+                                                                 the API, but is read-only for customers created through a
+                                                                 SSO integration.
+email                                 string                     Customer email address
+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
+is_verified                           boolean                    Whether the email address of this account has been
+                                                                 verified
+last_login                            datetime                   Date and time of last login
+date_joined                           datetime                   Date and time of registration
+locale                                string                     Preferred language of the customer
+last_modified                         datetime                   Date and time of modification of the record
+notes                                 string                     Internal notes and comments (or ``null``)
+password                              string                     Can only be set during creation of a new customer, will
+                                                                 not be included in any responses.
+===================================== ========================== =======================================================
+
+.. versionadded:: 4.0
+
+.. versionchanged:: 4.3
+
+   Passwords can now be set through the API during customer creation.
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/customers/
+
+   Returns a list of all customers registered with a given organizer.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/customers/ 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": "8WSAJCJ",
+            "external_identifier": null,
+            "email": "customer@example.org",
+            "name": "John Doe",
+            "name_parts": {
+                "_scheme": "full",
+                "full_name": "John Doe"
+            },
+            "is_active": true,
+            "is_verified": false,
+            "last_login": null,
+            "date_joined": "2021-04-06T13:44:22.809216Z",
+            "locale": "de",
+            "last_modified": "2021-04-06T13:44:22.809377Z",
+            "notes": null
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :query string email: Only fetch customers with this email address
+   :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)/customers/(identifier)/
+
+   Returns information on one customer, identified by its identifier.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/customers/8WSAJCJ/ 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": "8WSAJCJ",
+        "external_identifier": null,
+        "email": "customer@example.org",
+        "name": "John Doe",
+        "name_parts": {
+            "_scheme": "full",
+            "full_name": "John Doe"
+        },
+        "is_active": true,
+        "is_verified": false,
+        "last_login": null,
+        "date_joined": "2021-04-06T13:44:22.809216Z",
+        "locale": "de",
+        "last_modified": "2021-04-06T13:44:22.809377Z",
+        "notes": null
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param identifier: The ``identifier`` field of the customer 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)/customers/
+
+   Creates a new customer. In addition to the fields defined on the resource, you can pass the field ``send_email``
+   to control whether the system should send an account activation email with a password reset link (defaults to
+   ``false``).
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/customers/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "email": "test@example.org",
+        "password": "verysecret",
+        "send_email": true
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "identifier": "8WSAJCJ",
+        "external_identifier": null,
+        "email": "test@example.org",
+        ...
+      }
+
+   :param organizer: The ``slug`` field of the organizer to create a customer for
+   :statuscode 201: no error
+   :statuscode 400: The customer 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)/customers/(identifier)/
+
+   Update a customer. 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``, ``last_login``, ``date_joined``,
+   ``name`` (which is auto-generated from ``name_parts``), and ``last_modified`` fields.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/customers/8WSAJCJ/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 94
+
+      {
+        "email": "test@example.org"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "identifier": "8WSAJCJ",
+        "external_identifier": null,
+        "email": "test@example.org",
+        …
+      }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param identifier: The ``identifier`` field of the customer to modify
+   :statuscode 200: no error
+   :statuscode 400: The customer 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:post:: /api/v1/organizers/(organizer)/customers/(identifier)/anonymize/
+
+   Anonymize a customer. Deletes personal data and disconnects from existing orders.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/customers/8WSAJCJ/anonymize/ 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": "8WSAJCJ",
+        "external_identifier": null,
+        "email": null,
+        …
+      }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param identifier: The ``identifier`` field of the customer to modify
+   :statuscode 200: no error
+   :statuscode 400: The customer 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.

doc/api/resources/devices.rst

@@ -1,4 +1,4 @@
-.. spelling:: fullname
+.. spelling:word-list:: fullname
 
 .. _`rest-devices`:
 
@@ -24,6 +24,8 @@ all_events                            boolean                    Whether this de
 limit_events                          list                       List of event slugs this device has access to
 hardware_brand                        string                     Device hardware manufacturer (read-only)
 hardware_model                        string                     Device hardware model (read-only)
+os_name                               string                     Device operating system name (read-only)
+os_version                            string                     Device operating system version (read-only)
 software_brand                        string                     Device software product (read-only)
 software_version                      string                     Device software version (read-only)
 created                               datetime                   Creation time
@@ -76,6 +78,8 @@ Device endpoints
             "security_profile": "full",
             "hardware_brand": "Zebra",
             "hardware_model": "TC25",
+            "os_name": "Android",
+            "os_version": "8.1.0",
             "software_brand": "pretixSCAN",
             "software_version": "1.5.1"
           }
@@ -123,6 +127,8 @@ Device endpoints
         "security_profile": "full",
         "hardware_brand": "Zebra",
         "hardware_model": "TC25",
+        "os_name": "Android",
+        "os_version": "8.1.0",
         "software_brand": "pretixSCAN",
         "software_version": "1.5.1"
       }
@@ -173,6 +179,8 @@ Device endpoints
         "initialized": null
         "hardware_brand": null,
         "hardware_model": null,
+        "os_name": null,
+        "os_version": null,
         "software_brand": null,
         "software_version": null
       }

doc/api/resources/discounts.rst

@@ -0,0 +1,306 @@
+.. _`rest-discounts`:
+
+Discounts
+=========
+
+Resource description
+--------------------
+
+Discounts provide a way to automatically reduce the price of a cart if it matches a given set of conditions.
+Discounts are available to everyone. If you want to give a discount just to specific persons, look at
+:ref:`vouchers <rest-vouchers>` instead. If you are interested in the behind-the-scenes details of how
+discounts are calculated for a specific order, have a look at :ref:`our algorithm documentation <algorithms-pricing>`.
+
+.. rst-class:: rest-resource-table
+
+======================================== ========================== =======================================================
+Field                                    Type                       Description
+======================================== ========================== =======================================================
+id                                       integer                    Internal ID of the discount rule
+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"]``.
+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
+                                                                    (or ``null``).
+subevent_mode                            strings                    Determines how the discount is handled when used in an
+                                                                    event series. Can be ``"mixed"`` (no special effect),
+                                                                    ``"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.
+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.
+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.
+condition_ignore_voucher_discounted      boolean                    If ``true``, the discount does not apply to products which have
+                                                                    been discounted by a voucher.
+condition_min_count                      integer                    The minimum number of matching products for the discount
+                                                                    to be activated.
+condition_min_value                      money (string)             The minimum value of matching products for the discount
+                                                                    to be activated. Cannot be combined with ``condition_min_count``,
+                                                                    or with ``subevent_mode`` set to ``distinct``.
+benefit_discount_matching_percent        decimal (string)           The percentage of price reduction for matching products.
+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``.
+======================================== ========================== =======================================================
+
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/discounts/
+
+   Returns a list of all discounts within a given event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/discounts/ 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,
+            "active": true,
+            "internal_name": "3 for 2",
+            "position": 1,
+            "sales_channels": ["web"],
+            "available_from": null,
+            "available_until": null,
+            "subevent_mode": "mixed",
+            "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_discount_matching_percent": "100.00",
+            "benefit_only_apply_to_cheapest_n_matches": 1
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :query boolean active: If set to ``true`` or ``false``, only discounts with this value for the field ``active`` will be
+                          returned.
+   :query string ordering: Manually set the ordering of results. Valid fields to be used are ``id`` and ``position``.
+                           Default: ``position``
+   :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)/discounts/(id)/
+
+   Returns information on one discount, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/discounts/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,
+        "active": true,
+        "internal_name": "3 for 2",
+        "position": 1,
+        "sales_channels": ["web"],
+        "available_from": null,
+        "available_until": null,
+        "subevent_mode": "mixed",
+        "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_discount_matching_percent": "100.00",
+        "benefit_only_apply_to_cheapest_n_matches": 1
+      }
+
+   :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 discount 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)/discounts/
+
+   Creates a new discount
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/discounts/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "active": true,
+        "internal_name": "3 for 2",
+        "position": 1,
+        "sales_channels": ["web"],
+        "available_from": null,
+        "available_until": null,
+        "subevent_mode": "mixed",
+        "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_discount_matching_percent": "100.00",
+        "benefit_only_apply_to_cheapest_n_matches": 1
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "active": true,
+        "internal_name": "3 for 2",
+        "position": 1,
+        "sales_channels": ["web"],
+        "available_from": null,
+        "available_until": null,
+        "subevent_mode": "mixed",
+        "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_discount_matching_percent": "100.00",
+        "benefit_only_apply_to_cheapest_n_matches": 1
+      }
+
+   :param organizer: The ``slug`` field of the organizer of the event to create a discount for
+   :param event: The ``slug`` field of the event to create a discount for
+   :statuscode 201: no error
+   :statuscode 400: The discount 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)/discounts/(id)/
+
+   Update a discount. 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/discounts/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 94
+
+      {
+        "active": false
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "active": false,
+        "internal_name": "3 for 2",
+        "position": 1,
+        "sales_channels": ["web"],
+        "available_from": null,
+        "available_until": null,
+        "subevent_mode": "mixed",
+        "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_discount_matching_percent": "100.00",
+        "benefit_only_apply_to_cheapest_n_matches": 1
+      }
+
+   :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 discount to modify
+   :statuscode 200: no error
+   :statuscode 400: The discount 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)/discount/(id)/
+
+   Delete a discount.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/discount/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 discount 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/events.rst

@@ -1,4 +1,4 @@
-.. spelling::
+.. spelling:word-list::
 
    geo
    lat
@@ -49,61 +49,31 @@ valid_keys                            object                     Cryptographic k
                                                                  only contained in detail views. Value can be cached.
 sales_channels                        list                       A list of sales channels this event is available for
                                                                  sale on.
+public_url                            string                     The public, customer-facing URL of the event (read-only).
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 1.7
-
-   The ``meta_data`` field has been added.
-
-.. versionchanged:: 1.15
-
-   The ``plugins`` field has been added.
-   The operations POST, PATCH, PUT and DELETE have been added.
-
-.. versionchanged:: 2.1
-
-   Filters have been added to the list of events.
-
-.. versionchanged:: 2.5
-
-   The ``testmode`` attribute has been added.
-
-.. versionchanged:: 2.8
-
-    When cloning events, the ``testmode`` attribute will now be cloned, too.
-
-.. versionchanged:: 3.0
-
-   The attributes ``seating_plan`` and ``seat_category_mapping`` have been added.
-
-.. versionchanged:: 3.3
-
-   The attributes ``geo_lat`` and ``geo_lon`` have been added.
-
-.. versionchanged:: 3.4
-
-   The attribute ``timezone`` has been added.
-
-.. versionchanged:: 3.7
-
-   The attribute ``item_meta_properties`` has been added.
-
-.. versionchanged:: 3.12
-
-   The attribute ``valid_keys`` has been added.
-
-.. versionchanged:: 3.14
-
-    The attribute ``sales_channels`` has been added.
-
-
 Endpoints
 ---------
 
-.. versionchanged:: 3.3
+.. versionchanged:: 4.0
 
-    The events resource can now be filtered by meta data attributes.
+    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/
 
@@ -163,7 +133,8 @@ Endpoints
               "web",
               "pretixpos",
               "resellers"
-            ]
+            ],
+            "public_url": "https://pretix.eu/bigevents/sampleconf/"
           }
         ]
       }
@@ -171,9 +142,14 @@ 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 events with a matching value of ``is_public`` are returned.
    :query live: If set to ``true``/``false``, only events with a matching value of ``live`` are returned.
+   :query testmode: If set to ``true``/``false``, only events with a matching value of ``testmode`` are returned.
    :query has_subevents: If set to ``true``/``false``, only events with a matching value of ``has_subevents`` are returned.
    :query is_future: If set to ``true`` (``false``), only events that happen currently or in the future are (not) returned. Event series are never (always) returned.
    :query is_past: If set to ``true`` (``false``), only events that are over are (not) returned. Event series are never (always) returned.
+   :query date_from_after: If set to a date and time, only events that start at or after the given time are returned.
+   :query date_from_before: If set to a date and time, only events that start at or before the given time are returned.
+   :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. Event series are never returned.
    :query string ordering: Manually set the ordering of results. Valid fields to be used are ``date_from`` and
                            ``slug``. Keep in mind that ``date_from`` of event series does not really tell you anything.
@@ -183,6 +159,11 @@ Endpoints
         events having set their ``Format`` meta data to ``Seminar``, ``?attr[Format]=`` only those, that have no value
         set. Please note that this filter will respect default values set on organizer level.
    :query sales_channel: If set to a sales channel identifier, only events allowed to be sold on the specified sales channel are returned.
+   :query with_availability_for: If set to a sales channel identifier, the response will contain a special ``best_availability_state``
+                                 attribute with values of 100 for "tickets available", values less than 100 for "tickets sold out or reserved",
+                                 and ``null`` for "status unknown". These values might be served from a cache. This parameter can make the response
+                                 slow.
+   :query search: Only return events matching a given search query.
    :param organizer: The ``slug`` field of a valid organizer
    :statuscode 200: no error
    :statuscode 401: Authentication failure
@@ -246,7 +227,8 @@ Endpoints
           "web",
           "pretixpos",
           "resellers"
-        ]
+        ],
+        "public_url": "https://pretix.eu/bigevents/sampleconf/"
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -342,10 +324,14 @@ Endpoints
           "web",
           "pretixpos",
           "resellers"
-        ]
+        ],
+        "public_url": "https://pretix.eu/bigevents/sampleconf/"
       }
 
    :param organizer: The ``slug`` field of the organizer of the event to create.
+   :query clone_from: Set to ``event_slug`` to clone data (settings, products, …) from an event with this slug in the
+                      same organizer or to ``organizer_slug/event_slug`` to clone from an event within a different
+                      organizer.
    :statuscode 201: no error
    :statuscode 400: The event could not be created due to invalid submitted data.
    :statuscode 401: Authentication failure
@@ -360,7 +346,8 @@ Endpoints
    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.
 
-   Please note that you can only copy from events under the same organizer.
+   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.
 
    Permission required: "Can create events"
 
@@ -442,7 +429,8 @@ Endpoints
           "web",
           "pretixpos",
           "resellers"
-        ]
+        ],
+        "public_url": "https://pretix.eu/bigevents/sampleconf/"
       }
 
    :param organizer: The ``slug`` field of the organizer of the event to create.
@@ -516,7 +504,8 @@ Endpoints
           "web",
           "pretixpos",
           "resellers"
-        ]
+        ],
+        "public_url": "https://pretix.eu/bigevents/sampleconf/"
       }
 
    :param organizer: The ``slug`` field of the organizer of the event to update
@@ -567,16 +556,15 @@ Therefore, we're also not including a list of the options here, but instead reco
 to see available options. The ``explain=true`` flag enables a verbose mode that provides you with human-readable
 information about the properties.
 
+Note that some settings are read-only, e.g. because they can be read on event level but currently only be changed on
+organizer level.
+
 .. note:: Please note that this is not a complete representation of all event settings. You will find more settings
           in the web interface.
 
 .. 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.
 
-.. versionchanged:: 3.6
-
-   Initial support for settings has been added to the API.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/settings/
 
    Get current values of event settings.
@@ -617,6 +605,7 @@ information about the properties.
           {
             "value": "https://pretix.eu",
             "label": "Imprint URL",
+            "readonly": false,
             "help_text": "This should point e.g. to a part of your website that has your contact details and legal information."
           }
         },
@@ -630,6 +619,10 @@ information about the properties.
    :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/exporters.rst

@@ -1,4 +1,4 @@
-.. spelling:: checkin
+.. spelling:word-list:: checkin
 
 Data exporters
 ==============
@@ -6,10 +6,6 @@ Data exporters
 pretix and it's plugins include a number of data exporters that allow you to bulk download various data from pretix in
 different formats. This page shows you how to use these exporters through the API.
 
-.. versionchanged:: 3.13
-
-   This feature has been added to the API.
-
 .. warning::
 
    While we consider the methods listed on this page to be a stable API, the availability and specific input field
@@ -115,7 +111,7 @@ Listing available exporters
             "input_parameters": [
               {
                 "name": "events",
-                "required": true
+                "required": false
               },
               {
                 "name": "_format",
@@ -182,7 +178,7 @@ endpoints:
       Content-Type: application/json
 
       {
-        "download": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderlist/download/29891ede-196f-4942-9e26-d055a36e98b8/3f279f13-c198-4137-b49b-9b360ce9fcce/"
+        "download": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/exporters/orderlist/download/29891ede-196f-4942-9e26-d055a36e98b8/3f279f13-c198-4137-b49b-9b360ce9fcce/"
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch

doc/api/resources/giftcards.rst

@@ -20,6 +20,12 @@ currency                              string                     Currency of the
 testmode                              boolean                    Whether this is a test gift card
 expires                               datetime                   Expiry date (or ``null``)
 conditions                            string                     Special terms and conditions for this card (or ``null``)
+owner_ticket                          integer                    Internal ID of an order position that is the "owner" of
+                                                                 this gift card and can view all transactions. When setting
+                                                                 this field, you can also give the ``secret`` of an order
+                                                                 position.
+issuer                                string                     Organizer slug of the organizer who created this gift
+                                                                 card and is responsible for it.
 ===================================== ========================== =======================================================
 
 The gift card transaction resource contains the following public fields:
@@ -35,15 +41,20 @@ value                                 money (string)             Transaction amo
 event                                 string                     Event slug, if the gift card was used in the web shop (or ``null``)
 order                                 string                     Order code, if the gift card was used in the web shop (or ``null``)
 text                                  string                     Custom text of the transaction (or ``null``)
+info                                  object                     Additional data about the transaction (or ``null``)
+acceptor                              string                     Organizer slug of the organizer who created this transaction
+                                                                 (can be ``null`` for all transactions performed before
+                                                                 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
 ---------
 
-.. versionadded:: 3.14
-
-   The transaction list endpoint was added.
-
 .. http:get:: /api/v1/organizers/(organizer)/giftcards/
 
    Returns a list of all gift cards issued by a given organizer.
@@ -76,6 +87,8 @@ Endpoints
             "testmode": false,
             "expires": null,
             "conditions": null,
+            "owner_ticket": null,
+            "issuer": "bigevents",
             "value": "13.37"
           }
         ]
@@ -85,6 +98,10 @@ Endpoints
    :query string secret: Only show gift cards with the given secret.
    :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.
+                         The nested objects are identical to the respective resources, except that the ``owner_ticket``
+                         will have an attribute of the format ``"order": {"code": "ABCDE", "event": "eventslug"}`` to make
+                         matching easier. The parameter can be given multiple times.
    :param organizer: The ``slug`` field of the organizer to fetch
    :statuscode 200: no error
    :statuscode 401: Authentication failure
@@ -117,6 +134,8 @@ Endpoints
         "testmode": false,
         "expires": null,
         "conditions": null,
+        "owner_ticket": null,
+        "issuer": "bigevents",
         "value": "13.37"
       }
 
@@ -161,10 +180,16 @@ Endpoints
         "currency": "EUR",
         "expires": null,
         "conditions": null,
+        "owner_ticket": null,
+        "issuer": "bigevents",
         "value": "13.37"
       }
 
    :param organizer: The ``slug`` field of the organizer to create a gift card for
+   :query string expand: If you pass ``"owner_ticket"``, the respective field will be shown as a nested value instead of just an ID.
+                         The nested objects are identical to the respective resources, except that the ``owner_ticket``
+                         will have an attribute of the format ``"order": {"code": "ABCDE", "event": "eventslug"}`` to make
+                         matching easier. The parameter can be given multiple times.
    :statuscode 201: no error
    :statuscode 400: The gift card could not be created due to invalid submitted data.
    :statuscode 401: Authentication failure
@@ -209,6 +234,8 @@ Endpoints
         "currency": "EUR",
         "expires": null,
         "conditions": null,
+        "owner_ticket": null,
+        "issuer": "bigevents",
         "value": "14.00"
       }
 
@@ -254,13 +281,11 @@ Endpoints
         "testmode": false,
         "expires": null,
         "conditions": null,
+        "owner_ticket": null,
+        "issuer": "bigevents",
         "value": "15.37"
       }
 
-   .. versionchanged:: 3.5
-
-      This endpoint now returns status code ``409`` if the transaction would lead to a negative gift card value.
-
    :param organizer: The ``slug`` field of the organizer to modify
    :param id: The ``id`` field of the gift card to modify
    :query boolean include_accepted: Also show gift cards issued by other organizers that are accepted by this organizer.
@@ -301,7 +326,11 @@ Endpoints
             "value": "50.00",
             "event": "democon",
             "order": "FXQYW",
-            "text": null
+            "text": null,
+            "acceptor": "bigevents",
+            "info": {
+              "created_by": "plugin1"
+            }
           }
         ]
       }

doc/api/resources/index.rst

@@ -1,6 +1,11 @@
 Resources and endpoints
 =======================
 
+With a few exceptions, this only lists resources bundled in the pretix core modules.
+Additional endpoints are provided by pretix plugins. Some of them are documented
+at :ref:`plugin-docs`.
+
+
 .. toctree::
    :maxdepth: 2
 
@@ -13,20 +18,29 @@ Resources and endpoints
    item_variations
    item_bundles
    item_add-ons
+   item_meta_properties
    questions
    question_options
    quotas
    orders
    invoices
    vouchers
+   discounts
+   checkin
    checkinlists
    waitinglist
+   customers
+   membershiptypes
+   memberships
    giftcards
+   reusablemedia
    carts
    teams
    devices
    webhooks
    seatingplans
    exporters
+   shredders
+   sendmail_rules
    billing_invoices
-   billing_var
+   billing_var

doc/api/resources/invoices.rst

@@ -15,8 +15,24 @@ number                                string                     Invoice number
 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.
-invoice_from                          string                     Sender address
-invoice_to                            string                     Receiver address
+invoice_from_name                     string                     Sender address: Name
+invoice_from                          string                     Sender address: Address lines
+invoice_from_zipcode                  string                     Sender address: ZIP code
+invoice_from_city                     string                     Sender address: City
+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_company                    string                     Recipient address: Company name
+invoice_to_name                       string                     Recipient address: Person name
+invoice_to_street                     string                     Recipient address: Address lines
+invoice_to_zipcode                    string                     Recipient address: ZIP code
+invoice_to_city                       string                     Recipient address: City
+invoice_to_state                      string                     Recipient address: State (only used in some countries)
+invoice_to_country                    string                     Recipient address: Country code
+invoice_to_vat_id                     string                     Recipient address: EU VAT ID
+invoice_to_beneficiary                string                     Invoice beneficiary
+custom_field                          string                     Custom invoice address field
 date                                  date                       Invoice date
 refers                                string                     Invoice number of an invoice this invoice refers to
                                                                  (for example a cancellation refers to the invoice it
@@ -26,10 +42,57 @@ introductory_text                     string                     Text to be prin
 additional_text                       string                     Text to be printed below the product list
 payment_provider_text                 string                     Text to be printed below the product list with
                                                                  payment information
+payment_provider_stamp                string                     Short text to be visibly printed to indicate payment status
 footer_text                           string                     Text to be printed in the page footer area
 lines                                 list of objects            The actual invoice contents
 ├ position                            integer                    Number of the line within an invoice.
 ├ description                         string                     Text representing the invoice line (e.g. product name)
+├ item                                integer                    Product used to create this line. Note that everything
+                                                                 about the product might have changed since the creation
+                                                                 of the invoice. Can be ``null`` for all invoice lines
+                                                                 created before this field was introduced as well as for
+                                                                 all lines not created by a product (e.g. a shipping or
+                                                                 cancellation fee).
+├ variation                           integer                    Product variation used to create this line. Note that everything
+                                                                 about the product might have changed since the creation
+                                                                 of the invoice. Can be ``null`` for all invoice lines
+                                                                 created before this field was introduced as well as for
+                                                                 all lines not created by a product (e.g. a shipping or
+                                                                 cancellation fee).
+├ subevent                            integer                    Event series date ID used to create this line. Note that everything
+                                                                 about the subevent might have changed since the creation
+                                                                 of the invoice. Can be ``null`` for all invoice lines
+                                                                 created before this field was introduced as well as for
+                                                                 all lines not created by a product (e.g. a shipping or
+                                                                 cancellation fee) as well as for all events that are not a series.
+├ fee_type                            string                     Fee type, e.g. ``shipping``, ``service``, ``payment``,
+                                                                 ``cancellation``, ``giftcard``, or ``other. Can be ``null`` 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).
+├ fee_internal_type                   string                     Additional fee type, e.g. type of payment provider. Can be ``null``
+                                                                 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.
+├ 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
+                                                                 an event series not created by a product (e.g. shipping or
+                                                                 cancellation fees) as well as whenever the respective (sub)event
+                                                                 has no location set.
+├ attendee_name                       string                     Attendee name at time of invoice creation. Can be ``null`` if no
+                                                                 name was set or if names are configured to not be added to invoices.
 ├ 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")
@@ -46,27 +109,17 @@ internal_reference                    string                     Customer's refe
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 1.6
+.. versionchanged:: 4.1
 
-   The attribute ``invoice_no`` has been dropped in favor of ``number`` which includes the number including the prefix,
-   since the prefix can now vary. Also, invoices now need to be identified by their ``number`` instead of the raw
-   number.
+   The attributes ``fee_type`` and ``fee_internal_type`` have been added.
 
+.. versionchanged:: 4.1
 
-.. versionchanged:: 1.7
+   The attribute ``lines.event_location`` has been added.
 
-   The attributes ``lines.tax_name``, ``foreign_currency_display``, ``foreign_currency_rate``, and
-   ``foreign_currency_rate_date`` have been added.
+.. versionchanged:: 4.6
 
-
-.. versionchanged:: 1.9
-
-   The attribute ``internal_reference`` has been added.
-
-
-.. versionchanged:: 3.4
-
-   The attribute ``lines.number`` has been added.
+   The attribute ``lines.subevent`` has been added.
 
 
 Endpoints
@@ -101,8 +154,24 @@ Endpoints
             "number": "SAMPLECONF-00001",
             "order": "ABC12",
             "is_cancellation": false,
-            "invoice_from": "Big Events LLC\nDemo street 12\nDemo town",
-            "invoice_to": "Sample company\nJohn Doe\nTest street 12\n12345 Testington\nTestikistan\nVAT ID: EU123456789",
+            "invoice_from_name": "Big Events LLC",
+            "invoice_from": "Demo street 12",
+            "invoice_from_zipcode":"",
+            "invoice_from_city":"Demo town",
+            "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_name": "John Doe",
+            "invoice_to_street": "Test street 12",
+            "invoice_to_zipcode": "12345",
+            "invoice_to_city": "Testington",
+            "invoice_to_state": null,
+            "invoice_to_country": "TE",
+            "invoice_to_vat_id": "EU123456789",
+            "invoice_to_beneficiary": "",
+            "custom_field": null,
             "date": "2017-12-01",
             "refers": null,
             "locale": "en",
@@ -110,11 +179,21 @@ Endpoints
             "internal_reference": "",
             "additional_text": "We are looking forward to see you on our conference!",
             "payment_provider_text": "Please transfer the money to our account ABC…",
+            "payment_provider_stamp": null,
             "footer_text": "Big Events LLC - Registration No. 123456 - VAT ID: EU0987654321",
             "lines": [
               {
                 "position": 1,
                 "description": "Budget Ticket",
+                "item": 1234,
+                "variation": 245,
+                "subevent": null,
+                "fee_type": null,
+                "fee_internal_type": null,
+                "event_date_from": "2017-12-27T10:00:00Z",
+                "event_date_to": null,
+                "event_location": "Heidelberg",
+                "attendee_name": null,
                 "gross_value": "23.00",
                 "tax_value": "0.00",
                 "tax_name": "VAT",
@@ -166,8 +245,24 @@ Endpoints
         "number": "SAMPLECONF-00001",
         "order": "ABC12",
         "is_cancellation": false,
-        "invoice_from": "Big Events LLC\nDemo street 12\nDemo town",
-        "invoice_to": "Sample company\nJohn Doe\nTest street 12\n12345 Testington\nTestikistan\nVAT ID: EU123456789",
+        "invoice_from_name": "Big Events LLC",
+        "invoice_from": "Demo street 12",
+        "invoice_from_zipcode":"",
+        "invoice_from_city":"Demo town",
+        "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_name": "John Doe",
+        "invoice_to_street": "Test street 12",
+        "invoice_to_zipcode": "12345",
+        "invoice_to_city": "Testington",
+        "invoice_to_state": null,
+        "invoice_to_country": "TE",
+        "invoice_to_vat_id": "EU123456789",
+        "invoice_to_beneficiary": "",
+        "custom_field": null,
         "date": "2017-12-01",
         "refers": null,
         "locale": "en",
@@ -175,11 +270,21 @@ Endpoints
         "internal_reference": "",
         "additional_text": "We are looking forward to see you on our conference!",
         "payment_provider_text": "Please transfer the money to our account ABC…",
+        "payment_provider_stamp": null,
         "footer_text": "Big Events LLC - Registration No. 123456 - VAT ID: EU0987654321",
         "lines": [
           {
             "position": 1,
             "description": "Budget Ticket",
+            "item": 1234,
+            "variation": 245,
+            "subevent": null,
+            "fee_type": null,
+            "fee_internal_type": null,
+            "event_date_from": "2017-12-27T10:00:00Z",
+            "event_date_to": null,
+            "event_location": "Heidelberg",
+            "attendee_name": null,
             "gross_value": "23.00",
             "tax_value": "0.00",
             "tax_name": "VAT",

doc/api/resources/item_add-ons.rst

@@ -28,10 +28,6 @@ multi_allowed                         boolean                    Adding the same
 price_included                        boolean                    Adding this add-on to the item is free
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.12
-
-   This resource has been added.
-
 Endpoints
 ---------
 

doc/api/resources/item_bundles.rst

@@ -30,10 +30,6 @@ designated_price                      money (string)             Designated pric
                                                                  taxation. This is not added to the price.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 2.6
-
-   This resource has been added.
-
 Endpoints
 ---------
 

doc/api/resources/item_meta_properties.rst

@@ -0,0 +1,211 @@
+Item Meta Properties
+====================
+
+Resource description
+--------------------
+
+An Item Meta Property is used to include (event internally relevant) meta information with every item (product). This
+could be internal categories like booking positions.
+
+The Item Meta Properties resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Unique ID for this property
+name                                  string                     Name of the property
+default                               string                     Value of the default option
+required                              boolean                    If ``true``, this property will have to be assigned a
+                                                                 value in all items of the related event
+allowed_values                        list                       List of all permitted values for this property,
+                                                                 or ``null`` for no limitation
+===================================== ========================== =======================================================
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/item_meta_properties/
+
+   Returns a list of all Item Meta Properties within a given event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/item_meta_properties/ 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,
+            "name": "Color",
+            "default": "red",
+            "required": true,
+            "allowed_values": ["red", "green", "blue"]
+          }
+        ]
+      }
+
+   :param organizer: The ``slug`` field of the organizer
+   :param event: The ``slug`` field of the event
+   :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)/events/(event)/item_meta_properties/(id)/
+
+   Returns information on one property, identified by its id.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/item_meta_properties/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      {
+        "id": 1,
+        "name": "Color",
+        "default": "red",
+        "required": true,
+        "allowed_values": ["red", "green", "blue"]
+      }
+
+   :param organizer: The ``slug`` field of the organizer
+   :param event: The ``slug`` field of the event
+   :param id: The ``id`` field of the item meta property to retrieve
+   :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)/events/(event)/item_meta_properties/
+
+   Creates a new item meta property
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/item_meta_properties/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "name": "ref-code",
+        "default": "abcde",
+        "required": true,
+        "allowed_values": null
+      }
+
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+    {
+        "id": 2,
+        "name": "ref-code",
+        "default": "abcde",
+        "required": true,
+        "allowed_values": null
+    }
+
+   :param organizer: The ``slug`` field of the organizer
+   :param event: The ``slug`` field of the event
+   :statuscode 201: no error
+   :statuscode 400: The item meta property 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)/events/(event)/item_meta_properties/(id)/
+
+   Update an item meta property. 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/item_meta_properties/2/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 94
+
+      {
+        "required": false
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 2,
+        "name": "ref-code",
+        "default": "abcde",
+        "required": false,
+        "allowed_values": []
+      }
+
+   :param organizer: The ``slug`` field of the organizer
+   :param event: The ``slug`` field of the event
+   :param id: The ``id`` field of the item meta property to modify
+   :statuscode 200: no error
+   :statuscode 400: The property 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)/events/(event)/item_meta_properties/(id)/
+
+   Delete an item meta property.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/item_meta_properties/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
+   :param event: The ``slug`` field of the event
+   :param id: The ``id`` field of the item meta property 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.

doc/api/resources/item_variations.rst

@@ -24,15 +24,34 @@ active                                boolean                    If ``false``, t
 description                           multi-lingual string       A public description of the variation. May contain
                                                                  Markdown syntax or can be ``null``.
 position                              integer                    An integer, used for sorting
+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.
+require_approval                      boolean                    If ``true``, orders with this variation will need to be
+                                                                 approved by the event organizer before they can be
+                                                                 paid.
+require_membership                    boolean                    If ``true``, booking this variation requires an active membership.
+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.
+                                                                 The item-level list takes precedence, i.e. a sales
+                                                                 channel needs to be on both lists for the item to be
+                                                                 available.
+available_from                        datetime                   The first date time at which this variation can be bought
+                                                                 (or ``null``).
+available_until                       datetime                   The last date time at which this variation can be bought
+                                                                 (or ``null``).
+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:: 2.7
+.. versionchanged:: 4.16
 
-   The attribute ``original_price`` has been added.
-
-.. versionchanged:: 1.12
-
-   This resource has been added.
+   The ``meta_data`` and ``checkin_attention`` attributes have been added.
 
 Endpoints
 ---------
@@ -68,6 +87,15 @@ Endpoints
               "en": "S"
             },
             "active": true,
+            "checkin_attention": false,
+            "require_approval": false,
+            "require_membership": false,
+            "require_membership_hidden": false,
+            "require_membership_types": [],
+            "sales_channels": ["web"],
+            "available_from": null,
+            "available_until": null,
+            "hide_without_voucher": false,
             "description": {
               "en": "Test2"
             },
@@ -75,6 +103,7 @@ Endpoints
             "default_price": "223.00",
             "price": 223.0,
             "original_price": null,
+            "meta_data": {}
           },
           {
             "id": 3,
@@ -82,10 +111,16 @@ Endpoints
               "en": "L"
             },
             "active": true,
+            "checkin_attention": false,
+            "require_approval": false,
+            "require_membership": false,
+            "require_membership_hidden": false,
+            "require_membership_types": [],
             "description": {},
             "position": 1,
             "default_price": null,
-            "price": 15.0
+            "price": 15.0,
+            "meta_data": {}
           }
         ]
       }
@@ -129,8 +164,18 @@ Endpoints
         "price": "10.00",
         "original_price": null,
         "active": true,
+        "checkin_attention": false,
+        "require_approval": false,
+        "require_membership": false,
+        "require_membership_hidden": false,
+        "require_membership_types": [],
+        "sales_channels": ["web"],
+        "available_from": null,
+        "available_until": null,
+        "hide_without_voucher": false,
         "description": null,
-        "position": 0
+        "position": 0,
+        "meta_data": {}
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -158,8 +203,18 @@ Endpoints
         "value": {"en": "Student"},
         "default_price": "10.00",
         "active": true,
+        "checkin_attention": false,
+        "require_approval": false,
+        "require_membership": false,
+        "require_membership_hidden": false,
+        "require_membership_types": [],
+        "sales_channels": ["web"],
+        "available_from": null,
+        "available_until": null,
+        "hide_without_voucher": false,
         "description": null,
-        "position": 0
+        "position": 0,
+        "meta_data": {}
       }
 
    **Example response**:
@@ -177,8 +232,18 @@ Endpoints
         "price": "10.00",
         "original_price": null,
         "active": true,
+        "checkin_attention": false,
+        "require_approval": false,
+        "require_membership": false,
+        "require_membership_hidden": false,
+        "require_membership_types": [],
+        "sales_channels": ["web"],
+        "available_from": null,
+        "available_until": null,
+        "hide_without_voucher": false,
         "description": null,
-        "position": 0
+        "position": 0,
+        "meta_data": {}
       }
 
    :param organizer: The ``slug`` field of the organizer of the event/item to create a variation for
@@ -227,8 +292,18 @@ Endpoints
         "price": "10.00",
         "original_price": null,
         "active": false,
+        "checkin_attention": false,
+        "require_approval": false,
+        "require_membership": false,
+        "require_membership_hidden": false,
+        "require_membership_types": [],
+        "sales_channels": ["web"],
+        "available_from": null,
+        "available_until": null,
+        "hide_without_voucher": false,
         "description": null,
-        "position": 1
+        "position": 1,
+        "meta_data": {}
       }
 
    :param organizer: The ``slug`` field of the organizer to modify

doc/api/resources/items.rst

@@ -11,158 +11,190 @@ The item resource contains the following public fields:
 
 .. rst-class:: rest-resource-table
 
-===================================== ========================== =======================================================
-Field                                 Type                       Description
-===================================== ========================== =======================================================
-id                                    integer                    Internal ID of the item
-name                                  multi-lingual string       The item's visible name
-internal_name                         string                     An optional name that is only used in the backend
-default_price                         money (string)             The item price that is applied if the price is not
-                                                                 overwritten by variations or other options.
-category                              integer                    The ID of the category this item belongs to
-                                                                 (or ``null``).
-active                                boolean                    If ``false``, the item is hidden from all public lists
-                                                                 and will not be sold.
-description                           multi-lingual string       A public description of the item. May contain Markdown
-                                                                 syntax or can be ``null``.
-free_price                            boolean                    If ``true``, customers can change the price at which
-                                                                 they buy the product (however, the price can't be set
-                                                                 lower than the price defined by ``default_price`` or
-                                                                 otherwise).
-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``).
-admission                             boolean                    ``true`` for items that grant admission to the event
-                                                                 (such as primary tickets) and ``false`` for others
-                                                                 (such as add-ons or merchandise).
-position                              integer                    An integer, used for sorting
-picture                               string                     A product picture to be displayed in the shop
-                                                                 (read-only, can be ``null``).
-sales_channels                        list of strings            Sales channels this product is available on, such as
-                                                                 ``"web"`` or ``"resellers"``. Defaults to ``["web"]``.
-available_from                        datetime                   The first date time at which this item can be bought
-                                                                 (or ``null``).
-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
-                                                                 set, this item won't be shown publicly as long as this
-                                                                 quota is available.
-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
-                                                                 redemption process, but not in the normal shop
-                                                                 frontend.
-allow_cancel                          boolean                    If ``false``, customers cannot cancel orders containing
-                                                                 this item.
-min_per_order                         integer                    This product can only be bought if it is included at
-                                                                 least this many times in the order (or ``null`` for no
-                                                                 limitation).
-max_per_order                         integer                    This product can only be bought if it is included at
-                                                                 most this many times in the order (or ``null`` for no
-                                                                 limitation).
-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.
-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
-                                                                 approved by the event organizer before they can be
-                                                                 paid.
-require_bundling                      boolean                    If ``true``, this item is only available as part of bundles.
-generate_tickets                      boolean                    If ``false``, tickets are never generated for this
-                                                                 product, regardless of other settings. If ``true``,
-                                                                 tickets are generated even if this is a
-                                                                 non-admission or add-on product, regardless of event
-                                                                 settings. If this is ``null``, regular ticketing
-                                                                 rules apply.
-allow_waitinglist                     boolean                    If ``false``, no waiting list will be shown for this
-                                                                 product when it is sold out.
-issue_giftcard                        boolean                    If ``true``, buying this product will yield a gift card.
-show_quota_left                       boolean                    Publicly show how many tickets are still available.
-                                                                 If this is ``null``, the event default is used.
-has_variations                        boolean                    Shows whether or not this item has variations.
-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.
-├ 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``.
-├ 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.
-├ description                         multi-lingual string       A public description of the variation. May contain
-                                                                 Markdown syntax or can be ``null``.
-└ position                            integer                    An integer, used for sorting
-addons                                list of objects            Definition of add-ons that can be chosen for this item.
-                                                                 Only writable during creation,
-                                                                 use separate endpoint to modify this later.
-├ addon_category                      integer                    Internal ID of the item category the add-on can be
-                                                                 chosen from.
-├ min_count                           integer                    The minimal number of add-ons that need to be chosen.
-├ max_count                           integer                    The maximal number of add-ons that can be chosen.
-├ position                            integer                    An integer, used for sorting
-├ multi_allowed                       boolean                    Adding the same item multiple times is allowed
-└ price_included                      boolean                    Adding this add-on to the item is free
-bundles                               list of objects            Definition of bundles that are included in this item.
-                                                                 Only writable during creation,
-                                                                 use separate endpoint to modify this later.
-├ bundled_item                        integer                    Internal ID of the item that is included.
-├ bundled_variation                   integer                    Internal ID of the variation of the item (or ``null``).
-├ count                               integer                    Number of items included
-└ designated_price                    money (string)             Designated price of the bundled product. This will be
-                                                                 used to split the price of the base item e.g. for mixed
-                                                                 taxation. This is not added to the price.
-meta_data                             object                     Values set for event-specific meta data parameters.
-===================================== ========================== =======================================================
+======================================= ========================== =======================================================
+Field                                   Type                       Description
+======================================= ========================== =======================================================
+id                                      integer                    Internal ID of the item
+name                                    multi-lingual string       The item's visible name
+internal_name                           string                     An optional name that is only used in the backend
+default_price                           money (string)             The item price that is applied if the price is not
+                                                                   overwritten by variations or other options.
+category                                integer                    The ID of the category this item belongs to
+                                                                   (or ``null``).
+active                                  boolean                    If ``false``, the item is hidden from all public lists
+                                                                   and will not be sold.
+description                             multi-lingual string       A public description of the item. May contain Markdown
+                                                                   syntax or can be ``null``.
+free_price                              boolean                    If ``true``, customers can change the price at which
+                                                                   they buy the product (however, the price can't be set
+                                                                   lower than the price defined by ``default_price`` or
+                                                                   otherwise).
+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``).
+admission                               boolean                    ``true`` for items that grant admission to the event
+                                                                   (such as primary tickets) and ``false`` for others
+                                                                   (such as add-ons or merchandise).
+personalized                            boolean                    ``true`` for items that require personalization according
+                                                                   to event settings. Only affects system-level fields, not
+                                                                   custom questions. Currently only allowed for products with
+                                                                   ``admission`` set to ``true``. For backwards compatibility,
+                                                                   when creating new items and this field is not given, it defaults
+                                                                   to the same value as ``admission``.
+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"]``.
+available_from                          datetime                   The first date time at which this item can be bought
+                                                                   (or ``null``).
+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
+                                                                   set, this item won't be shown publicly as long as this
+                                                                   quota is available.
+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
+                                                                   redemption process, but not in the normal shop
+                                                                   frontend.
+allow_cancel                            boolean                    If ``false``, customers cannot cancel orders containing
+                                                                   this item.
+min_per_order                           integer                    This product can only be bought if it is included at
+                                                                   least this many times in the order (or ``null`` for no
+                                                                   limitation).
+max_per_order                           integer                    This product can only be bought if it is included at
+                                                                   most this many times in the order (or ``null`` for no
+                                                                   limitation).
+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.
+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
+                                                                   approved by the event organizer before they can be
+                                                                   paid.
+require_bundling                        boolean                    If ``true``, this item is only available as part of bundles.
+require_membership                      boolean                    If ``true``, booking this item requires an active membership.
+require_membership_hidden               boolean                    If ``true`` and ``require_membership`` is set, this product 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``
+grant_membership_type                   integer                    If set to the internal ID of a membership type, purchasing this item will
+                                                                   create a membership of the given type.
+grant_membership_duration_like_event    boolean                    If ``true``, the membership created through ``grant_membership_type`` will derive
+                                                                   its term from ``date_from`` to ``date_to`` of the purchased (sub)event.
+grant_membership_duration_days          integer                    If ``grant_membership_duration_like_event`` is ``false``, this sets the number of
+                                                                   days for the membership.
+grant_membership_duration_months        integer                    If ``grant_membership_duration_like_event`` is ``false``, this sets the number of
+                                                                   calendar months for the membership.
+validity_mode                           string                     If ``null``, tickets generated for this product do not
+                                                                   have special validity behavior, but follow event configuration and
+                                                                   can be limited e.g. through check-in rules. Other values are ``"fixed"`` and ``"dynamic"``
+validity_fixed_from                     datetime                   If ``validity_mode`` is ``"fixed"``, this is the start of validity for issued tickets.
+validity_fixed_until                    datetime                   If ``validity_mode`` is ``"fixed"``, this is the end of validity for issued tickets.
+validity_dynamic_duration_minutes       integer                    If ``validity_mode`` is ``"dynamic"``, this is the "minutes" component of the ticket validity duration.
+validity_dynamic_duration_hours         integer                    If ``validity_mode`` is ``"dynamic"``, this is the "hours" component of the ticket validity duration.
+validity_dynamic_duration_days          integer                    If ``validity_mode`` is ``"dynamic"``, this is the "days" component of the ticket validity duration.
+validity_dynamic_duration_months        integer                    If ``validity_mode`` is ``"dynamic"``, this is the "months" component of the ticket validity duration.
+validity_dynamic_start_choice           boolean                    If ``validity_mode`` is ``"dynamic"`` and this is ``true``, customers can choose the start of validity.
+validity_dynamic_start_choice_day_limit boolean                    If ``validity_mode`` is ``"dynamic"`` and ``validity_dynamic_start_choice`` is ``true``,
+                                                                   this is the maximum number of days the start can be in the future.
+generate_tickets                        boolean                    If ``false``, tickets are never generated for this
+                                                                   product, regardless of other settings. If ``true``,
+                                                                   tickets are generated even if this is a
+                                                                   non-admission or add-on product, regardless of event
+                                                                   settings. If this is ``null``, regular ticketing
+                                                                   rules apply.
+allow_waitinglist                       boolean                    If ``false``, no waiting list will be shown for this
+                                                                   product when it is sold out.
+issue_giftcard                          boolean                    If ``true``, buying this product will yield a gift card.
+media_policy                            string                     Policy on how to handle reusable media (experimental feature).
+                                                                   Possible values are ``null``, ``"new"``, ``"reuse"``, and ``"reuse_or_new"``.
+media_type                              string                     Type of reusable media to work on (experimental feature). See :ref:`rest-reusablemedia` for possible choices.
+show_quota_left                         boolean                    Publicly show how many tickets are still available.
+                                                                   If this is ``null``, the event default is used.
+has_variations                          boolean                    Shows whether or not this item has variations.
+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.
+├ 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``.
+├ 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.
+├ description                           multi-lingual string       A public description of the variation. May contain
+├ 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.
+├ require_approval                      boolean                    If ``true``, orders with this variation will need to be
+                                                                   approved by the event organizer before they can be
+                                                                   paid.
+├ require_membership                    boolean                    If ``true``, booking this variation requires an active membership.
+├ 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``
+                                                                   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.
+                                                                   The item-level list takes precedence, i.e. a sales
+                                                                   channel needs to be on both lists for the item to be
+                                                                   available.
+├ available_from                        datetime                   The first date time at which this variation can be bought
+                                                                   (or ``null``).
+├ available_until                       datetime                   The last date time at which this variation can be bought
+                                                                   (or ``null``).
+├ 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.
+└ position                              integer                    An integer, used for sorting
+addons                                  list of objects            Definition of add-ons that can be chosen for this item.
+                                                                   Only writable during creation,
+                                                                   use separate endpoint to modify this later.
+├ addon_category                        integer                    Internal ID of the item category the add-on can be
+                                                                   chosen from.
+├ min_count                             integer                    The minimal number of add-ons that need to be chosen.
+├ max_count                             integer                    The maximal number of add-ons that can be chosen.
+├ position                              integer                    An integer, used for sorting
+├ multi_allowed                         boolean                    Adding the same item multiple times is allowed
+└ price_included                        boolean                    Adding this add-on to the item is free
+bundles                                 list of objects            Definition of bundles that are included in this item.
+                                                                   Only writable during creation,
+                                                                   use separate endpoint to modify this later.
+├ bundled_item                          integer                    Internal ID of the item that is included.
+├ bundled_variation                     integer                    Internal ID of the variation of the item (or ``null``).
+├ count                                 integer                    Number of items included
+└ designated_price                      money (string)             Designated price of the bundled product. This will be
+                                                                   used to split the price of the base item e.g. for mixed
+                                                                   taxation. This is not added to the price.
+meta_data                               object                     Values set for event-specific meta data parameters.
+======================================= ========================== =======================================================
 
-.. versionchanged:: 2.7
+.. versionchanged:: 4.0
 
-   The attribute ``original_price`` has been added for ``variations``.
+   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.
 
-.. versionchanged:: 1.7
+.. versionchanged:: 4.4
 
-   The attribute ``tax_rule`` has been added. ``tax_rate`` is kept for compatibility. The attribute
-   ``checkin_attention`` has been added.
+   The attributes ``require_membership_hidden`` attribute has been added.
 
-.. versionchanged:: 1.12
+.. versionchanged:: 4.16
 
-   The write operations ``POST``, ``PATCH``, ``PUT``, and ``DELETE`` have been added.
-   The attribute ``price_included`` has been added to ``addons``.
+   The ``variations[x].meta_data`` and ``variations[x].checkin_attention`` attributes have been added.
+   The ``personalized`` attribute has been added.
 
-.. versionchanged:: 1.16
+.. versionchanged:: 4.17
 
-   The ``internal_name`` and ``original_price`` fields have been added.
+   The ``validity_*`` attributes have been added.
 
-.. versionchanged:: 2.0
+.. versionchanged:: 4.18
 
-   The field ``require_approval`` has been added.
-
-.. versionchanged:: 2.3
-
-   The ``sales_channels`` attribute has been added.
-
-.. versionchanged:: 2.4
-
-   The ``generate_tickets`` attribute has been added.
-
-.. versionchanged:: 2.6
-
-   The ``bundles`` and ``require_bundling`` attributes have been added.
-
-.. versionchanged:: 3.0
-
-   The ``show_quota_left``, ``allow_waitinglist``, and ``hidden_if_available`` attributes have been added.
-
-.. versionchanged:: 3.7
-
-   The attribute ``meta_data`` has been added.
-
-.. versionchanged:: 3.10
-
-   The attribute ``multi_allowed`` has been added to ``addons``.
+   The ``media_policy`` and ``media_type`` attributes have been added.
 
 Notes
 -----
@@ -217,7 +249,10 @@ Endpoints
             "tax_rate": "0.00",
             "tax_rule": 1,
             "admission": false,
+            "personalized": false,
             "issue_giftcard": false,
+            "media_policy": null,
+            "media_type": null,
             "meta_data": {},
             "position": 0,
             "picture": null,
@@ -236,6 +271,20 @@ Endpoints
             "show_quota_left": null,
             "require_approval": false,
             "require_bundling": false,
+            "require_membership": false,
+            "require_membership_types": [],
+            "grant_membership_type": null,
+            "grant_membership_duration_like_event": true,
+            "grant_membership_duration_days": 0,
+            "grant_membership_duration_months": 0,
+            "validity_fixed_from": null,
+            "validity_fixed_until": null,
+            "validity_dynamic_duration_minutes": null,
+            "validity_dynamic_duration_hours": null,
+            "validity_dynamic_duration_days": null,
+            "validity_dynamic_duration_months": null,
+            "validity_dynamic_start_choice": false,
+            "validity_dynamic_start_choice_day_limit": null,
             "variations": [
               {
                  "value": {"en": "Student"},
@@ -243,7 +292,16 @@ Endpoints
                  "price": "10.00",
                  "original_price": null,
                  "active": true,
+                 "checkin_attention": false,
+                 "require_approval": false,
+                 "require_membership": false,
+                 "require_membership_types": [],
+                 "sales_channels": ["web"],
+                 "available_from": null,
+                 "available_until": null,
+                 "hide_without_voucher": false,
                  "description": null,
+                 "meta_data": {},
                  "position": 0
               },
               {
@@ -252,7 +310,16 @@ Endpoints
                  "price": "23.00",
                  "original_price": null,
                  "active": true,
+                 "checkin_attention": false,
+                 "require_approval": false,
+                 "require_membership": false,
+                 "require_membership_types": [],
+                 "sales_channels": ["web"],
+                 "available_from": null,
+                 "available_until": null,
+                 "hide_without_voucher": false,
                  "description": null,
+                 "meta_data": {},
                  "position": 1
               }
             ],
@@ -313,7 +380,10 @@ Endpoints
         "tax_rate": "0.00",
         "tax_rule": 1,
         "admission": false,
+        "personalized": false,
         "issue_giftcard": false,
+        "media_policy": null,
+        "media_type": null,
         "meta_data": {},
         "position": 0,
         "picture": null,
@@ -332,6 +402,20 @@ Endpoints
         "has_variations": false,
         "require_approval": false,
         "require_bundling": false,
+        "require_membership": false,
+        "require_membership_types": [],
+        "grant_membership_type": null,
+        "grant_membership_duration_like_event": true,
+        "grant_membership_duration_days": 0,
+        "grant_membership_duration_months": 0,
+        "validity_fixed_from": null,
+        "validity_fixed_until": null,
+        "validity_dynamic_duration_minutes": null,
+        "validity_dynamic_duration_hours": null,
+        "validity_dynamic_duration_days": null,
+        "validity_dynamic_duration_months": null,
+        "validity_dynamic_start_choice": false,
+        "validity_dynamic_start_choice_day_limit": null,
         "variations": [
           {
              "value": {"en": "Student"},
@@ -339,7 +423,16 @@ Endpoints
              "price": "10.00",
              "original_price": null,
              "active": true,
+             "checkin_attention": false,
+             "require_approval": false,
+             "require_membership": false,
+             "require_membership_types": [],
              "description": null,
+             "sales_channels": ["web"],
+             "available_from": null,
+             "available_until": null,
+             "hide_without_voucher": false,
+             "meta_data": {},
              "position": 0
           },
           {
@@ -348,7 +441,16 @@ Endpoints
              "price": "23.00",
              "original_price": null,
              "active": true,
+             "checkin_attention": false,
+             "require_approval": false,
+             "require_membership": false,
+             "require_membership_types": [],
+             "sales_channels": ["web"],
+             "available_from": null,
+             "available_until": null,
+             "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 1
           }
         ],
@@ -390,7 +492,10 @@ Endpoints
         "tax_rate": "0.00",
         "tax_rule": 1,
         "admission": false,
+        "personalized": false,
         "issue_giftcard": false,
+        "media_policy": null,
+        "media_type": null,
         "meta_data": {},
         "position": 0,
         "picture": null,
@@ -408,6 +513,20 @@ Endpoints
         "checkin_attention": false,
         "require_approval": false,
         "require_bundling": false,
+        "require_membership": false,
+        "require_membership_types": [],
+        "grant_membership_type": null,
+        "grant_membership_duration_like_event": true,
+        "grant_membership_duration_days": 0,
+        "grant_membership_duration_months": 0,
+        "validity_fixed_from": null,
+        "validity_fixed_until": null,
+        "validity_dynamic_duration_minutes": null,
+        "validity_dynamic_duration_hours": null,
+        "validity_dynamic_duration_days": null,
+        "validity_dynamic_duration_months": null,
+        "validity_dynamic_start_choice": false,
+        "validity_dynamic_start_choice_day_limit": null,
         "variations": [
           {
              "value": {"en": "Student"},
@@ -415,7 +534,16 @@ Endpoints
              "price": "10.00",
              "original_price": null,
              "active": true,
+             "checkin_attention": false,
+             "require_approval": false,
+             "require_membership": false,
+             "require_membership_types": [],
+             "sales_channels": ["web"],
+             "available_from": null,
+             "available_until": null,
+             "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 0
           },
           {
@@ -424,7 +552,16 @@ Endpoints
              "price": "23.00",
              "original_price": null,
              "active": true,
+             "checkin_attention": false,
+             "require_approval": false,
+             "require_membership": false,
+             "require_membership_types": [],
+             "sales_channels": ["web"],
+             "available_from": null,
+             "available_until": null,
+             "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 1
           }
         ],
@@ -454,7 +591,10 @@ Endpoints
         "tax_rate": "0.00",
         "tax_rule": 1,
         "admission": false,
+        "personalized": false,
         "issue_giftcard": false,
+        "media_policy": null,
+        "media_type": null,
         "meta_data": {},
         "position": 0,
         "picture": null,
@@ -473,6 +613,20 @@ Endpoints
         "has_variations": true,
         "require_approval": false,
         "require_bundling": false,
+        "require_membership": false,
+        "require_membership_types": [],
+        "grant_membership_type": null,
+        "grant_membership_duration_like_event": true,
+        "grant_membership_duration_days": 0,
+        "grant_membership_duration_months": 0,
+        "validity_fixed_from": null,
+        "validity_fixed_until": null,
+        "validity_dynamic_duration_minutes": null,
+        "validity_dynamic_duration_hours": null,
+        "validity_dynamic_duration_days": null,
+        "validity_dynamic_duration_months": null,
+        "validity_dynamic_start_choice": false,
+        "validity_dynamic_start_choice_day_limit": null,
         "variations": [
           {
              "value": {"en": "Student"},
@@ -480,7 +634,16 @@ Endpoints
              "price": "10.00",
              "original_price": null,
              "active": true,
+             "checkin_attention": false,
+             "require_approval": false,
+             "require_membership": false,
+             "require_membership_types": [],
+             "sales_channels": ["web"],
+             "available_from": null,
+             "available_until": null,
+             "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 0
           },
           {
@@ -489,7 +652,16 @@ Endpoints
              "price": "23.00",
              "original_price": null,
              "active": true,
+             "checkin_attention": false,
+             "require_approval": false,
+             "require_membership": false,
+             "require_membership_types": [],
+             "sales_channels": ["web"],
+             "available_from": null,
+             "available_until": null,
+             "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 1
           }
         ],
@@ -550,7 +722,10 @@ Endpoints
         "tax_rate": "0.00",
         "tax_rule": 1,
         "admission": false,
+        "personalized": false,
         "issue_giftcard": false,
+        "media_policy": null,
+        "media_type": null,
         "meta_data": {},
         "position": 0,
         "picture": null,
@@ -569,6 +744,20 @@ Endpoints
         "has_variations": true,
         "require_approval": false,
         "require_bundling": false,
+        "require_membership": false,
+        "require_membership_types": [],
+        "grant_membership_type": null,
+        "grant_membership_duration_like_event": true,
+        "grant_membership_duration_days": 0,
+        "grant_membership_duration_months": 0,
+        "validity_fixed_from": null,
+        "validity_fixed_until": null,
+        "validity_dynamic_duration_minutes": null,
+        "validity_dynamic_duration_hours": null,
+        "validity_dynamic_duration_days": null,
+        "validity_dynamic_duration_months": null,
+        "validity_dynamic_start_choice": false,
+        "validity_dynamic_start_choice_day_limit": null,
         "variations": [
           {
              "value": {"en": "Student"},
@@ -576,7 +765,16 @@ Endpoints
              "price": "10.00",
              "original_price": null,
              "active": true,
+             "checkin_attention": false,
+             "require_approval": false,
+             "require_membership": false,
+             "require_membership_types": [],
+             "sales_channels": ["web"],
+             "available_from": null,
+             "available_until": null,
+             "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 0
           },
           {
@@ -585,7 +783,16 @@ Endpoints
              "price": "23.00",
              "original_price": null,
              "active": true,
+             "checkin_attention": false,
+             "require_approval": false,
+             "require_membership": false,
+             "require_membership_types": [],
+             "sales_channels": ["web"],
+             "available_from": null,
+             "available_until": null,
+             "hide_without_voucher": false,
              "description": null,
+             "meta_data": {},
              "position": 1
           }
         ],

doc/api/resources/memberships.rst

@@ -0,0 +1,216 @@
+Memberships
+===========
+
+Resource description
+--------------------
+
+The membership resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of the membership
+customer                              string                     Identifier of the customer associated with this membership (can't be changed)
+testmode                              boolean                    Whether this is a test membership
+membership_type                       integer                    Internal ID of the membership type
+date_start                            datetime                   Start of validity
+date_end                              datetime                   End of validity
+attendee_name_parts                   object                     JSON representation of components of an attendee name (configuration dependent)
+===================================== ========================== =======================================================
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/memberships/
+
+   Returns a list of all memberships within a given organizer.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/memberships/ 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": 2,
+            "customer": "EGR9SYT",
+            "membership_type": 1,
+            "testmode": false,
+            "date_start": "2021-04-19T00:00:00+02:00",
+            "date_end": "2021-04-20T00:00:00+02:00",
+            "attendee_name_parts": {
+                "_scheme": "title_given_family",
+                "family_name": "Doe",
+                "given_name": "John",
+                "title": ""
+            }
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :query string customer: A customer identifier to filter for
+   :query integer membership_type: A membership type ID to filter for
+   :query boolean testmode: Filter for memberships that are (not) in test mode.
+   :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)/memberships/(id)/
+
+   Returns information on one membership, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/memberships/2/ 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": 2,
+        "customer": "EGR9SYT",
+        "membership_type": 1,
+        "testmode": false,
+        "date_start": "2021-04-19T00:00:00+02:00",
+        "date_end": "2021-04-20T00:00:00+02:00",
+        "attendee_name_parts": {
+            "_scheme": "title_given_family",
+            "family_name": "Doe",
+            "given_name": "John",
+            "title": ""
+        }
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param id: The ``id`` field of the membership 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)/memberships/
+
+   Creates a new membership
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/memberships/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "membership_type": 2,
+        "customer": "EGR9SYT",
+        "testmode": false,
+        "date_start": "2021-04-19T00:00:00+02:00",
+        "date_end": "2021-04-20T00:00:00+02:00",
+        "attendee_name_parts": {
+            "_scheme": "title_given_family",
+            "family_name": "Doe",
+            "given_name": "John",
+            "title": ""
+        }
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 3,
+        "membership_type": 2,
+        "customer": "EGR9SYT",
+        "testmode": false,
+        "date_start": "2021-04-19T00:00:00+02:00",
+        "date_end": "2021-04-20T00:00:00+02:00",
+        "attendee_name_parts": {
+            "_scheme": "title_given_family",
+            "family_name": "Doe",
+            "given_name": "John",
+            "title": ""
+        }
+      }
+
+   :param organizer: The ``slug`` field of the organizer to create a membership for
+   :statuscode 201: no error
+   :statuscode 400: The membership 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)/memberships/(id)/
+
+   Update a membership. 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``, ``customer``, and ``testmode`` fields.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/memberships/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 94
+
+      {
+        "membership_type": 3
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "membership_type": 3,
+        …
+      }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param id: The ``id`` field of the membership to modify
+   :statuscode 200: no error
+   :statuscode 400: The membership 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.
+

doc/api/resources/membershiptypes.rst

@@ -0,0 +1,227 @@
+Membership types
+================
+
+Resource description
+--------------------
+
+The membership type resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of the membership type
+name                                  multi-lingual string       Human-readable name of the type
+transferable                          boolean                    Whether a membership of this type can be used by
+                                                                 multiple persons
+allow_parallel_usage                  boolean                    Whether a membership of this type can be used for
+                                                                 multiple parallel tickets
+max_usages                            integer                    Maximum number of times a membership of this type can be
+                                                                 used.
+===================================== ========================== =======================================================
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/membershiptypes/
+
+   Returns a list of all membership types within a given organizer.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/membershiptypes/ 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": 2,
+            "name": {
+              "de": "Wochenkarte",
+              "en": "Week pass"
+            },
+            "transferable": false,
+            "allow_parallel_usage": false,
+            "max_usages": 7
+          }
+        ]
+      }
+
+   :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)/membershiptypes/(id)/
+
+   Returns information on one membership type, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/membershiptypes/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,
+        "name": {
+          "de": "Wochenkarte",
+          "en": "Week pass"
+        },
+        "transferable": false,
+        "allow_parallel_usage": false,
+        "max_usages": 7
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param id: The ``id`` field of the membership type 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)/membershiptypes/
+
+   Creates a new membership type
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/membershiptypes/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "name": {
+          "de": "Wochenkarte",
+          "en": "Week pass"
+        },
+        "transferable": false,
+        "allow_parallel_usage": false,
+        "max_usages": 7
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 3,
+        "name": {
+          "de": "Wochenkarte",
+          "en": "Week pass"
+        },
+        "transferable": false,
+        "allow_parallel_usage": false,
+        "max_usages": 7
+      }
+
+   :param organizer: The ``slug`` field of the organizer to create a membership type for
+   :statuscode 201: no error
+   :statuscode 400: The membership type 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)/membershiptypes/(id)/
+
+   Update a membership type. 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/membershiptypes/2/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 94
+
+      {
+        "max_usages": 3
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 2,
+        "name": {
+          "de": "Wochenkarte",
+          "en": "Week pass"
+        },
+        "transferable": false,
+        "allow_parallel_usage": false,
+        "max_usages": 3
+      }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param id: The ``id`` field of the membership type to modify
+   :statuscode 200: no error
+   :statuscode 400: The membership 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)/membershiptypes/(id)/
+
+   Delete a membership type. You can not delete types which have already been used.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/membershiptype/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 type 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 membership type is currently in use.

doc/api/resources/organizers.rst

@@ -17,12 +17,18 @@ Field                                 Type                       Description
 name                                  string                     The organizer's full name, i.e. the name of an
                                                                  organization or company.
 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).
 ===================================== ========================== =======================================================
 
 
 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.
@@ -51,6 +57,7 @@ Endpoints
           {
             "name": "Big Events LLC",
             "slug": "Big Events",
+            "public_url": "https://pretix.eu/bigevents/"
           }
         ]
       }
@@ -84,6 +91,7 @@ Endpoints
       {
         "name": "Big Events LLC",
         "slug": "Big Events",
+        "public_url": "https://pretix.eu/bigevents/"
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -109,10 +117,6 @@ information about the properties.
 .. warning:: This API is intended for advanced users. Even though we take care to validate your input, you will be
              able to break your shops using this API by creating situations of conflicting settings. Please take care.
 
-.. versionchanged:: 3.14
-
-   Initial support for settings has been added to the API.
-
 .. http:get:: /api/v1/organizers/(organizer)/settings/
 
    Get current values of organizer settings.
@@ -153,6 +157,7 @@ information about the properties.
           {
             "value": "calendar",
             "label": "Default overview style",
+            "readonly": false,
             "help_text": "If your event series has more than 50 dates in the future, only the month or week calendar can be used."
           }
         },

doc/api/resources/question_options.rst

@@ -19,10 +19,6 @@ identifier                            string                     An arbitrary st
 answer                                multi-lingual string       The displayed value of this option
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.12
-
-   This resource has been added.
-
 Endpoints
 ---------
 

doc/api/resources/questions.rst

@@ -1,4 +1,4 @@
-.. spelling::
+.. spelling:word-list::
 
    checkin
    datetime
@@ -62,6 +62,8 @@ valid_date_min                        date                       Minimum value f
 valid_date_max                        date                       Maximum value for date questions (optional)
 valid_datetime_min                    datetime                   Minimum value for date and time questions (optional)
 valid_datetime_max                    datetime                   Maximum value for date and time questions (optional)
+valid_file_portrait                   boolean                    Turn on file validation for portrait photos
+valid_string_length_max               integer                    Maximum length for string questions (optional)
 dependency_question                   integer                    Internal ID of a different question. The current
                                                                  question will only be shown if the question given in
                                                                  this attribute is set to the value given in
@@ -75,44 +77,9 @@ dependency_value                      string                     An old version
                                                                  for one value. **Deprecated.**
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.12
-
-  The values ``D``, ``H``, and ``W`` for the field ``type`` are now allowed and the ``ask_during_checkin`` field has
-  been added.
-
-.. versionchanged:: 1.14
-
-  Write methods have been added. The attribute ``identifier`` has been added to both the resource itself and the
-  options resource. The ``position`` attribute has been added to the options resource.
-
-.. versionchanged:: 2.7
-
-  The attribute ``hidden`` and the question type ``CC`` have been added.
-
-.. versionchanged:: 3.0
-
-  The attribute ``dependency_values`` has been added.
-
-.. versionchanged:: 3.1
-
-  The attribute ``print_on_invoice`` has been added.
-
-.. versionchanged:: 3.5
-
-  The attribute ``help_text`` has been added.
-
-.. versionchanged:: 3.14
-
-  The attributes ``valid_*`` have been added.
-
 Endpoints
 ---------
 
-.. versionchanged:: 1.15
-
-   The questions endpoint has been extended by the filter queries ``ask_during_checkin``, ``requred``, and
-   ``identifier``.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/questions/
 
    Returns a list of all questions within a given event.
@@ -156,6 +123,8 @@ Endpoints
             "valid_date_max": null,
             "valid_datetime_min": null,
             "valid_datetime_max": null,
+            "valid_string_length_max": null,
+            "valid_file_portrait": false,
             "dependency_question": null,
             "dependency_value": null,
             "dependency_values": [],
@@ -233,6 +202,8 @@ Endpoints
         "valid_date_max": null,
         "valid_datetime_min": null,
         "valid_datetime_max": null,
+        "valid_file_portrait": false,
+        "valid_string_length_max": null,
         "dependency_question": null,
         "dependency_value": null,
         "dependency_values": [],
@@ -333,6 +304,8 @@ Endpoints
         "valid_date_max": null,
         "valid_datetime_min": null,
         "valid_datetime_max": null,
+        "valid_file_portrait": false,
+        "valid_string_length_max": null,
         "options": [
           {
             "id": 1,
@@ -414,6 +387,8 @@ Endpoints
         "valid_date_max": null,
         "valid_datetime_min": null,
         "valid_datetime_max": null,
+        "valid_file_portrait": false,
+        "valid_string_length_max": null,
         "options": [
           {
             "id": 1,

doc/api/resources/quotas.rst

@@ -28,19 +28,17 @@ 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.
+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.
+available_number                      integer                    Number of available tickets. 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. ``null`` means unlimited.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.10
+.. versionchanged:: 4.1
 
-   The write operations ``POST``, ``PATCH``, ``PUT``, and ``DELETE`` have been added.
-
-.. versionchanged:: 3.0
-
-   The attributes ``close_when_sold_out`` and ``closed`` have been added.
-
-.. versionchanged:: 3.10
-
-   The attribute ``release_after_exit`` has been added.
+    The ``with_availability`` query parameter has been added.
 
 
 Endpoints
@@ -87,7 +85,9 @@ Endpoints
    :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`` and ``position``.
                            Default: ``position``
-   :query integer subevent: Only return quotas of the sub-event with the given ID
+   :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 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
    :statuscode 200: no error
@@ -128,6 +128,7 @@ Endpoints
    :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 quota to fetch
+   :query string with_availability: Set to ``true`` to get availability information. Can lead to increased answer times.
    :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/reusablemedia.rst

@@ -0,0 +1,326 @@
+.. _`rest-reusablemedia`:
+
+Reusable media
+==============
+
+Reusable media represent things, typically physical tokens like plastic cards or NFC wristbands, which can represent
+other entities inside the system. For example, a medium can link to an order position or to a gift card and can be used
+in their place. Later, the medium might be reused for a different ticket.
+
+Resource description
+--------------------
+
+The reusable medium resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of the medium
+type                                  string                     Type of medium, e.g. ``"barcode"`` or ``"nfc_uid"``.
+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.
+created                               datetime                   Date of creation
+updated                               datetime                   Date of last modification
+expires                               datetime                   Expiry date (or ``null``)
+customer                              string                     Identifier of a customer account this medium belongs to.
+linked_orderposition                  integer                    Internal ID of a ticket this medium is linked to.
+linked_giftcard                       integer                    Internal ID of a gift card this medium is linked to.
+info                                  object                     Additional data, content depends on the ``type``. Consider
+                                                                 this internal to the system and don't use it for your own data.
+notes                                 string                     Internal notes and comments (or ``null``)
+===================================== ========================== =======================================================
+
+Existing media types are:
+
+- ``barcode``
+- ``nfc_uid``
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/reusablemedia/
+
+   Returns a list of all media issued by a given organizer.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/reusablemedia/ 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,
+            "organizer": "bigevents",
+            "identifier": "ABCDEFGH",
+            "created": "2021-04-06T13:44:22.809377Z",
+            "updated": "2021-04-06T13:44:22.809377Z",
+            "type": "barcode",
+            "active": True,
+            "expires": None,
+            "customer": None,
+            "linked_orderposition": None,
+            "linked_giftcard": None,
+            "notes": None,
+            "info": {}
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1.
+   :query string identifier: Only show media with the given identifier. Note that you should use the lookup endpoint described below for most use cases.
+   :query string type: Only show media with the given type.
+   :query boolean active: Only show media that are (not) active.
+   :query string customer: Only show media linked to the given customer.
+   :query string created_since: Only show media created since a given date.
+   :query string updated_since: Only show media updated since a given date.
+   :query integer linked_orderposition: Only show media linked to the given ticket.
+   :query integer linked_giftcard: Only show media linked to the given gift card.
+   :query string expand: If you pass ``"linked_giftcard"``, ``"linked_giftcard.owner_ticket"``, ``"linked_orderposition"``,
+                         or ``"customer"``, the respective field will be shown as a nested value instead of just an ID.
+                         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. The parameter can be given multiple times.
+   :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)/reusablemedia/(id)/
+
+   Returns information on one medium, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/reusablemedia/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,
+        "organizer": "bigevents",
+        "identifier": "ABCDEFGH",
+        "created": "2021-04-06T13:44:22.809377Z",
+        "updated": "2021-04-06T13:44:22.809377Z",
+        "type": "barcode",
+        "active": True,
+        "expires": None,
+        "customer": None,
+        "linked_orderposition": None,
+        "linked_giftcard": None,
+        "notes": None,
+        "info": {}
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param id: The ``id`` field of the medium to fetch
+   :query string expand: If you pass ``"linked_giftcard"``, ``"linked_giftcard.owner_ticket"``, ``"linked_orderposition"``,
+                         or ``"customer"``, the respective field will be shown as a nested value instead of just an ID.
+                         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. 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.
+
+.. http:post:: /api/v1/organizers/(organizer)/reusablemedia/lookup/
+
+   Look up a new reusable medium by its identifier. In some cases, this might lead to the automatic creation of a new
+   medium behind the scenes.
+
+   This endpoint, and this endpoint only, might return media from a different organizer if there is a cross-acceptance
+   agreement. In this case, only linked gift cards will be returned, no order position or customer records,
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/reusablemedia/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "identifier": "ABCDEFGH",
+        "type": "barcode",
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "organizer": "bigevents",
+        "identifier": "ABCDEFGH",
+        "created": "2021-04-06T13:44:22.809377Z",
+        "updated": "2021-04-06T13:44:22.809377Z",
+        "type": "barcode",
+        "active": True,
+        "expires": None,
+        "customer": None,
+        "linked_orderposition": None,
+        "linked_giftcard": None,
+        "notes": None,
+        "info": {}
+      }
+
+   :param organizer: The ``slug`` field of the organizer to look up a medium for
+   :query string expand: If you pass ``"linked_giftcard"``, ``"linked_orderposition"``, oder ``"customer"``, the respective
+                         field will be shown as a nested value instead of just an ID. The nested objects are identical to
+                         the respective resources, except that the ``linked_orderposition`` will have an attribute of the
+                         format ``"order": {"code": "ABCDE", "event": "eventslug"}`` to make matching easier. The parameter
+                         can be given multiple times.
+   :statuscode 201: no error
+   :statuscode 400: The medium could not be looked up 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:post:: /api/v1/organizers/(organizer)/reusablemedia/
+
+   Creates a new reusable medium.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/reusablemedia/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "identifier": "ABCDEFGH",
+        "type": "barcode",
+        "active": True,
+        "expires": None,
+        "customer": None,
+        "linked_orderposition": None,
+        "linked_giftcard": None,
+        "notes": None,
+        "info": {}
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "organizer": "bigevents",
+        "identifier": "ABCDEFGH",
+        "created": "2021-04-06T13:44:22.809377Z",
+        "updated": "2021-04-06T13:44:22.809377Z",
+        "type": "barcode",
+        "active": True,
+        "expires": None,
+        "customer": None,
+        "linked_orderposition": None,
+        "linked_giftcard": None,
+        "notes": None,
+        "info": {}
+      }
+
+   :param organizer: The ``slug`` field of the organizer to create a medium for
+   :query string expand: If you pass ``"linked_giftcard"``, ``"linked_orderposition"``, oder ``"customer"``, the respective
+                         field will be shown as a nested value instead of just an ID. The nested objects are identical to
+                         the respective resources, except that the ``linked_orderposition`` will have an attribute of the
+                         format ``"order": {"code": "ABCDE", "event": "eventslug"}`` to make matching easier. The parameter
+                         can be given multiple times.
+   :statuscode 201: no error
+   :statuscode 400: The medium 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)/reusablemedia/(id)/
+
+   Update a reusable medium. 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``, ``identifier`` and ``type`` fields.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/reusablemedia/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 94
+
+      {
+        "linked_orderposition": 13
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "organizer": "bigevents",
+        "identifier": "ABCDEFGH",
+        "created": "2021-04-06T13:44:22.809377Z",
+        "updated": "2021-04-06T13:44:22.809377Z",
+        "type": "barcode",
+        "active": True,
+        "expires": None,
+        "customer": None,
+        "linked_orderposition": 13,
+        "linked_giftcard": None,
+        "notes": None,
+        "info": {}
+      }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param id: The ``id`` field of the medium to modify
+   :query string expand: If you pass ``"linked_giftcard"``, ``"linked_orderposition"``, oder ``"customer"``, the respective
+                         field will be shown as a nested value instead of just an ID. The nested objects are identical to
+                         the respective resources, except that the ``linked_orderposition`` will have an attribute of the
+                         format ``"order": {"code": "ABCDE", "event": "eventslug"}`` to make matching easier. The parameter
+                         can be given multiple times.
+   :statuscode 200: no error
+   :statuscode 400: The medium 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.

doc/api/resources/seatingplans.rst

@@ -20,10 +20,6 @@ layout                                object                     JSON representa
                                                                  still evolves. The version in use can be found `here`_.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 3.0
-
-   This endpoint has been added.
-
 Endpoints
 ---------
 

doc/api/resources/sendmail_rules.rst

@@ -0,0 +1,281 @@
+Automated email rules
+=====================
+
+Resource description
+--------------------
+
+Automated 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
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of the rule
+enabled                               boolean                    If ``false``, the rule is ignored
+subject                               multi-lingual string       The subject of the email
+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``,
+                                                                 only paid orders are considered.
+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
+                                                                 before/after the email is sent.
+send_offset_time                      time                       If ``date_is_absolute`` is not set, this is the time of day the
+                                                                 email is sent on the day specified by ``send_offset_days``.
+offset_to_event_end                   boolean                    If ``true``, ``send_offset_days`` is relative to the event end
+                                                                 date. Otherwise it is relative to the event start date.
+offset_is_after                       boolean                    If ``true``, ``send_offset_days`` is the number of days **after**
+                                                                 the event start or end date. Otherwise it is the number of days
+                                                                 **before**.
+send_to                               string                     Can be ``"orders"`` if the email should be sent to customers
+                                                                 (one email per order),
+                                                                 ``"attendees"`` if the email should be sent to every attendee,
+                                                                 or ``"both"``.
+                                                                 date. Otherwise it is relative to the event start date.
+===================================== ========================== =======================================================
+
+
+Endpoints
+---------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/sendmail_rules/
+
+   Returns a list of all rules configured for an event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/sendmail_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,
+            "enabled": true,
+            "subject": {"en": "See you tomorrow!"},
+            "template": {"en": "Don't forget your tickets, download them at {url}"},
+            "all_products": true,
+            "limit_products": [],
+            "include_pending": false,
+            "send_date": null,
+            "send_offset_days": 1,
+            "send_offset_time": "18:00",
+            "date_is_absolute": false,
+            "offset_to_event_end": false,
+            "offset_is_after": false,
+            "send_to": "orders"
+          }
+        ]
+      }
+
+   :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)/sendmail_rules/(id)/
+
+   Returns information on one rule, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/sendmail_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,
+        "enabled": true,
+        "subject": {"en": "See you tomorrow!"},
+        "template": {"en": "Don't forget your tickets, download them at {url}"},
+        "all_products": true,
+        "limit_products": [],
+        "include_pending": false,
+        "send_date": null,
+        "send_offset_days": 1,
+        "send_offset_time": "18:00",
+        "date_is_absolute": false,
+        "offset_to_event_end": false,
+        "offset_is_after": false,
+        "send_to": "orders"
+      }
+
+   :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)/sendmail_rules/
+
+   Create a new rule.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/sendmail_rules/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 166
+
+      {
+        "enabled": true,
+        "subject": {"en": "See you tomorrow!"},
+        "template": {"en": "Don't forget your tickets, download them at {url}"},
+        "all_products": true,
+        "limit_products": [],
+        "include_pending": false,
+        "send_date": null,
+        "send_offset_days": 1,
+        "send_offset_time": "18:00",
+        "date_is_absolute": false,
+        "offset_to_event_end": false,
+        "offset_is_after": false,
+        "send_to": "orders"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "enabled": true,
+        "subject": {"en": "See you tomorrow!"},
+        "template": {"en": "Don't forget your tickets, download them at {url}"},
+        "all_products": true,
+        "limit_products": [],
+        "include_pending": false,
+        "send_date": null,
+        "send_offset_days": 1,
+        "send_offset_time": "18:00",
+        "date_is_absolute": false,
+        "offset_to_event_end": false,
+        "offset_is_after": false,
+        "send_to": "orders"
+      }
+
+   :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)/sendmail_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/sendmail_rules/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 34
+
+      {
+        "enabled": false,
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: text/javascript
+
+      {
+        "id": 1,
+        "enabled": false,
+        "subject": {"en": "See you tomorrow!"},
+        "template": {"en": "Don't forget your tickets, download them at {url}"},
+        "all_products": true,
+        "limit_products": [],
+        "include_pending": false,
+        "send_date": null,
+        "send_offset_days": 1,
+        "send_offset_time": "18:00",
+        "date_is_absolute": false,
+        "offset_to_event_end": false,
+        "offset_is_after": false,
+        "send_to": "orders"
+      }
+
+   :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)/sendmail_rules/(id)/
+
+   Delete a rule.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/sendmail_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/shredders.rst

@@ -0,0 +1,177 @@
+.. spelling:word-list:: checkin
+
+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.
+
+Listing available shredders
+---------------------------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/shredders/
+
+   Returns a list of all exporters shredders for a given event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/shredders/ 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": "question_answers",
+            "verbose_name": "Answers to questions"
+          }
+        ]
+      }
+
+   :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
+   :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.
+
+Running an export
+-----------------
+
+Before you can delete data, you need to start a data export.
+Since exports often include large data sets, they might take longer than the duration of an HTTP request. Therefore,
+creating an export is a two-step process. First you need to start an export task with one of the following to API
+endpoints:
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/shredders/export/
+
+   Starts an export task. If your input parameters validate correctly, a ``202 Accepted`` status code is returned.
+   The body points you to the download URL of the result as well as the URL for the next step.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/shredders/export/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "shredders": ["question_answers"]
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 202 Accepted
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "download": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/shredders/download/29891ede-196f-4942-9e26-d055a36e98b8/3f279f13-c198-4137-b49b-9b360ce9fcce/",
+        "shred": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/shredders/shred/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 identifier: The ``identifier`` field of the exporter to run
+   :statuscode 202: no error
+   :statuscode 400: Invalid input options or event data is not ready to be deleted
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+
+
+Downloading the result
+----------------------
+
+When starting an export, you receive a ``download`` URL for downloading the result. Running a ``GET`` request on that result 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 / belongs to a different API key.
+
+
+Shredding the data
+------------------
+
+When starting an export, you receive a ``shred`` URL for actually shredding the data.
+You can only start the actual shredding process after the export file was generated, however you are not forced to download
+the file (we'd recommend it in most cases, though).
+The download will no longer be possible after the shredding.
+Since shredding often requires deleting large data sets, it might take longer than the duration of an HTTP request.
+Therefore, shredding again is a two-step process. First you need to start a shredder task with one of the following to API
+endpoints:
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/shredders/shred/(id1)/(id2)/
+
+   Starts an export task. If your input parameters validate correctly, a ``202 Accepted`` status code is returned.
+   The body points you to an URL you can use to check the status.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/shredders/shred/29891ede-196f-4942-9e26-d055a36e98b8/3f279f13-c198-4137-b49b-9b360ce9fcce/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 202 Accepted
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "status": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/shredders/status/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 id1: Opaque value given to you in the previous response
+   :param id2: Opaque value given to you in the previous response
+   :statuscode 202: no error
+   :statuscode 400: Invalid input options
+   :statuscode 401: Authentication failure
+   :statuscode 404: The export does not exist / is expired / belongs to a different API key.
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+   :statuscode 409: 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.
+   :statuscode 410: Either the job has timed out or running the export has failed permanently. The body will be JSON with the structure ``{"status": "failed", "message": "Error message"}``
+
+
+Checking the result
+-------------------
+
+When starting to shred, you receive a ``status`` URL for checking for success.
+Running a ``GET`` request on that result will yield one of the following status codes:
+
+* ``200 OK`` – The shredding succeeded.
+* ``409 Conflict`` – Shredding 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`` – We no longer know about this process, probably the process was started more than an hour ago. Might also occur after successful operations on small pretix installations without asynchronous task handling.
+* ``417 Expectation Failed`` – Running the export has failed permanently. The body will be JSON with the structure ``{"status": "failed", "message": "Error message"}``

doc/api/resources/subevents.rst

@@ -1,4 +1,4 @@
-.. spelling::
+.. spelling:word-list::
 
    geo
    lat
@@ -33,18 +33,23 @@ date_to                               datetime                   The sub-event's
 date_admission                        datetime                   The sub-event's admission date (or ``null``)
 presale_start                         datetime                   The sub-date at which the ticket shop opens (or ``null``)
 presale_end                           datetime                   The sub-date at which the ticket shop closes (or ``null``)
+frontpage_text                        multi-lingual string       The description of the event (or ``null``)
 location                              multi-lingual string       The sub-event location (or ``null``)
 geo_lat                               float                      Latitude of the location (or ``null``)
 geo_lon                               float                      Longitude of the location (or ``null``)
 item_price_overrides                  list of objects            List of items for which this sub-event overrides the
-                                                                 default price
+                                                                 default price or settings
 ├ item                                integer                    The internal item ID
 ├ disabled                            boolean                    If ``true``, item should not be available for this sub-event
+├ available_from                      datetime                   Start of availability (or ``null``)
+├ available_until                     datetime                   End of availability (or ``null``)
 └ price                               money (string)             The price or ``null`` for the default price
 variation_price_overrides             list of objects            List of variations for which this sub-event overrides
-                                                                 the default price
+                                                                 the default price or settings
 ├ variation                           integer                    The internal variation ID
 ├ disabled                            boolean                    If ``true``, variation should not be available for this sub-event
+├ available_from                      datetime                   Start of availability (or ``null``)
+├ available_until                     datetime                   End of availability (or ``null``)
 └ price                               money (string)             The price or ``null`` for the default price
 meta_data                             object                     Values set for organizer-specific meta data parameters.
 seating_plan                          integer                    If reserved seating is in use, the ID of a seating
@@ -54,43 +59,21 @@ seat_category_mapping                 object                     An object mappi
 last_modified                         datetime                   Last modification of this object
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.7
+.. versionchanged:: 4.15
 
-   The ``meta_data`` field has been added.
+    The ``search`` query parameter has been added to filter sub-events by their name or location in any language.
 
-.. versionchanged:: 2.1
+.. versionchanged:: 5.0
 
-   The ``event`` field has been added, together with filters on the list of dates and an organizer-level list.
-
-.. versionchanged:: 2.6
-   The write operations ``POST``, ``PATCH``, ``PUT``, and ``DELETE`` have been added.
-
-.. versionchanged:: 2.7
-
-   The attribute ``is_public`` has been added.
-
-.. versionchanged:: 3.0
-
-   The attributes ``seating_plan`` and ``seat_category_mapping`` have been added.
-
-.. versionchanged:: 3.3
-
-   The attributes ``geo_lat`` and ``geo_lon`` have been added.
-
-.. versionchanged:: 3.10
-
-   The ``disabled`` attribute has been added to ``item_price_overrides`` and ``variation_price_overrides``.
-
-.. versionchanged:: 3.12
-
-   The ``last_modified`` attribute has been added.
+    The ``date_from_before``, ``date_from_after``, ``date_to_before``, and ``date_to_after`` query parameters have been
+    added.
 
 Endpoints
 ---------
 
-.. versionchanged:: 3.3
+.. versionchanged:: 4.1
 
-    The sub-events resource can now be filtered by meta data attributes.
+    The ``with_availability_for`` parameter has been added.
 
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/subevents/
 
@@ -137,6 +120,8 @@ Endpoints
               {
                 "item": 2,
                 "disabled": false,
+                "available_from": null,
+                "available_until": null,
                 "price": "12.00"
               }
             ],
@@ -150,7 +135,12 @@ Endpoints
    :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.
+   :query date_from_after: If set to a date and time, only events that start at or after the given time are returned.
+   :query date_from_before: If set to a date and time, only events that start at or before the given time are returned.
+   :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.
    :param organizer: The ``slug`` field of a valid organizer
    :param event: The ``slug`` field of the main event
    :query datetime modified_since: Only return objects that have changed since the given date. Be careful: This does not
@@ -160,6 +150,10 @@ Endpoints
         only those sub-events having set their ``Format`` meta data to ``Seminar``, ``?attr[Format]=`` only those, that
         have no value set. Please note that this filter will respect default values set on 
         organizer or event level.
+   :query with_availability_for: If set to a sales channel identifier, the response will contain a special ``best_availability_state``
+                                 attribute with values of 100 for "tickets available", values less than 100 for "tickets sold out or reserved",
+                                 and ``null`` for "status unknown". These values might be served from a cache. This parameter can make the response
+                                 slow.
    :statuscode 200: no error
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer does not exist **or** you have no permission to view it.
@@ -197,6 +191,8 @@ Endpoints
           {
             "item": 2,
             "disabled": false,
+            "available_from": null,
+            "available_until": null,
             "price": "12.00"
           }
         ],
@@ -232,6 +228,8 @@ Endpoints
           {
             "item": 2,
             "disabled": false,
+            "available_from": null,
+            "available_until": null,
             "price": "12.00"
           }
         ],
@@ -288,6 +286,8 @@ Endpoints
           {
             "item": 2,
             "disabled": false,
+            "available_from": null,
+            "available_until": null,
             "price": "12.00"
           }
         ],
@@ -325,6 +325,8 @@ Endpoints
           {
             "item": 2,
             "disabled": false,
+            "available_from": null,
+            "available_until": null,
             "price": "23.42"
           }
         ],
@@ -358,6 +360,8 @@ Endpoints
           {
             "item": 2,
             "disabled": false,
+            "available_from": null,
+            "available_until": null,
             "price": "23.42"
           }
         ],
@@ -447,6 +451,8 @@ Endpoints
               {
                 "item": 2,
                 "disabled": false,
+                "available_from": null,
+                "available_until": null,
                 "price": "12.00"
               }
             ],
@@ -461,7 +467,12 @@ Endpoints
    :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.
    :query is_past: If set to ``true`` (``false``), only events that are over are (not) returned.
+   :query date_from_after: If set to a date and time, only events that start at or after the given time are returned.
+   :query date_from_before: If set to a date and time, only events that start at or before the given time are returned.
+   :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 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
    :statuscode 200: no error

doc/api/resources/taxrules.rst

@@ -16,22 +16,30 @@ Field                                 Type                       Description
 ===================================== ========================== =======================================================
 id                                    integer                    Internal ID of the tax rule
 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
 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
+eu_reverse_charge                     boolean                    If ``true``, EU reverse charge rules are applied. Will
+                                                                 be ignored if custom rules are set.
 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
+                                                                 rules keep the gross price constant (default is ``false``)
+custom_rules                          object                     Dynamic rules specification. Each list element
+                                                                 corresponds to one rule that will be processed in order.
+                                                                 The current version of the schema in use can be found
+                                                                 `here`_.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.7
 
-   This resource has been added.
+.. versionchanged:: 4.6
 
-.. versionchanged:: 1.9
+    The ``internal_name`` and ``keep_gross_if_rate_changes`` attributes have been added.
 
-   The write operations ``POST``, ``PATCH``, ``PUT``, and ``DELETE`` have been added.
+.. versionchanged:: 2023.6
 
+    The ``custom_rules`` attribute has been added.
 
 Endpoints
 ---------
@@ -64,9 +72,12 @@ Endpoints
           {
             "id": 1,
             "name": {"en": "VAT"},
+            "internal_name": "VAT",
             "rate": "19.00",
             "price_includes_tax": true,
             "eu_reverse_charge": false,
+            "keep_gross_if_rate_changes": false,
+            "custom_rules": null,
             "home_country": "DE"
           }
         ]
@@ -102,9 +113,12 @@ Endpoints
       {
         "id": 1,
         "name": {"en": "VAT"},
+        "internal_name": "VAT",
         "rate": "19.00",
         "price_includes_tax": true,
         "eu_reverse_charge": false,
+        "keep_gross_if_rate_changes": false,
+        "custom_rules": null,
         "home_country": "DE"
       }
 
@@ -148,9 +162,12 @@ Endpoints
       {
         "id": 1,
         "name": {"en": "VAT"},
+        "internal_name": "VAT",
         "rate": "19.00",
         "price_includes_tax": true,
         "eu_reverse_charge": false,
+        "keep_gross_if_rate_changes": false,
+        "custom_rules": null,
         "home_country": "DE"
       }
 
@@ -193,9 +210,12 @@ Endpoints
       {
         "id": 1,
         "name": {"en": "VAT"},
+        "internal_name": "VAT",
         "rate": "20.00",
         "price_includes_tax": true,
         "eu_reverse_charge": false,
+        "keep_gross_if_rate_changes": false,
+        "custom_rules": null,
         "home_country": "DE"
       }
 
@@ -235,3 +255,5 @@ Endpoints
    :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 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

doc/api/resources/teams.rst

@@ -1,4 +1,4 @@
-.. spelling:: fullname
+.. spelling:word-list:: fullname checkin
 
 .. _`rest-teams`:
 
@@ -25,6 +25,8 @@ limit_events                          list                       List of event s
 can_create_events                     boolean
 can_change_teams                      boolean
 can_change_organizer_settings         boolean
+can_manage_customers                  boolean
+can_manage_reusable_media             boolean
 can_manage_gift_cards                 boolean
 can_change_event_settings             boolean
 can_change_items                      boolean
@@ -32,8 +34,13 @@ can_view_orders                       boolean
 can_change_orders                     boolean
 can_view_vouchers                     boolean
 can_change_vouchers                   boolean
+can_checkin_orders                    boolean
 ===================================== ========================== =======================================================
 
+.. versionchanged:: 4.18
+
+    The ``can_manage_reusable_media`` permission has been added.
+
 Team member resource
 --------------------
 

doc/api/resources/vouchers.rst

@@ -1,3 +1,5 @@
+.. _`rest-vouchers`:
+
 Vouchers
 ========
 
@@ -17,6 +19,8 @@ max_usages                            integer                    The maximum num
                                                                  redeemed (default: 1).
 redeemed                              integer                    The number of times this voucher already has been
                                                                  redeemed.
+min_usages                            integer                    The minimum number of times this voucher must be
+                                                                 redeemed on first usage (default: 1).
 valid_until                           datetime                   The voucher expiration date (or ``null``).
 block_quota                           boolean                    If ``true``, quota is blocked for this voucher.
 allow_ignore_quota                    boolean                    If ``true``, this voucher can be redeemed even if a
@@ -43,21 +47,11 @@ tag                                   string                     A string that i
 comment                               string                     An internal comment on the voucher
 subevent                              integer                    ID of the date inside an event series this voucher belongs to (or ``null``).
 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.
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 1.9
-
-   The write operations ``POST``, ``PATCH``, ``PUT``, and ``DELETE`` have been added.
-
-.. versionchanged:: 3.0
-
-   The attribute ``show_hidden_items`` has been added.
-
-.. versionchanged:: 3.4
-
-   The attribute ``seat`` has been added.
-
 Endpoints
 ---------
 
@@ -103,6 +97,9 @@ Endpoints
             "comment": "",
             "seat": null,
             "subevent": null,
+            "show_hidden_items": false,
+            "all_addons_included": false,
+            "all_bundles_included": false
           }
         ]
       }
@@ -169,7 +166,10 @@ Endpoints
         "tag": "testvoucher",
         "comment": "",
         "seat": null,
-        "subevent": null
+        "subevent": null,
+        "show_hidden_items": false,
+        "all_addons_included": false,
+        "all_bundles_included": false
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -206,7 +206,10 @@ Endpoints
         "quota": null,
         "tag": "testvoucher",
         "comment": "",
-        "subevent": null
+        "subevent": null,
+        "show_hidden_items": false,
+        "all_addons_included": false,
+        "all_bundles_included": false
       }
 
    **Example response**:
@@ -233,7 +236,10 @@ Endpoints
         "tag": "testvoucher",
         "comment": "",
         "seat": null,
-        "subevent": null
+        "subevent": null,
+        "show_hidden_items": false,
+        "all_addons_included": false,
+        "all_bundles_included": false
       }
 
    :param organizer: The ``slug`` field of the organizer to create a voucher for
@@ -272,7 +278,10 @@ Endpoints
           "quota": null,
           "tag": "testvoucher",
           "comment": "",
-          "subevent": null
+          "subevent": null,
+          "show_hidden_items": false,
+          "all_addons_included": false,
+          "all_bundles_included": false
         },
         {
           "code": "ASDKLJCYXCASDASD",
@@ -287,7 +296,10 @@ Endpoints
           "quota": null,
           "tag": "testvoucher",
           "comment": "",
-          "subevent": null
+          "subevent": null,
+          "show_hidden_items": false,
+          "all_addons_included": false,
+          "all_bundles_included": false
         },
 
    **Example response**:
@@ -361,7 +373,10 @@ Endpoints
         "tag": "testvoucher",
         "comment": "",
         "seat": null,
-        "subevent": null
+        "subevent": null,
+        "show_hidden_items": false,
+        "all_addons_included": false,
+        "all_bundles_included": false
       }
 
    :param organizer: The ``slug`` field of the organizer to modify

doc/api/resources/waitinglist.rst

@@ -13,7 +13,10 @@ Field                                 Type                       Description
 ===================================== ========================== =======================================================
 id                                    integer                    Internal ID of the waiting list entry
 created                               datetime                   Creation date of the waiting list entry
+name                                  string                     Name of the user on the waiting list (or ``null``)
+name_parts                            object of strings          Decomposition of name of the user (or ``null``)
 email                                 string                     Email address of the user on the waiting list
+phone                                 string                     Phone number of the user on the waiting list (or ``null``)
 voucher                               integer                    Internal ID of the voucher sent to this user. If
                                                                  this field is set, the user has been sent a voucher
                                                                  and is no longer waiting. If it is ``null``, the
@@ -27,12 +30,6 @@ subevent                              integer                    ID of the date
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 1.15
-
-   The write operations ``POST``, ``PATCH``, ``PUT``, and ``DELETE`` have been added as well as a method to send out
-   vouchers.
-
-
 Endpoints
 ---------
 

doc/api/resources/webhooks.rst

@@ -26,6 +26,7 @@ limit_events                          list of strings            If ``all_events
 action_types                          list of strings            A list of action type filters that limit the
                                                                  notifications sent to this webhook. See below for
                                                                  valid values
+comment                               string                     Internal comment on this webhook, default ``null``
 ===================================== ========================== =======================================================
 
 The following values for ``action_types`` are valid with pretix core:
@@ -36,12 +37,23 @@ The following values for ``action_types`` are valid with pretix core:
     * ``pretix.event.order.canceled``
     * ``pretix.event.order.reactivated``
     * ``pretix.event.order.expired``
+    * ``pretix.event.order.expirychanged``
     * ``pretix.event.order.modified``
     * ``pretix.event.order.contact.changed``
     * ``pretix.event.order.changed.*``
+    * ``pretix.event.order.refund.created``
     * ``pretix.event.order.refund.created.externally``
+    * ``pretix.event.order.refund.requested``
+    * ``pretix.event.order.refund.done``
+    * ``pretix.event.order.refund.canceled``
+    * ``pretix.event.order.refund.failed``
+    * ``pretix.event.order.payment.confirmed``
     * ``pretix.event.order.approved``
     * ``pretix.event.order.denied``
+    * ``pretix.event.orders.waitinglist.added``
+    * ``pretix.event.orders.waitinglist.changed``
+    * ``pretix.event.orders.waitinglist.deleted``
+    * ``pretix.event.orders.waitinglist.voucher_assigned``
     * ``pretix.event.checkin``
     * ``pretix.event.checkin.reverted``
     * ``pretix.event.added``
@@ -50,6 +62,11 @@ The following values for ``action_types`` are valid with pretix core:
     * ``pretix.subevent.added``
     * ``pretix.subevent.changed``
     * ``pretix.subevent.deleted``
+    * ``pretix.event.item.*``
+    * ``pretix.event.live.activated``
+    * ``pretix.event.live.deactivated``
+    * ``pretix.event.testmode.activated``
+    * ``pretix.event.testmode.deactivated``
 
 Installed plugins might register more valid values.
 
@@ -88,7 +105,8 @@ Endpoints
             "target_url": "https://httpstat.us/200",
             "all_events": false,
             "limit_events": ["democon"],
-            "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"]
+            "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"],
+            "comment": null
           }
         ]
       }
@@ -125,7 +143,8 @@ Endpoints
         "target_url": "https://httpstat.us/200",
         "all_events": false,
         "limit_events": ["democon"],
-        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"]
+        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"],
+        "comment": null
       }
 
    :param organizer: The ``slug`` field of the organizer to fetch
@@ -152,7 +171,8 @@ Endpoints
         "target_url": "https://httpstat.us/200",
         "all_events": false,
         "limit_events": ["democon"],
-        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"]
+        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"],
+        "comment": "Called for changes"
       }
 
    **Example response**:
@@ -169,7 +189,8 @@ Endpoints
         "target_url": "https://httpstat.us/200",
         "all_events": false,
         "limit_events": ["democon"],
-        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"]
+        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"],
+        "comment": "Called for changes"
       }
 
    :param organizer: The ``slug`` field of the organizer to create a webhook for
@@ -214,7 +235,8 @@ Endpoints
         "target_url": "https://httpstat.us/200",
         "all_events": false,
         "limit_events": ["democon"],
-        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"]
+        "action_types": ["pretix.event.order.modified", "pretix.event.order.changed.*"],
+        "comment": null
       }
 
    :param organizer: The ``slug`` field of the organizer to modify

doc/api/webhooks.rst

@@ -92,9 +92,10 @@ If any other status code is returned, we will assume you did not receive the cal
 or ``304 Not Modified`` response will be treated as a failure. pretix will not follow any ``301`` or ``302`` redirect
 headers and pretix will ignore all other information in your response headers or body.
 
-If we do not receive a status code in the range of ``200`` and ``299``, pretix will retry to deliver for up to three
-days with an exponential back off. Therefore, we recommend that you implement your endpoint in a way where calling it
-multiple times for the same event due to a perceived error does not do any harm.
+If we do not receive a status code in the range of ``200`` and ``299`` or do not receive any response within a 30 second
+time frame, pretix will retry to deliver for up to three days with an exponential back off. Therefore, we recommend that
+you implement your endpoint in a way where calling it multiple times for the same event due to a perceived error does
+not do any harm.
 
 There is only one exception: If status code ``410 Gone`` is returned, we will assume the
 endpoint does not exist any more and automatically disable the webhook.

doc/conf.py

@@ -13,10 +13,6 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-from docutils.parsers.rst.directives.admonitions import BaseAdmonition
-from sphinx.util import compat
-compat.make_admonition = BaseAdmonition  # See https://github.com/spinus/sphinxcontrib-images/issues/41
-
 import sys
 import os
 
@@ -28,12 +24,13 @@ from datetime import date
 sys.path.insert(0, os.path.abspath('../src'))
 
 import django
+
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "pretix.testutils.settings")
 django.setup()
 
-
 try:
-    import enchant
+    import enchant  # noqa
+
     HAS_PYENCHANT = True
 except:
     HAS_PYENCHANT = False
@@ -41,7 +38,7 @@ except:
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -52,6 +49,7 @@ extensions = [
     'sphinx.ext.coverage',
     'sphinxcontrib.httpdomain',
     'sphinxcontrib.images',
+    'sphinxcontrib.jquery',
     'sphinxemoji.sphinxemoji',
 ]
 if HAS_PYENCHANT:
@@ -64,7 +62,7 @@ templates_path = ['_templates']
 source_suffix = '.rst'
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
 master_doc = 'index'
@@ -79,19 +77,20 @@ copyright = '2014-{}, Raphael Michel'.format(date.today().year)
 #
 # The short X.Y version.
 from pretix import __version__
+
 version = '.'.join(__version__.split('.')[:2])
 # The full version, including alpha/beta/rc tags.
 release = __version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -99,34 +98,34 @@ exclude_patterns = ['_build']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 # If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
+# keep_warnings = False
 
 
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#html_theme = ""
+# html_theme = ""
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -136,14 +135,14 @@ html_theme_options = {
 }
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
@@ -152,7 +151,7 @@ html_logo = 'images/logo-white.svg'
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -166,18 +165,18 @@ html_static_path = [
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
-#html_extra_path = []
+# html_extra_path = []
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
@@ -192,24 +191,24 @@ html_domain_indices = False
 html_use_index = False
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
 html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'pretixdoc'
@@ -217,47 +216,46 @@ htmlhelp_basename = 'pretixdoc'
 html_theme = 'pretix_theme'
 html_theme_path = [os.path.abspath('_themes')]
 
-
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
+    # The paper size ('letterpaper' or 'a4paper').
     'papersize': 'a4paper',
 
-# The font size ('10pt', '11pt' or '12pt').
+    # The font size ('10pt', '11pt' or '12pt').
     'pointsize': '10pt',
 
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (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 Documentation',
+     'Raphael Michel', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output ---------------------------------------
@@ -270,7 +268,7 @@ man_pages = [
 ]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -279,22 +277,22 @@ 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.',
-   'Miscellaneous'),
+    ('index', 'pretix', 'pretix Documentation',
+     'Raphael Michel', 'pretix', 'One line description of project.',
+     'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
+# texinfo_no_detailmenu = False
 
 
 images_config = {
@@ -314,12 +312,13 @@ if HAS_PYENCHANT:
     # String specifying a file containing a list of words known to be spelled
     # correctly but that do not appear in the language dictionary selected by
     # spelling_lang. The file should contain one word per line.
-    spelling_word_list_filename='spelling_wordlist.txt'
+    spelling_word_list_filename = 'spelling_wordlist.txt'
 
     # Boolean controlling whether suggestions for misspelled words are printed.
     # Defaults to False.
-    spelling_show_suggestions=True
+    spelling_show_suggestions = True
 
     # List of filter classes to be added to the tokenizer that produces words to be checked.
     from checkin_filter import CheckinFilter
-    spelling_filters=[CheckinFilter]
+
+    spelling_filters = [CheckinFilter]

doc/contents.rst

@@ -9,4 +9,5 @@ Table of contents
    api/index
    development/index
    plugins/index
+   license/faq
 

doc/development/algorithms/checkin.rst

@@ -0,0 +1,28 @@
+.. spelling: libpretixsync
+
+Check-in algorithms
+===================
+
+When a ticket is scanned at the entrance or exit of an event, we follow a series of steps to determine whether
+the check-in is allowed or not. To understand some of the terms in the following diagrams, you should also check
+out the documentation of the :ref:`ticket redemption API endpoint <rest-checkin-redeem>`.
+
+Server-side
+-----------
+
+The following diagram shows the series of checks executed on the server when a ticket is redeemed through the API.
+Some simplifications have been made, for example the deduplication mechanism based on the ``nonce`` parameter
+to prevent re-uploads of the same scan is not shown.
+
+.. image:: /images/checkin_online.png
+
+Client-side
+-----------
+
+The process of verifying tickets offline is a little different. There are two different approaches,
+depending on whether we have information about all tickets in the local database. The following diagram shows
+the algorithm as currently implemented in recent versions of `libpretixsync`_.
+
+.. image:: /images/checkin_offline.png
+
+.. _libpretixsync: https://github.com/pretix/libpretixsync

doc/development/algorithms/index.rst

@@ -0,0 +1,14 @@
+Algorithms
+==========
+
+The business logic inside pretix is full of complex algorithms making decisions based on all the hundreds of settings
+and input parameters available. Some of them are documented here as graphs, either because fully understanding them is very important
+when working on features close to them, or because they also need to be re-implemented by client-side components like our
+ticket scanning apps and we want to ensure the implementations are as similar as possible to avoid confusion.
+
+.. toctree::
+   :maxdepth: 2
+
+   pricing
+   checkin
+   layouts

doc/development/algorithms/layouts.rst

@@ -0,0 +1,15 @@
+.. spelling: pretixPOS
+
+Ticket layout
+=============
+
+When a ticket is exported to PDF, the system needs to decide which of multiple PDF layouts to use. The
+following diagram shows the steps of the decision, showing both the implementation in pretix itself as
+well as the implementation in `pretixPOS`_.
+
+The process can be influenced by plugins, which is demonstrated with the example of the shipping plugin.
+
+.. image:: /images/ticket_layouts.png
+
+
+.. _pretixPOS: https://pretix.eu/about/en/pos

doc/development/algorithms/pricing.rst

@@ -0,0 +1,180 @@
+.. _`algorithms-pricing`:
+
+Pricing algorithms
+==================
+
+With pretix being an e-commerce application, one of its core tasks is to determine the price of a purchase. With the
+complexity allowed by our range of features, this is not a trivial task and there are many edge cases that need to be
+clearly defined. The most challenging part about this is that there are many situations in which a price might change
+while the user is going through the checkout process and we're learning more information about them or their purchase.
+For example, prices change when
+
+* The cart expires and the listed prices changed in the meantime
+* The user adds an invoice address that triggers a change in taxation
+* The user chooses a custom price for an add-on product and adjusts the price later on
+* The user adds a voucher to their cart
+* An automatic discount is applied
+
+For the purposes of this page, we're making a distinction between "naive prices" (which are just a plain number like 23.00), and
+"taxed prices" (which are a combination of a net price, a tax rate, and a gross price, like 19.33 + 19% = 23.00).
+
+Computation of listed prices
+----------------------------
+
+When showing a list of products, e.g. on the event front page, we always need to show a price. This price is what we
+call the "listed price" later on.
+
+To compute the listed price, we first use the ``default_price`` attribute of the ``Item`` that is being shown.
+If we are showing an ``ItemVariation`` and that variation has a ``default_price`` set on itself, the variation's price
+takes precedence and replaces the item's price.
+If we're in an event series and there exists a ``SubEventItem`` or ``SubEventItemVariation`` with a price set, the
+subevent's price configuration takes precedence over both the item as well as the variation and replaces the listed price.
+
+Listed prices are naive prices. Before we actually show them to the user, we need to check if ``TaxRule.price_includes_tax``
+is set to determine if we need to add tax or subtract tax to get to the taxed price. We then consider the event's
+``display_net_prices`` setting to figure out which way to present the taxed price in the interface.
+
+Guarantees on listed prices
+---------------------------
+
+One goal of all further logic is that if a user sees a listed price, they are guaranteed to get the product at that
+price as long as they complete their purchase within the cart expiration time frame. For example, if the cart expiration
+time is set to 30 minutes and someone puts a item listed at €23 in their cart at 4pm, they can still complete checkout
+at €23 until 4.30pm, even if the organizer decides to raise the price to €25 at 4.10pm. If they complete checkout after
+4.30pm, their cart will be adjusted to the new price and the user will see a warning that the price has changed.
+
+Computation of cart prices
+--------------------------
+
+Input
+"""""
+
+To ensure the guarantee mentioned above, even in the light of all possible dynamic changes, the ``listed_price``
+is explicitly stored in the ``CartPosition`` model after the item has been added to the cart.
+
+If ``Item.free_price`` is set, the user is allowed to voluntarily increase the price. In this case, the user's input
+is stored as ``custom_price_input`` without much further validation for use further down below in the process.
+If ``display_net_prices`` is set, the user's input is also considered to be a net price and ``custom_price_input_is_net``
+is stored for the cart position. In any other case, the user's input is considered to be a gross price based on the tax
+rules' default tax rate.
+
+The computation of prices in the cart always starts from the ``listed_price``. The ``list_price`` is only computed
+when adding the product to the cart or when extending the cart's lifetime after it expired. All other steps such as
+creating an order based on the cart trust ``list_price`` without further checks.
+
+Vouchers
+""""""""
+
+As a first step, the cart is checked for any voucher that should be applied to the position. If such a voucher exists,
+it's discount (percentage or fixed) is applied to the listed price. The result of this is stored to ``price_after_voucher``.
+Since ``listed_price`` naive, ``price_after_voucher`` is naive as well. As a consequence, if you have a voucher configured
+to "set the price to €10", it depends on ``TaxRule.price_includes_tax`` again whether this is €10 including or excluding
+taxes.
+
+The ``price_after_voucher`` is only computed when adding the product to the cart or when extending the cart's
+lifetime after it expired. It is also checked again when the order is created, since the available discount might have
+changed due to the voucher's budget being (almost) exhausted.
+
+Line price
+""""""""""
+
+The next step computes the final price of this position if it is the only position in the cart. This happens in "reverse
+order", i.e. before the computation can be performed for a cart position, the step needs to be performed on all of its
+bundled positions. The sum of ``price_after_voucher`` of all bundled positions is now called ``bundled_sum``.
+
+First, the value from ``price_after_voucher`` will be processed by the applicable ``TaxRule.tax()`` (which is complex
+in itself but is not documented here in detail at the moment).
+
+If ``custom_price_input`` is not set, ``bundled_sum`` will be subtracted from the gross price and the net price is
+adjusted accordingly. The result is stored as ``tax_rate`` and ``line_price_gross`` in the cart position.
+
+If ``custom_price_input`` is set, the value will be compared to either the gross or the net value of the ``tax()``
+result, depending on ``custom_price_input_is_net``. If the comparison yields that the custom price is higher, ``tax()``
+will be called again . Then, ``bundled_sum`` will be subtracted from the gross price and the result is stored like
+above.
+
+The computation of ``line_price_gross`` from ``price_after_voucher``, ``custom_price_input``, and tax settings
+is repeated after every change of anything in the cart or after every change of the invoice address.
+
+Discounts
+---------
+
+After ``line_price_gross`` has been computed for all positions, the discount engine will run to apply any automatic
+discounts. Organizers can add rules for automatic discounts in the pretix backend. These rules are ordered and
+will be applied in order. Every cart position can only be "used" by one discount rule. "Used" can either mean that
+the price of the position was actually discounted, but it can also mean that the position was required to enable
+a discount for a different position, e.g. in case of a "buy 3 for the price of 2" offer.
+
+The algorithm for applying an individual discount rule first starts with eliminating all products that do not match
+the rule based on its product scope. Then, the algorithm is handled differently for different configurations.
+
+Case 1: Discount based on minimum value without respect to subevents
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+* Check whether the gross sum of all positions is at least ``condition_min_value``, otherwise abort.
+
+* Reduce the price of all positions by ``benefit_discount_matching_percent``.
+
+* Mark all positions as "used" to hide them from further rules
+
+Case 2: Discount based on minimum number of tickets without respect to subevents
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+* Check whether the number of all positions is at least ``condition_min_count``, otherwise abort.
+
+* If ``benefit_only_apply_to_cheapest_n_maches`` is set,
+
+    * Sort all positions by price.
+    * Reduce the price of the first ``n_positions // condition_min_count * benefit_only_apply_to_cheapest_n_matches`` positions by ``benefit_discount_matching_percent``.
+    * Mark the first ``n_positions // condition_min_count * condition_min_count`` as "used" to hide them from further rules.
+    * Mark all positions as "used" to hide them from further rules.
+
+* Else,
+
+    * Reduce the price of all positions by ``benefit_discount_matching_percent``.
+    * Mark all positions as "used" to hide them from further rules.
+
+Case 3: Discount only for products of the same subevent
+"""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+* Split the cart into groups based on the subevent.
+
+* Proceed with case 1 or 2 for every group.
+
+Case 4: Discount only for products of distinct subevents
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+* Let ``subevents`` be a list of distinct subevents in the cart.
+
+* Let ``positions[subevent]`` be a list of positions for every subevent.
+
+* Let ``current_group`` be the current group and ``groups`` the list of all groups.
+
+* Repeat
+
+    * Order ``subevents`` by the length of their ``positions[subevent]`` list, starting with the longest list.
+      Do not count positions that are part of ``current_group`` already.
+
+    * Let ``candidates`` be the concatenation of all ``positions[subevent]`` lists with the same length as the
+      longest list.
+
+    * If ``candidates`` is empty, abort the repetition.
+
+    * Order ``candidates`` by their price, starting with the lowest price.
+
+    * Pick one entry from ``candidates`` and put it into ``current_group``. If ``current_group`` is shorter than
+      ``benefit_only_apply_to_cheapest_n_matches``, we pick from the start (lowest price), otherwise we pick from
+      the end (highest price)
+
+    * If ``current_group`` is now ``condition_min_count``, remove all entries from ``current_group`` from
+      ``positions[…]``, add ``current_group`` to ``groups``, and reset ``current_group`` to an empty group.
+
+* For every position still left in a ``positions[…]`` list, try if there is any ``group`` in groups that it can
+  still be added to without violating the rule of distinct subevents
+
+* For every group in ``groups``, proceed with case 1 or 2.
+
+Flowchart
+---------
+
+.. image:: /images/cart_pricing.png

doc/development/api/auth.rst

@@ -20,20 +20,31 @@ Basically, three pre-defined flows are supported:
 * Authentication mechanisms that rely on **redirection**, e.g. to an OAuth provider. These can be implemented by
   supplying a ``authentication_url`` method and implementing a custom return view.
 
-Authentication backends are *not* collected through a signal. Instead, they must explicitly be set through the
-``auth_backends`` directive in the ``pretix.cfg`` :ref:`configuration file <config>`.
+For security reasons, authentication backends are *not* automatically discovered through a signal. Instead, they must
+explicitly be set through the ``auth_backends`` directive in the ``pretix.cfg`` :ref:`configuration file <config>`.
 
-In each of these methods (``form_authenticate``, ``request_authenticate`` or your custom view) you are supposed to
-either get an existing :py:class:`pretix.base.models.User` object from the database or create a new one. There are a
-few rules you need to follow:
+In each of these methods (``form_authenticate``, ``request_authenticate``, or your custom view) you are supposed to
+use ``User.objects.get_or_create_for_backend`` to get a :py:class:`pretix.base.models.User` object from the database
+or create a new one.
 
-* You **MUST** only return users with the ``auth_backend`` attribute set to the ``identifier`` value of your backend.
+There are a few rules you need to follow:
 
-* You **MUST** create new users with the ``auth_backend`` attribute set to the ``identifier`` value of your backend.
+* You **MUST** have some kind of identifier for a user that is globally unique and **SHOULD** never change, even if the
+  user's name or email address changes. This could e.g. be the ID of the user in an external database. The identifier
+  must not be longer than 190 characters. If you worry your backend might generated longer identifiers, consider
+  using a hash function to trim them to a constant length.
+
+* You **SHOULD** not allow users created by other authentication backends to log in through your code, and you **MUST**
+  only create, modify or return users with ``auth_backend`` set to your backend.
 
 * Every user object **MUST** have an email address. Email addresses are globally unique. If the email address is
   already registered to a user who signs in through a different backend, you **SHOULD** refuse the login.
 
+``User.objects.get_or_create_for_backend`` will follow these rules for you automatically. It works like this:
+
+.. autoclass:: pretix.base.models.auth.UserManager
+   :members: get_or_create_for_backend
+
 The backend interface
 ---------------------
 
@@ -59,6 +70,7 @@ The backend interface
 
    .. automethod:: authentication_url
 
+
 Logging users in
 ----------------
 
@@ -68,3 +80,45 @@ recommend that you use the following utility method to correctly set session val
 authentication (if activated):
 
 .. autofunction:: pretix.control.views.auth.process_login
+
+A custom view that is called after a redirect from an external identity provider could look like this::
+
+   from django.contrib import messages
+   from django.shortcuts import redirect
+   from django.urls import reverse
+
+   from pretix.base.models import User
+   from pretix.base.models.auth import EmailAddressTakenError
+   from pretix.control.views.auth import process_login
+
+
+   def return_view(request):
+       # Verify validity of login with the external provider's API
+       api_response = my_verify_login_function(
+           code=request.GET.get('code')
+       )
+
+       try:
+           u = User.objects.get_or_create_for_backend(
+               'my_backend_name',
+               api_response['userid'],
+               api_response['email'],
+               set_always={
+                   'fullname': '{} {}'.format(
+                       api_response.get('given_name', ''),
+                       api_response.get('family_name', ''),
+                   ),
+               },
+               set_on_creation={
+                   'locale': api_response.get('locale').lower()[:2],
+                   'timezone': api_response.get('zoneinfo', 'UTC'),
+               }
+           )
+       except EmailAddressTakenError:
+           messages.error(
+               request, _('We cannot create your user account as a user account in this system '
+                          'already exists with the same email address.')
+           )
+           return redirect(reverse('control:auth.login'))
+       else:
+           return process_login(request, u, keep_logged_in=False)

doc/development/api/cookieconsent.rst

@@ -0,0 +1,119 @@
+.. highlight:: python
+   :linenothreshold: 5
+
+.. _`cookieconsent`:
+
+Handling cookie consent
+=======================
+
+pretix includes an optional feature to handle cookie consent explicitly to comply with EU regulations.
+If your plugin sets non-essential cookies or includes a third-party service that does so, you should
+integrate with this feature.
+
+Server-side integration
+-----------------------
+
+First, you need to declare that you are using non-essential cookies by responding to the following
+signal:
+
+.. automodule:: pretix.presale.signals
+   :members: register_cookie_providers
+
+You are expected to return a list of ``CookieProvider`` objects instantiated from the following class:
+
+.. class:: pretix.presale.cookies.CookieProvider
+
+   .. py:attribute:: CookieProvider.identifier
+
+      A short and unique identifier used to distinguish this cookie provider form others (required).
+
+   .. py:attribute:: CookieProvider.provider_name
+
+      A human-readable name of the entity of feature responsible for setting the cookie (required).
+
+   .. py:attribute:: CookieProvider.usage_classes
+
+      A list of enum values from the ``pretix.presale.cookies.UsageClass`` enumeration class, such as
+      ``UsageClass.ANALYTICS``, ``UsageClass.MARKETING``, or ``UsageClass.SOCIAL`` (required).
+
+   .. py:attribute:: CookieProvider.privacy_url
+
+      A link to a privacy policy (optional).
+
+Here is an example of such a receiver:
+
+.. code-block:: python
+
+   @receiver(register_cookie_providers)
+   def recv_cookie_providers(sender, request, **kwargs):
+       return [
+           CookieProvider(
+               identifier='google_analytics',
+               provider_name='Google Analytics',
+               usage_classes=[UsageClass.ANALYTICS],
+           )
+       ]
+
+JavaScript-side integration
+---------------------------
+
+The server-side integration only causes the cookie provider to show up in the cookie dialog. You still
+need to care about actually enforcing the consent state.
+
+You can access the consent state through the ``window.pretix.cookie_consent`` variable. Whenever the
+value changes, a ``pretix:cookie-consent:change`` event is fired on the ``document`` object.
+
+The variable will generally have one of the following states:
+
+.. rst-class:: rest-resource-table
+
+================================================================ =====================================================
+State                                                            Interpretation
+================================================================ =====================================================
+``pretix === undefined || pretix.cookie_consent === undefined``  Your JavaScript has loaded before the cookie consent
+                                                                 script. Wait for the event to be fired, then try again,
+                                                                 do not yet set a cookie.
+``pretix.cookie_consent === null``                               The cookie consent mechanism has not been enabled. This
+                                                                 usually means that you can set cookies however you like.
+``pretix.cookie_consent[identifier] === undefined``              The cookie consent mechanism is loaded, but has no data
+                                                                 on your cookie yet, wait for the event to be fired, do not
+                                                                 yet set a cookie.
+``pretix.cookie_consent[identifier] === true``                   The user has consented to your cookie.
+``pretix.cookie_consent[identifier] === false``                  The user has actively rejected your cookie.
+================================================================ =====================================================
+
+If you are integrating e.g. a tracking provider with native cookie consent support such
+as Facebook's Pixel, you can integrate it like this:
+
+.. code-block:: javascript
+
+     var consent = (window.pretix || {}).cookie_consent;
+     if (consent !== null && !(consent || {}).facebook) {
+         fbq('consent', 'revoke');
+     }
+     fbq('init', ...);
+     document.addEventListener('pretix:cookie-consent:change', function (e) {
+         fbq('consent', (e.detail || {}).facebook ? 'grant' : 'revoke');
+     })
+
+If you have a JavaScript function that you only want to load if consent for a specific ``identifier``
+is given, you can wrap it like this:
+
+.. code-block:: javascript
+
+     var consent_identifier = "youridentifier";
+     var consent = (window.pretix || {}).cookie_consent;
+     if (consent === null || (consent || {})[consent_identifier] === true) {
+         // Cookie consent tool is either disabled or consent is given
+         addScriptElement(src);
+         return;
+     }
+
+     // Either cookie consent tool has not loaded yet or consent is not given
+     document.addEventListener('pretix:cookie-consent:change', function onChange(e) {
+         var consent = e.detail || {};
+         if (consent === null || consent[consent_identifier] === true) {
+             addScriptElement(src);
+             document.removeEventListener('pretix:cookie-consent:change', onChange);
+         }
+     })

doc/development/api/customview.rst

@@ -14,15 +14,17 @@ Control panel views
 -------------------
 
 If you want to add a custom view to the control area of an event, just register an URL in your
-``urls.py`` that lives in the ``/control/`` subpath::
+``urls.py`` that lives in the ``/control/`` subpath:
 
-    from django.conf.urls import url
+.. code-block:: python
+
+    from django.urls import re_path
 
     from . import views
 
     urlpatterns = [
-        url(r'^control/event/(?P<organizer>[^/]+)/(?P<event>[^/]+)/mypluginname/',
-            views.admin_view, name='backend'),
+        re_path(r'^control/event/(?P<organizer>[^/]+)/(?P<event>[^/]+)/mypluginname/',
+                views.admin_view, name='backend'),
     ]
 
 It is required that your URL parameters are called ``organizer`` and ``event``. If you want to
@@ -44,7 +46,9 @@ If only the ``organizer`` parameter is present, it will be ensured that:
 * The user has permission to access view the current organizer
 
 If you want to require specific permission types, we provide you with a decorator or a mixin for
-your views::
+your views:
+
+.. code-block:: python
 
     from pretix.control.permissions import (
         event_permission_required, EventPermissionRequiredMixin
@@ -61,8 +65,9 @@ your views::
         ...
 
 Similarly, there is ``organizer_permission_required`` and ``OrganizerPermissionRequiredMixin``. In case of
-event-related views, there is also a signal that allows you to add the view to the event navigation like this::
+event-related views, there is also a signal that allows you to add the view to the event navigation like this:
 
+.. code-block:: python
 
     from django.urls import resolve, reverse
     from django.dispatch import receiver
@@ -90,7 +95,9 @@ Event settings view
 -------------------
 
 A special case of a control panel view is a view hooked into the event settings page. For this case, there is a
-special navigation signal::
+special navigation signal:
+
+.. code-block:: python
 
     @receiver(nav_event_settings, dispatch_uid='friends_tickets_nav_settings')
     def navbar_settings(sender, request, **kwargs):
@@ -105,7 +112,9 @@ special navigation signal::
         }]
 
 Also, your view should inherit from ``EventSettingsViewMixin`` and your template from ``pretixcontrol/event/settings_base.html``
-for good integration. If you just want to display a form, you could do it like the following::
+for good integration. If you just want to display a form, you could do it like the following:
+
+.. code-block:: python
 
     class MySettingsView(EventSettingsViewMixin, EventSettingsFormView):
         model = Event
@@ -147,7 +156,9 @@ Including a custom view into the participant-facing frontend is a little bit dif
 no path prefix like ``control/``.
 
 First, define your URL in your ``urls.py``, but this time in the ``event_patterns`` section and wrapped by
-``event_url``::
+``event_url``:
+
+.. code-block:: python
 
     from pretix.multidomain import event_url
 
@@ -182,8 +193,9 @@ standard Django request handling: There are `ViewSets`_ to group related views i
 automatically build URL configurations from them.
 
 To integrate a custom viewset with pretix' REST API, you can just register with one of our routers within the
-``urls.py`` module of your plugin::
+``urls.py`` module of your plugin:
 
+.. code-block:: python
 
     from pretix.api.urls import event_router, router, orga_router
 
@@ -200,7 +212,9 @@ in the control panel. However, you need to make sure on your own only to return
 .event`` and ``request.organizer`` are available as usual.
 
 To require a special permission like ``can_view_orders``, you do not need to inherit from a special ViewSet base
-class, you can just set the ``permission`` attribute on your viewset::
+class, you can just set the ``permission`` attribute on your viewset:
+
+.. code-block:: python
 
     class MyViewSet(ModelViewSet):
         permission = 'can_view_orders'
@@ -208,8 +222,9 @@ class, you can just set the ``permission`` attribute on your viewset::
 
 If you want to check the permission only for some methods of your viewset, you have to do it yourself. Note here that
 API authentications can be done via user sessions or API tokens and you should therefore check something like the
-following::
+following:
 
+.. code-block:: python
 
     perm_holder = (request.auth if isinstance(request.auth, TeamAPIToken) else request.user)
     if perm_holder.has_event_permission(request.event.organizer, request.event, 'can_view_orders'):

doc/development/api/email.rst

@@ -15,7 +15,9 @@ Output registration
 The email HTML renderer API does not make a lot of usage from signals, however, it
 does use a signal to get a list of all available email renderers. Your plugin
 should listen for this signal and return the subclass of ``pretix.base.email.BaseHTMLMailRenderer``
-that we'll provide in this plugin::
+that we'll provide in this plugin:
+
+.. code-block:: python
 
     from django.dispatch import receiver
 
@@ -72,7 +74,9 @@ class ``TemplateBasedMailRenderer`` that you can re-use to perform the following
 * Call `inlinestyler`_ to convert all ``<style>`` style sheets to inline ``style=""``
   attributes for better compatibility
 
-To use it, you just need to implement some variables::
+To use it, you just need to implement some variables:
+
+.. code-block:: python
 
     class ClassicMailRenderer(TemplateBasedMailRenderer):
         verbose_name = _('pretix default')

doc/development/api/exporter.rst

@@ -17,7 +17,9 @@ Exporter registration
 The exporter API does not make a lot of usage from signals, however, it does use a signal to get a list of
 all available exporters. Your plugin should listen for this signal and return the subclass of
 ``pretix.base.exporter.BaseExporter``
-that we'll provide in this plugin::
+that we'll provide in this plugin:
+
+.. code-block:: python
 
     from django.dispatch import receiver
 
@@ -31,7 +33,9 @@ that we'll provide in this plugin::
 
 Some exporters might also prove to be useful, when provided on an organizer-level. In order to declare your
 exporter as capable of providing exports spanning multiple events, your plugin should listen for this signal
-and return the subclass of ``pretix.base.exporter.BaseExporter`` that we'll provide in this plugin::
+and return the subclass of ``pretix.base.exporter.BaseExporter`` that we'll provide in this plugin:
+
+.. code-block:: python
 
     from django.dispatch import receiver
 
@@ -56,7 +60,13 @@ The exporter class
    .. py:attribute:: BaseExporter.event
 
       The default constructor sets this property to the event we are currently
-      working for.
+      working for. This will be ``None`` if the exporter is run for multiple
+      events.
+
+   .. py:attribute:: BaseExporter.events
+
+      The default constructor sets this property to the list of events to work
+      on, regardless of whether the exporter is called for one or multiple events.
 
    .. autoattribute:: identifier
 
@@ -66,6 +76,10 @@ The exporter class
 
       This is an abstract attribute, you **must** override this!
 
+   .. autoattribute:: description
+
+   .. autoattribute:: category
+
    .. autoattribute:: export_form_fields
 
    .. automethod:: render

doc/development/api/general.rst

@@ -13,7 +13,7 @@ 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
+      register_ticket_secret_generators, gift_card_transaction_display
 
 Order events
 """"""""""""
@@ -21,7 +21,7 @@ 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_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
+   :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
 
 Check-ins
 """""""""
@@ -34,7 +34,7 @@ Frontend
 --------
 
 .. automodule:: pretix.presale.signals
-   :members: html_head, html_footer, 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, 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
 
 
 .. automodule:: pretix.presale.signals
@@ -61,7 +61,7 @@ Backend
              item_formsets, order_search_filter_q, order_search_forms
 
 .. automodule:: pretix.base.signals
-   :members: logentry_display, logentry_object_link, requiredaction_display, timeline_events
+   :members: logentry_display, logentry_object_link, requiredaction_display, timeline_events, orderposition_blocked_display
 
 Vouchers
 """"""""
@@ -79,7 +79,7 @@ Ticket designs
 """"""""""""""
 
 .. automodule:: pretix.base.signals
-   :members: layout_text_variables
+   :members: layout_text_variables, layout_image_variables
 
 .. automodule:: pretix.plugins.ticketoutputpdf.signals
    :members: override_layout

doc/development/api/index.rst

@@ -17,6 +17,7 @@ Contents:
    shredder
    import
    customview
+   cookieconsent
    auth
    general
    quality