Silence ResponseError from redis

Co-authored-by: Richard Schreiber <wiffbi@gmail.com>

.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.md

@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Please only create issues for bug reports. Feature requests or general questions
+  should start as a "Discussion" on GitHub.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+<!-- Please only create issues for bug reports. Feature requests or general questions should start as a "Discussion" on GitHub. -->
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/dependabot.yml

@@ -0,0 +1,15 @@
+# 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: "/src"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "npm"
+    directory: "/src/pretix/static/npm_dir"
+    schedule:
+      interval: "monthly"

.github/workflows/docs.yml

@@ -33,7 +33,8 @@ jobs:
       - name: Install system packages
         run: sudo apt update && sudo apt install enchant 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

@@ -31,7 +31,8 @@ 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]"
+        working-directory: ./src
       - name: Compile messages
         run: python manage.py compilemessages
         working-directory: ./src
@@ -56,7 +57,8 @@ jobs:
       - name: Install system packages
         run: sudo apt update && sudo apt install enchant 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]"
+        working-directory: ./src
       - name: Spellcheck translations
         run: potypo
         working-directory: ./src

.github/workflows/style.yml

@@ -29,7 +29,8 @@ 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]" mysqlclient psycopg2-binary
+        working-directory: ./src
       - name: Run isort
         run: isort -c .
         working-directory: ./src
@@ -49,7 +50,25 @@ 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]" mysqlclient psycopg2-binary
+        working-directory: ./src
       - name: Run flake8
         run: flake8 .
         working-directory: ./src
+  licenseheader:
+    name: licenseheaders
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.8
+      - 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

@@ -18,17 +18,17 @@ jobs:
     name: Tests
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8]
+        python-version: ["3.7", "3.8", "3.9"]
         database: [sqlite, postgres, mysql]
         exclude:
           - database: mysql
-            python-version: 3.7
-          - database: sqlite
-            python-version: 3.7
+            python-version: "3.8"
           - database: mysql
-            python-version: 3.6
+            python-version: "3.9"
           - database: sqlite
-            python-version: 3.6
+            python-version: "3.7"
+          - database: sqlite
+            python-version: "3.8"
     steps:
       - uses: actions/checkout@v2
       - uses: getong/mariadb-action@v1.1
@@ -55,12 +55,16 @@ 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 mariadb-client-10.3
       - 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 -e ".[dev]" mysqlclient psycopg2-binary
+        working-directory: ./src
       - 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

.gitlab-ci.yml

@@ -5,8 +5,8 @@ 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
         - cd src
+        - XDG_CACHE_HOME=/cache pip3 install -e ".[dev]"
         - python manage.py check
         - make all compress
         - py.test --reruns 3 -n 3 tests
@@ -21,13 +21,14 @@ 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
         - check-manifest
+        - make npminstall
         - python setup.py sdist bdist_wheel
         - twine check dist/*
         - twine upload dist/*

.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/>.

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,9 @@
-FROM python:3.8
+FROM python:3.9-bullseye
 
 RUN apt-get update && \
     apt-get install -y --no-install-recommends \
             build-essential \
-            default-libmysqlclient-dev \
+            libmariadb-dev \
             gettext \
             git \
             libffi-dev \
@@ -15,8 +15,7 @@ RUN apt-get update && \
             libxslt1-dev \
             locales \
             nginx \
-            python-dev \
-            python-virtualenv \
+            python3-virtualenv \
             python3-dev \
             sudo \
             supervisor \
@@ -31,23 +30,24 @@ 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_15.x | sudo -E bash - && \
+    apt-get install -y nodejs && \
+    curl -qL https://www.npmjs.com/install.sh | sh
+
 
 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
+COPY src/setup.py /pretix/src/setup.py
 RUN pip3 install -U \
         pip \
         setuptools \
         wheel && \
     cd /pretix/src && \
-    pip3 install \
-        -r requirements.txt \
-        -r requirements/memcached.txt \
-        -r requirements/mysql.txt \
+    PRETIX_DOCKER_BUILD=TRUE pip3 install \
+        -e ".[memcached,mysql]" \
         gunicorn django-extensions ipython && \
     rm -rf ~/.cache/pip
 
@@ -56,10 +56,11 @@ 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 src /pretix/src
 
-RUN cd /pretix/src && pip3 install .
+RUN cd /pretix/src && python setup.py install
 
 RUN chmod +x /usr/local/bin/pretix && \
     rm /etc/nginx/sites-enabled/default && \

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

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,8 @@
 file=/tmp/supervisor.sock
 
 [supervisord]
-logfile=/tmp/supervisord.log
-logfile_maxbytes=50MB
-logfile_backups=10
+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

@@ -157,7 +157,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/admin/config.rst

@@ -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``.
 
@@ -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;sentinal_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;sentinal_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,21 @@ 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

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,9 @@ This documentation is for everyone who wants to install pretix on a server.
    :maxdepth: 2
 
    installation/index
+   updates
    config
    maintainance
    scaling
+   errors
    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
+        ON public.pretixbase_order (event_id, datetime);
     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
+        ON public.pretixbase_logentry (event_id, datetime);
+    CREATE INDEX CONCURRENTLY pretix_addidx_logentry_event_cid_date
+        ON public.pretixbase_logentry (event_id, content_type_id, datetime);
 
 
 Also, if you use our ``pretix-shipping`` plugin::

doc/admin/installation/docker_smallscale.rst

@@ -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`_ 9.6+, `MySQL`_ 5.7+, or MariaDB 10.2.7+ 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
 -------------
@@ -57,8 +58,16 @@ directory writable to the user that runs pretix inside the docker container::
 Database
 --------
 
+.. warning:: **Please use PostgreSQL for all new installations**. If you need to go for MySQL, make sure you run
+             **MySQL 5.7 or newer** or **MariaDB 10.2.7 or newer**.
+
 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
@@ -82,6 +91,8 @@ When using MySQL, make sure you set the character set of the database to ``utf8m
 
     mysql > CREATE DATABASE pretix DEFAULT CHARACTER SET utf8mb4 DEFAULT COLLATE utf8mb4_unicode_ci;
 
+You will also need to make sure that ``sql_mode`` in your ``my.cnf`` file does **not** include ``ONLY_FULL_GROUP_BY``.
+
 Redis
 -----
 
@@ -97,6 +108,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
@@ -178,7 +201,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 \
@@ -228,7 +251,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 +270,8 @@ create an event and start selling tickets!
 
 You should probably read :ref:`maintainance` next.
 
+.. _`docker_updates`:
+
 Updates
 -------
 
@@ -262,6 +287,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

doc/admin/installation/manual_smallscale.rst

@@ -23,8 +23,9 @@ installation guides):
 
 * 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`_ 9.6+, `MySQL`_ 5.7+, or MariaDB 10.2.7+ 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 +34,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
 ---------
 
@@ -49,8 +47,16 @@ In this guide, all code lines prepended with a ``#`` symbol are commands that yo
 Database
 --------
 
+.. warning:: **Please use PostgreSQL for all new installations**. If you need to go for MySQL, make sure you run
+             **MySQL 5.7 or newer** or **MariaDB 10.2.7 or newer**.
+
 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
@@ -59,6 +65,8 @@ When using MySQL, make sure you set the character set of the database to ``utf8m
 
     mysql > CREATE DATABASE pretix DEFAULT CHARACTER SET utf8mb4 DEFAULT COLLATE utf8mb4_unicode_ci;
 
+You will also need to make sure that ``sql_mode`` in your ``my.cnf`` file does **not** include ``ONLY_FULL_GROUP_BY``.
+
 Package dependencies
 --------------------
 
@@ -66,7 +74,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 libmariadb-dev libjpeg-dev libopenjp2-7-dev
 
 Config file
 -----------
@@ -128,12 +136,15 @@ 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``.
+If you're running MySQL, also install the client library::
+
+    (venv)$ pip3 install mysqlclient
+
+Note that you need Python 3.7 or newer. You can find out your Python version using ``python -V``.
 
 We also need to create a data directory::
 
@@ -228,7 +239,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 +261,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 +282,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`:
 
@@ -312,3 +325,4 @@ example::
 .. _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,6 +9,8 @@ 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
 -------
 
@@ -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/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

@@ -99,7 +99,8 @@ following endpoint:
        "hardware_brand": "Samsung",
        "hardware_model": "Galaxy S",
        "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.

doc/api/fundamentals.rst

@@ -43,6 +43,8 @@ Possible permissions are:
 * Can view vouchers
 * Can change vouchers
 
+.. _`rest-compat`:
+
 Compatibility
 -------------
 
@@ -58,6 +60,7 @@ 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
+* 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 +90,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 +187,9 @@ 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).
 ===================== ============================ ===================================
 
 Query parameters
@@ -210,13 +217,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 +237,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/resources/carts.rst

@@ -42,10 +42,6 @@ seat                                  objects                    The assigned se
 └ seat_guid                           string                     Identifier of the seat within the seating plan
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.17
-
-   This resource has been added.
-
 .. versionchanged:: 3.0
 
    This ``seat`` attribute has been added.
@@ -176,8 +172,6 @@ Cart position endpoints
 
        * 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
@@ -193,8 +187,9 @@ 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)
    * ``answers``
 
       * ``question``
@@ -247,6 +242,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/checkinlists.rst

@@ -36,22 +36,6 @@ rules                                 object                     Custom check-in
 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.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.10
-
-   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``,
@@ -65,13 +49,13 @@ exit_all_at                           datetime                   Automatically c
 
     The ``exit_all_at`` attribute has been added.
 
+.. versionchanged:: 3.17
+
+    The ``ends_after`` and ``expand`` query parameters have 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.
@@ -120,6 +104,8 @@ 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.
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
@@ -376,33 +362,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``, 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
@@ -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
           }
         ],
@@ -600,12 +604,14 @@ Order position endpoints
    :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.
 
+.. _`rest-checkin-redeem`:
+
 .. http:post:: /api/v1/organizers/(organizer)/events/(event)/checkinlists/(list)/positions/(id)/redeem/
 
    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.
 
    :<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**
@@ -614,8 +620,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
@@ -733,6 +740,9 @@ Order position endpoints
    * ``product`` - Tickets with this product may not be scanned at this device
    * ``rules`` - Check-in prevented by a user-defined rule
 
+   In case of reason ``rules``, 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
    :param list: The ID of the check-in list to look for

doc/api/resources/customers.rst

@@ -0,0 +1,247 @@
+.. _`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``)
+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``)
+===================================== ========================== =======================================================
+
+.. versionadded:: 4.0
+
+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
+
+   **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"
+      }
+
+   **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``,
+   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/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

@@ -52,31 +52,6 @@ sales_channels                        list                       A list of sales
 ===================================== ========================== =======================================================
 
 
-.. 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.
@@ -105,6 +80,16 @@ Endpoints
 
     The events resource can now be filtered by meta data attributes.
 
+.. versionchanged:: 4.0
+
+    The ``clone_from`` parameter has been added to the event creation endpoint.
+
+.. versionchanged:: 4.1
+
+    The ``with_availability_for`` parameter has been added.
+
+    The ``search`` query parameter has been added to filter events by their slug, name, or location in any language.
+
 .. http:get:: /api/v1/organizers/(organizer)/events/
 
    Returns a list of all events within a given organizer the authenticated user/token has access to.
@@ -183,6 +168,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
@@ -346,6 +336,9 @@ Endpoints
       }
 
    :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 +353,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"
 

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
 
@@ -19,8 +24,12 @@ Resources and endpoints
    orders
    invoices
    vouchers
+   discounts
    checkinlists
    waitinglist
+   customers
+   membershiptypes
+   memberships
    giftcards
    carts
    teams
@@ -28,5 +37,6 @@ Resources and endpoints
    webhooks
    seatingplans
    exporters
+   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
@@ -30,6 +46,52 @@ footer_text                           string                     Text to be prin
 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,28 +108,28 @@ internal_reference                    string                     Customer's refe
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 1.6
-
-   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.
-
-
-.. versionchanged:: 1.7
-
-   The attributes ``lines.tax_name``, ``foreign_currency_display``, ``foreign_currency_rate``, and
-   ``foreign_currency_rate_date`` have been added.
-
-
-.. versionchanged:: 1.9
-
-   The attribute ``internal_reference`` has been added.
-
-
 .. versionchanged:: 3.4
 
    The attribute ``lines.number`` has been added.
 
+.. versionchanged:: 3.17
+
+   The attribute ``invoice_to_*``, ``invoice_from_*``, ``custom_field``, ``lines.item``, ``lines.variation``, ``lines.event_date_from``,
+   ``lines.event_date_to``, and ``lines.attendee_name`` have been added.
+   ``refers`` now returns an invoice number including the prefix.
+
+.. versionchanged:: 4.1
+
+   The attributes ``fee_type`` and ``fee_internal_type`` have been added.
+
+.. versionchanged:: 4.1
+
+   The attribute ``lines.event_location`` has been added.
+
+.. versionchanged:: 4.6
+
+   The attribute ``lines.subevent`` has been added.
+
 
 Endpoints
 ---------
@@ -101,8 +163,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",
@@ -115,6 +193,15 @@ Endpoints
               {
                 "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 +253,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",
@@ -180,6 +283,15 @@ Endpoints
           {
             "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_variations.rst

@@ -24,16 +24,27 @@ 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
+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.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 2.7
-
-   The attribute ``original_price`` has been added.
-
-.. versionchanged:: 1.12
-
-   This resource has been added.
-
 Endpoints
 ---------
 
@@ -68,6 +79,14 @@ Endpoints
               "en": "S"
             },
             "active": true,
+            "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"
             },
@@ -82,6 +101,10 @@ Endpoints
               "en": "L"
             },
             "active": true,
+            "require_approval": false,
+            "require_membership": false,
+            "require_membership_hidden": false,
+            "require_membership_types": [],
             "description": {},
             "position": 1,
             "default_price": null,
@@ -129,6 +152,14 @@ Endpoints
         "price": "10.00",
         "original_price": null,
         "active": true,
+        "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
       }
@@ -158,6 +189,14 @@ Endpoints
         "value": {"en": "Student"},
         "default_price": "10.00",
         "active": true,
+        "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
       }
@@ -177,6 +216,14 @@ Endpoints
         "price": "10.00",
         "original_price": null,
         "active": true,
+        "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
       }
@@ -227,6 +274,14 @@ Endpoints
         "price": "10.00",
         "original_price": null,
         "active": 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
       }

doc/api/resources/items.rst

@@ -36,8 +36,8 @@ admission                             boolean                    ``true`` for it
                                                                  (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``).
+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
@@ -69,6 +69,18 @@ require_approval                      boolean                    If ``true``, or
                                                                  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.
 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
@@ -94,7 +106,23 @@ variations                            list of objects            A list with one
                                                                  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
+├ 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.
 └ 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,
@@ -118,44 +146,6 @@ bundles                               list of objects            Definition of b
 meta_data                             object                     Values set for event-specific meta data parameters.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 2.7
-
-   The attribute ``original_price`` has been added for ``variations``.
-
-.. versionchanged:: 1.7
-
-   The attribute ``tax_rule`` has been added. ``tax_rate`` is kept for compatibility. The attribute
-   ``checkin_attention`` has been added.
-
-.. versionchanged:: 1.12
-
-   The write operations ``POST``, ``PATCH``, ``PUT``, and ``DELETE`` have been added.
-   The attribute ``price_included`` has been added to ``addons``.
-
-.. versionchanged:: 1.16
-
-   The ``internal_name`` and ``original_price`` fields have been added.
-
-.. versionchanged:: 2.0
-
-   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.
@@ -164,6 +154,15 @@ meta_data                             object                     Values set for
 
    The attribute ``multi_allowed`` has been added to ``addons``.
 
+.. versionchanged:: 4.0
+
+   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:: 4.4
+
+   The attributes ``require_membership_hidden`` attribute has been added.
+
 Notes
 -----
 
@@ -236,6 +235,12 @@ 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,
             "variations": [
               {
                  "value": {"en": "Student"},
@@ -243,6 +248,12 @@ Endpoints
                  "price": "10.00",
                  "original_price": null,
                  "active": true,
+                 "require_membership": false,
+                 "require_membership_types": [],
+                 "sales_channels": ["web"],
+                 "available_from": null,
+                 "available_until": null,
+                 "hide_without_voucher": false,
                  "description": null,
                  "position": 0
               },
@@ -252,6 +263,12 @@ Endpoints
                  "price": "23.00",
                  "original_price": null,
                  "active": true,
+                 "require_membership": false,
+                 "require_membership_types": [],
+                 "sales_channels": ["web"],
+                 "available_from": null,
+                 "available_until": null,
+                 "hide_without_voucher": false,
                  "description": null,
                  "position": 1
               }
@@ -332,6 +349,12 @@ 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,
         "variations": [
           {
              "value": {"en": "Student"},
@@ -339,7 +362,13 @@ Endpoints
              "price": "10.00",
              "original_price": null,
              "active": true,
+             "require_membership": false,
+             "require_membership_types": [],
              "description": null,
+             "sales_channels": ["web"],
+             "available_from": null,
+             "available_until": null,
+             "hide_without_voucher": false,
              "position": 0
           },
           {
@@ -348,6 +377,12 @@ Endpoints
              "price": "23.00",
              "original_price": null,
              "active": true,
+             "require_membership": false,
+             "require_membership_types": [],
+             "sales_channels": ["web"],
+             "available_from": null,
+             "available_until": null,
+             "hide_without_voucher": false,
              "description": null,
              "position": 1
           }
@@ -408,6 +443,12 @@ 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,
         "variations": [
           {
              "value": {"en": "Student"},
@@ -415,6 +456,12 @@ Endpoints
              "price": "10.00",
              "original_price": null,
              "active": true,
+             "require_membership": false,
+             "require_membership_types": [],
+             "sales_channels": ["web"],
+             "available_from": null,
+             "available_until": null,
+             "hide_without_voucher": false,
              "description": null,
              "position": 0
           },
@@ -424,6 +471,12 @@ Endpoints
              "price": "23.00",
              "original_price": null,
              "active": true,
+             "require_membership": false,
+             "require_membership_types": [],
+             "sales_channels": ["web"],
+             "available_from": null,
+             "available_until": null,
+             "hide_without_voucher": false,
              "description": null,
              "position": 1
           }
@@ -473,6 +526,12 @@ 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,
         "variations": [
           {
              "value": {"en": "Student"},
@@ -480,6 +539,12 @@ Endpoints
              "price": "10.00",
              "original_price": null,
              "active": true,
+             "require_membership": false,
+             "require_membership_types": [],
+             "sales_channels": ["web"],
+             "available_from": null,
+             "available_until": null,
+             "hide_without_voucher": false,
              "description": null,
              "position": 0
           },
@@ -489,6 +554,12 @@ Endpoints
              "price": "23.00",
              "original_price": null,
              "active": true,
+             "require_membership": false,
+             "require_membership_types": [],
+             "sales_channels": ["web"],
+             "available_from": null,
+             "available_until": null,
+             "hide_without_voucher": false,
              "description": null,
              "position": 1
           }
@@ -569,6 +640,12 @@ 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,
         "variations": [
           {
              "value": {"en": "Student"},
@@ -576,6 +653,12 @@ Endpoints
              "price": "10.00",
              "original_price": null,
              "active": true,
+             "require_membership": false,
+             "require_membership_types": [],
+             "sales_channels": ["web"],
+             "available_from": null,
+             "available_until": null,
+             "hide_without_voucher": false,
              "description": null,
              "position": 0
           },
@@ -585,6 +668,12 @@ Endpoints
              "price": "23.00",
              "original_price": null,
              "active": true,
+             "require_membership": false,
+             "require_membership_types": [],
+             "sales_channels": ["web"],
+             "available_from": null,
+             "available_until": null,
+             "hide_without_voucher": false,
              "description": null,
              "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/orders.rst

@@ -31,6 +31,7 @@ testmode                              boolean                    If ``true``, th
 secret                                string                     The secret contained in the link sent to the customer
 email                                 string                     The customer email address
 phone                                 string                     The customer phone number
+customer                              string                     The customer account identifier (or ``null``)
 locale                                string                     The locale used for communication with this customer
 sales_channel                         string                     Channel this sale was created through, such as
                                                                  ``"web"``.
@@ -40,6 +41,7 @@ payment_date                          date                       **DEPRECATED AN
 payment_provider                      string                     **DEPRECATED AND INACCURATE** Payment provider used for this order
 total                                 money (string)             Total value of this order
 comment                               string                     Internal comment on this order
+custom_followup_at                    date                       Internal date for a custom follow-up action
 checkin_attention                     boolean                    If ``true``, the check-in app should show a warning
                                                                  that this ticket requires special attention if a ticket
                                                                  of this order is scanned.
@@ -66,6 +68,7 @@ positions                             list of objects            List of order p
                                                                  non-canceled positions are included.
 fees                                  list of objects            List of fees included in the order total. By default, only
                                                                  non-canceled fees are included.
+├ id                                  integer                    Internal ID of the fee record
 ├ fee_type                            string                     Type of fee (currently ``payment``, ``passbook``,
                                                                  ``other``)
 ├ value                               money (string)             Fee amount
@@ -94,60 +97,6 @@ last_modified                         datetime                   Last modificati
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 1.6
-
-   The ``invoice_address.country`` attribute contains a two-letter country code for all new orders. For old orders,
-   a custom text might still be returned.
-
-.. versionchanged:: 1.7
-
-   The attributes ``invoice_address.vat_id_validated`` and ``invoice_address.is_business`` have been added.
-   The attributes ``order.payment_fee``, ``order.payment_fee_tax_rate`` and ``order.payment_fee_tax_value`` have been
-   deprecated in favor of the new ``fees`` attribute but will still be served and removed in 1.9.
-
-.. versionchanged:: 1.9
-
-   First write operations (``…/mark_paid/``, ``…/mark_pending/``, ``…/mark_canceled/``, ``…/mark_expired/``) have been added.
-   The attribute ``invoice_address.internal_reference`` has been added.
-
-.. versionchanged:: 1.13
-
-   The field ``checkin_attention`` has been added.
-
-.. versionchanged:: 1.15
-
-   The attributes ``order.payment_fee``, ``order.payment_fee_tax_rate``, ``order.payment_fee_tax_value`` and
-   ``order.payment_fee_tax_rule`` have finally been removed.
-
-.. versionchanged:: 1.16
-
-   The attributes ``order.last_modified`` as well as the corresponding filters to the resource have been added.
-   An endpoint for order creation as well as ``…/mark_refunded/`` has been added.
-
-.. versionchanged:: 2.0
-
-   The ``order.payment_date`` and ``order.payment_provider`` attributes have been deprecated in favor of the new
-   nested ``payments`` and ``refunds`` resources, but will still be served and removed in 2.2. The ``require_approval``
-   attribute has been added, as have been the ``…/approve/`` and ``…/deny/`` endpoints.
-
-.. versionchanged:: 2.3
-
-   The ``sales_channel`` attribute has been added.
-
-.. versionchanged:: 2.4
-
-   ``order.status`` can no longer be ``r``, ``…/mark_canceled/`` now accepts a ``cancellation_fee`` parameter and
-   ``…/mark_refunded/`` has been deprecated.
-
-.. versionchanged:: 2.5
-
-   The ``testmode`` attribute has been added and ``DELETE`` has been implemented for orders.
-
-.. versionchanged:: 3.1
-
-   The ``invoice_address.state`` and ``url`` attributes have been added. When creating orders through the API,
-   vouchers are now supported and many fields are now optional.
-
 .. versionchanged:: 3.5
 
    The ``order.fees.canceled`` attribute has been added.
@@ -172,6 +121,26 @@ last_modified                         datetime                   Last modificati
 
    The ``phone`` attribute has been added.
 
+.. versionchanged:: 4.0
+
+   The ``customer`` attribute has been added.
+
+.. versionchanged:: 4.1
+
+   The ``custom_followup_at`` attribute has been added.
+
+.. versionchanged:: 4.4
+
+   The ``item`` and ``variation`` query parameters have been added.
+
+.. versionchanged:: 4.6
+
+   The ``subevent`` query parameters has been added.
+
+.. versionchanged:: 4.8
+
+   The ``order.fees.id`` attribute has been added.
+
 
 .. _order-position-resource:
 
@@ -209,18 +178,20 @@ secret                                string                     Secret code pri
 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``).
 pseudonymization_id                   string                     A random ID, e.g. for use in lead scanning apps
-checkins                              list of objects            List of check-ins with this ticket
+checkins                              list of objects            List of **successful** check-ins with this ticket
 ├ id                                  integer                    Internal ID of the check-in event
 ├ list                                integer                    Internal ID of the check-in list
 ├ datetime                            datetime                   Time of check-in
 ├ type                                string                     Type of scan (defaults to ``entry``)
+├ gate                                integer                    Internal ID of the gate. Can be ``null``.
+├ device                              integer                    Internal ID of the device. Can be ``null``.
 └ auto_checked_in                     boolean                    Indicates if this check-in been performed automatically by the system
 downloads                             list of objects            List of ticket download options
 ├ output                              string                     Ticket output provider (e.g. ``pdf``, ``passbook``)
 └ url                                 string                     Download URL
 answers                               list of objects            Answers to user-defined questions
 ├ question                            integer                    Internal ID of the answered question
-├ answer                              string                     Text representation of the answer
+├ answer                              string                     Text representation of the answer (URL if answer is a file)
 ├ 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
@@ -233,30 +204,6 @@ pdf_data                              object                     Data object req
                                                                  ``pdf_data=true`` query parameter to your request.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.7
-
-   The attribute ``tax_rule`` has been added.
-
-.. versionchanged:: 1.11
-
-   The attribute ``checkins.list`` has been added.
-
-.. versionchanged:: 1.14
-
-  The attributes ``answers.question_identifier`` and ``answers.option_identifiers`` have been added.
-
-.. versionchanged:: 1.16
-
-  The attributes ``pseudonymization_id`` and ``pdf_data`` have been added.
-
-.. versionchanged:: 3.0
-
-  The attribute ``seat`` has been added.
-
-.. versionchanged:: 3.2
-
-  The value ``auto_checked_in`` has been added to the ``checkins``-attribute.
-
 .. versionchanged:: 3.3
 
   The ``url`` of a ticket ``download`` can now also return a ``text/uri-list`` instead of a file. See
@@ -274,6 +221,10 @@ pdf_data                              object                     Data object req
 
   The ``checkin.type`` attribute has been added.
 
+.. versionchanged:: 3.16
+
+   Answers to file questions are now returned as an URL.
+
 .. _order-payment-resource:
 
 Order payment resource
@@ -302,14 +253,6 @@ details                               object                     Payment-specifi
                                                                  the object is empty.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 2.0
-
-  This resource has been added.
-
-.. versionchanged:: 3.1
-
-  The attributes ``payment_url`` and ``details`` have been added.
-
 .. _order-refund-resource:
 
 Order refund resource
@@ -325,21 +268,14 @@ state                                 string                     Payment state,
 source                                string                     How this refund has been created, one of ``buyer``, ``admin``, or ``external``
 amount                                money (string)             Payment amount
 created                               datetime                   Date and time of creation of this payment
-payment_date                          datetime                   Date and time of completion of this payment (or ``null``)
+comment                               string                     Reason for refund (shown to the customer in some cases, can be ``null``).
+execution_date                        datetime                   Date and time of completion of this refund (or ``null``)
 provider                              string                     Identification string of the payment provider
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 2.0
-
-  This resource has been added.
-
 List of all orders
 ------------------
 
-.. versionchanged:: 1.15
-
-   Filtering for emails or order codes is now case-insensitive.
-
 .. versionchanged:: 3.5
 
    The ``include_canceled_positions`` and ``include_canceled_fees`` query parameters have been added.
@@ -378,6 +314,7 @@ List of all orders
             "url": "https://test.pretix.eu/dummy/dummy/order/ABC12/k24fiuwvu8kxz3y1/",
             "email": "tester@example.org",
             "phone": "+491234567",
+            "customer": null,
             "locale": "en",
             "sales_channel": "web",
             "datetime": "2017-12-01T10:00:00Z",
@@ -388,6 +325,7 @@ List of all orders
             "fees": [],
             "total": "23.00",
             "comment": "",
+            "custom_followup_at": null,
             "checkin_attention": false,
             "require_approval": false,
             "invoice_address": {
@@ -438,6 +376,8 @@ List of all orders
                   {
                     "list": 44,
                     "type": "entry",
+                    "gate": null,
+                    "device": 2,
                     "datetime": "2017-12-25T12:45:23Z",
                     "auto_checked_in": false
                   }
@@ -488,6 +428,8 @@ List of all orders
    :query string code: Only return orders that match the given order code
    :query string status: Only return orders in the given order status (see above)
    :query string search: Only return orders matching a given search query
+   :query integer item: Only return orders with a position that contains this item ID. *Warning:* Result will also include orders if they contain mixed items, and it will even return orders where the item is only contained in a canceled position.
+   :query integer variation: Only return orders with a position that contains this variation ID. *Warning:* Result will also include orders if they contain mixed items and variations, and it will even return orders where the variation is only contained in a canceled position.
    :query boolean testmode: Only return orders with ``testmode`` set to ``true`` or ``false``
    :query boolean require_approval: If set to ``true`` or ``false``, only categories with this value for the field
                                     ``require_approval`` will be returned.
@@ -500,6 +442,7 @@ List of all orders
        recommend using this in combination with ``testmode=false``, since test mode orders can vanish at any time and
        you will not notice it using this method.
    :query datetime created_since: Only return orders that have been created since the given date.
+   :query integer subevent: Only return orders with a position that contains this subevent ID. *Warning:* Result will also include orders if they contain mixed subevents, and it will even return orders where the subevent is only contained in a canceled position.
    :query datetime subevent_after: Only return orders that contain a ticket for a subevent taking place after the given date. This is an exclusive after, and it considers the **end** of the subevent (or its start, if the end is not set).
    :query datetime subevent_before: Only return orders that contain a ticket for a subevent taking place after the given date. This is an exclusive before, and it considers the **start** of the subevent.
    :query string exclude: Exclude a field from the output, e.g. ``fees`` or ``positions.downloads``. Can be used as a performance optimization. Can be passed multiple times.
@@ -546,6 +489,7 @@ Fetching individual orders
         "url": "https://test.pretix.eu/dummy/dummy/order/ABC12/k24fiuwvu8kxz3y1/",
         "email": "tester@example.org",
         "phone": "+491234567",
+        "customer": null,
         "locale": "en",
         "sales_channel": "web",
         "datetime": "2017-12-01T10:00:00Z",
@@ -556,6 +500,7 @@ Fetching individual orders
         "fees": [],
         "total": "23.00",
         "comment": "",
+        "custom_followup_at": null,
         "checkin_attention": false,
         "require_approval": false,
         "invoice_address": {
@@ -606,6 +551,8 @@ Fetching individual orders
               {
                 "list": 44,
                 "type": "entry",
+                "gate": null,
+                "device": 2,
                 "datetime": "2017-12-25T12:45:23Z",
                 "auto_checked_in": false
               }
@@ -662,13 +609,17 @@ Fetching individual orders
 Order ticket download
 ---------------------
 
+.. versionchanged:: 4.10
+
+   The API now supports ticket downloads for pending orders if allowed by the event settings.
+
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/download/(output)/
 
    Download tickets for an order, identified by its order code. Depending on the chosen output, the response might
    be a ZIP file, PDF file or something else. The order details response contains a list of output options for this
    particular order.
 
-   Tickets can be only downloaded if the order is paid and if ticket downloads are active. Note that in some cases the
+   Tickets can only be downloaded if ticket downloads are active and – depending on event settings – the order is either paid or pending. Note that in some cases the
    ticket file might not yet have been created. In that case, you will receive a status code :http:statuscode:`409` and
    you are expected to retry the request after a short period of waiting.
 
@@ -720,6 +671,8 @@ Updating order fields
 
    * ``comment``
 
+   * ``custom_followup_at``
+
    * ``invoice_address`` (you always need to supply the full object, or ``null`` to delete the current address)
 
    **Example request**:
@@ -791,6 +744,37 @@ Generating new secrets
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to update this order.
 
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/regenerate_secrets/
+
+   Triggers generation of a new ``secret`` attribute for a single order position.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23/regenerate_secrets/ 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
+
+      (Full order position resource, see above.)
+
+   :param organizer: The ``slug`` field of the organizer of the event
+   :param event: The ``slug`` field of the event
+   :param code: The ``id`` field of the order position to update
+
+   :statuscode 200: no error
+   :statuscode 400: The order position could not be updated due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to update this order position.
+
 Deleting orders
 ---------------
 
@@ -864,6 +848,8 @@ Creating orders
 
        * does not support redeeming gift cards
 
+       * does not support or validate memberships
+
    You can supply the following fields of the resource:
 
    * ``code`` (optional)
@@ -872,6 +858,7 @@ Creating orders
      or in state ``confirmed``, depending on this value. If you create a paid order, the ``order_paid`` signal will
      **not** be sent out to plugins and no email will be sent. If you want that behavior, create an unpaid order and
      then call the ``mark_paid`` API method.
+   * ``customer`` (optional) – Customer identifier or ``null``
    * ``testmode`` (optional) – Defaults to ``false``
    * ``consume_carts`` (optional) – A list of cart IDs. All cart positions with these IDs will be deleted if the
      order creation is successful. Any quotas or seats that become free by this operation will be credited to your order
@@ -890,7 +877,9 @@ Creating orders
      charge will be created), this is just informative in case you *handled the payment already*.
    * ``payment_date`` (optional) – Date and time of the completion of the payment.
    * ``comment`` (optional)
+   * ``custom_followup_at`` (optional)
    * ``checkin_attention`` (optional)
+   * ``require_approval`` (optional)
    * ``invoice_address`` (optional)
 
       * ``company``
@@ -950,8 +939,9 @@ Creating orders
 
    * ``force`` (optional). If set to ``true``, quotas will be ignored.
    * ``send_email`` (optional). If set to ``true``, the same emails will be sent as for a regular order, regardless of
-     whether these emails are enabled for certain sales channels. Defaults to
-     ``false``. Used to be ``send_mail`` before pretix 3.14.
+     whether these emails are enabled for certain sales channels. If set to ``null``, behavior will be controlled by pretix'
+     settings based on the sales channels (added in pretix 4.7). Defaults to ``false``.
+     Used to be ``send_mail`` before pretix 3.14.
 
    If you want to use add-on products, you need to set the ``positionid`` fields of all positions manually
    to incrementing integers starting with ``1``. Then, you can reference one of these
@@ -1096,6 +1086,9 @@ Order state operations
    will instead stay paid, but all positions will be removed (or marked as canceled) and replaced by the cancellation
    fee as the only component of the order.
 
+   You can control whether the customer is notified through ``send_email`` (defaults to ``true``).
+   You can pass a ``comment`` that can be visible to the user if it is used in the email template.
+
    **Example request**:
 
    .. sourcecode:: http
@@ -1107,6 +1100,7 @@ Order state operations
 
       {
           "send_email": true,
+          "comment": "Event was canceled.",
           "cancellation_fee": null
       }
 
@@ -1445,21 +1439,6 @@ Sending e-mails
 List of all order positions
 ---------------------------
 
-.. 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.
-
-.. versionchanged:: 2.0
-
-   The order positions endpoint has been extended by the filter queries ``voucher``, ``voucher__code`` and
-   ``pseudonymization_id``.
-
-.. versionchanged:: 3.2
-
-  The value ``auto_checked_in`` has been added to the ``checkins``-attribute.
-
 .. versionchanged:: 3.5
 
    The ``include_canceled_positions`` and ``include_canceled_fees`` query parameters have been added.
@@ -1515,6 +1494,8 @@ List of all order positions
               {
                 "list": 44,
                 "type": "entry",
+                "gate": null,
+                "device": 2,
                 "datetime": "2017-12-25T12:45:23Z",
                 "auto_checked_in": false
               }
@@ -1621,6 +1602,8 @@ Fetching individual positions
           {
             "list": 44,
             "type": "entry",
+            "gate": null,
+            "device": 2,
             "datetime": "2017-12-25T12:45:23Z",
             "auto_checked_in": false
           }
@@ -1656,6 +1639,10 @@ Fetching individual positions
 Order position ticket download
 ------------------------------
 
+.. versionchanged:: 4.10
+
+   The API now supports ticket downloads for pending orders if allowed by the event settings.
+
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/download/(output)/
 
    Download tickets for one order position, identified by its internal ID.
@@ -1667,7 +1654,7 @@ Order position ticket download
    The referenced URL can provide a download or a regular, human-viewable website - so it is advised to open this URL
    in a webbrowser and leave it up to the user to handle the result.
 
-   Tickets can be only downloaded if the order is paid and if ticket downloads are active. Also, depending on event
+   Tickets can only be downloaded if ticket downloads are active and – depending on event settings – the order is either paid or pending. Also, depending on event
    configuration downloads might be only unavailable for add-on products or non-admission products.
    Note that in some cases the ticket file might not yet have been created. In that case, you will receive a status
    code :http:statuscode:`409` and you are expected to retry the request after a short period of waiting.
@@ -1703,12 +1690,170 @@ Order position ticket download
    :statuscode 409: The file is not yet ready and will now be prepared. Retry the request after waiting for a few
                     seconds.
 
+.. _rest-orderpositions-manipulate:
+
 Manipulating individual positions
 ---------------------------------
 
+.. versionchanged:: 3.15
+
+   The ``PATCH`` method has been added for individual positions.
+
+.. versionchanged:: 4.8
+
+   The ``PATCH`` method now supports changing items, variations, subevents, seats, prices, and tax rules.
+   The ``POST`` endpoint to add individual positions has been added.
+
+.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/
+
+   Updates specific fields on an order position. Currently, only the following fields are supported:
+
+   * ``attendee_email``
+
+   * ``attendee_name_parts`` or ``attendee_name``
+
+   * ``company``
+
+   * ``street``
+
+   * ``zipcode``
+
+   * ``city``
+
+   * ``country``
+
+   * ``state``
+
+   * ``answers``: If specified, you will need to provide **all** answers for this order position.
+     Validation is handled the same way as when creating orders through the API. You are therefore
+     expected to provide ``question``, ``answer``, and possibly ``options``. ``question_identifier``
+     and ``option_identifiers`` will be ignored. As a special case, you can submit the magic value
+     ``"file:keep"`` as the answer to a file question to keep the current value without re-uploading it.
+
+   * ``item``
+
+   * ``variation``
+
+   * ``subevent``
+
+   * ``seat`` (specified as a string mapping to a ``string_guid``)
+
+   * ``price``
+
+   * ``tax_rule``
+
+   Changing parameters such as ``item`` or ``price`` will **not** automatically trigger creation of a new invoice,
+   you need to take care of that yourself.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "attendee_email": "other@example.org"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      (Full order position resource, see above.)
+
+   :param organizer: The ``slug`` field of the organizer of the event
+   :param event: The ``slug`` field of the event
+   :param id: The ``id`` field of the order position to update
+
+   :statuscode 200: no error
+   :statuscode 400: The order could not be updated due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to update this order.
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/
+
+   Adds a new position to an order. Currently, only the following fields are supported:
+
+   * ``order`` (mandatory, specified as a string mapping to a ``code``)
+
+   * ``addon_to`` (optional, specified as an integer mapping to the ``positionid`` of the parent position)
+
+   * ``item`` (mandatory)
+
+   * ``variation`` (mandatory depending on item)
+
+   * ``subevent`` (mandatory depending on event)
+
+   * ``seat`` (specified as a string mapping to a ``string_guid``, mandatory depending on event and item)
+
+   * ``price`` (default price will be used if unset)
+
+   * ``attendee_email``
+
+   * ``attendee_name_parts`` or ``attendee_name``
+
+   * ``company``
+
+   * ``street``
+
+   * ``zipcode``
+
+   * ``city``
+
+   * ``country``
+
+   * ``state``
+
+   * ``answers``: Validation is handled the same way as when creating orders through the API. You are therefore
+     expected to provide ``question``, ``answer``, and possibly ``options``. ``question_identifier``
+     and ``option_identifiers`` will be ignored. As a special case, you can submit the magic value
+     ``"file:keep"`` as the answer to a file question to keep the current value without re-uploading it.
+
+   This will **not** automatically trigger creation of a new invoice, you need to take care of that yourself.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/orderpositions/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "order": "ABC12",
+        "item": 5,
+        "addon_to": 1
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      (Full order position resource, see above.)
+
+   :param organizer: The ``slug`` field of the organizer of the event
+   :param event: The ``slug`` field of the event
+
+   :statuscode 200: no error
+   :statuscode 400: The position 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 position.
+
 .. http:delete:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/
 
-   Deletes an order position, identified by its internal ID.
+   Cancels an order position, identified by its internal ID.
 
    **Example request**:
 
@@ -1734,14 +1879,132 @@ Manipulating individual positions
    :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.
 
+Changing order contents
+-----------------------
+
+While you can :ref:`change positions individually <rest-orderpositions-manipulate>` sometimes it is necessary to make
+multiple changes to an order at once within one transaction. This makes it possible to e.g. swap the seats of two
+attendees in an order without running into conflicts. This interface also offers some possibilities not available
+otherwise, such as splitting an order or changing fees.
+
+.. versionchanged:: 4.8
+
+   This endpoint has been added to the system.
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/change/
+
+   Performs a change operation on an order. You can supply the following fields:
+
+   * ``patch_positions``: A list of objects with the two keys ``position`` specifying an order position ID and
+     ``body`` specifying the desired changed values of the position (``item``, ``variation``, ``subevent``, ``seat``,
+     ``price``, ``tax_rule``).
+
+   * ``cancel_positions``: A list of objects with the single key ``position`` specifying an order position ID.
+
+   * ``split_positions``: A list of objects with the single key ``position`` specifying an order position ID.
+
+   * ``create_positions``: A list of objects describing new order positions with the same fields supported as when
+     creating them individually through the ``POST …/orderpositions/`` endpoint.
+
+   * ``patch_fees``: A list of objects with the two keys ``fee`` specifying an order fee ID and
+     ``body`` specifying the desired changed values of the position (``value``).
+
+   * ``cancel_fees``: A list of objects with the single key ``fee`` specifying an order fee ID.
+
+   * ``recalculate_taxes``: If set to ``"keep_net"``, all taxes will be recalculated based on the tax rule and invoice
+     address, the net price will be kept. If set to ``"keep_gross"``, the gross price will be kept. If set to ``null``
+     (the default) the taxes are not recalculated.
+
+   * ``send_email``: If set to ``true``, the customer will be notified about the change. Defaults to ``false``.
+
+   * ``reissue_invoice``: If set to ``true`` and an invoice exists for the order, it will be canceled and a new invoice
+     will be issued. Defaults to ``true``.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "cancel_positions": [
+          {
+            "position": 12373
+          }
+        ],
+        "patch_positions": [
+          {
+            "position": 12374,
+            "body": {
+              "item": 12,
+              "variation": None,
+              "subevent": 562,
+              "seat": "seat-guid-2",
+              "price": "99.99",
+              "tax_rule": 15
+            }
+          }
+        ],
+        "split_positions": [
+          {
+            "position": 12375
+          }
+        ],
+        "create_positions": [
+          {
+            "item": 12,
+            "variation": None,
+            "subevent": 562,
+            "seat": "seat-guid-2",
+            "price": "99.99",
+            "addon_to": 12374,
+            "attendee_name": "Peter",
+          }
+        ],
+        "cancel_fees": [
+          {
+            "fee": 49
+          }
+        ],
+        "change_fees": [
+          {
+            "fee": 51,
+            "body": {
+              "value": "12.00"
+            }
+          }
+        ],
+        "reissue_invoice": true,
+        "send_email": true,
+        "recalculate_taxes": "keep_gross"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      (Full order position resource, see above.)
+
+   :param organizer: The ``slug`` field of the organizer of the event
+   :param event: The ``slug`` field of the event
+   :param code: The ``code`` field of the order to update
+
+   :statuscode 200: no error
+   :statuscode 400: The order could not be updated due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to update this order.
+
 
 Order payment endpoints
 -----------------------
 
-.. versionchanged:: 2.0
-
-  These endpoints have been added.
-
 .. versionchanged:: 3.6
 
    Payments can now be created through the API.
@@ -2021,10 +2284,6 @@ Order payment endpoints
 Order refund endpoints
 ----------------------
 
-.. versionchanged:: 2.0
-
-  These endpoints have been added.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/refunds/
 
    Returns a list of all refunds for an order.
@@ -2058,6 +2317,7 @@ Order refund endpoints
             "payment": 1,
             "created": "2017-12-01T10:00:00Z",
             "execution_date": "2017-12-04T12:13:12Z",
+            "comment": "Cancellation",
             "provider": "banktransfer"
           }
         ]
@@ -2100,6 +2360,7 @@ Order refund endpoints
         "payment": 1,
         "created": "2017-12-01T10:00:00Z",
         "execution_date": "2017-12-04T12:13:12Z",
+        "comment": "Cancellation",
         "provider": "banktransfer"
       }
 
@@ -2134,6 +2395,7 @@ Order refund endpoints
         "amount": "23.00",
         "payment": 1,
         "execution_date": null,
+        "comment": "Cancellation",
         "provider": "manual",
         "mark_canceled": false,
         "mark_pending": true
@@ -2155,6 +2417,7 @@ Order refund endpoints
         "payment": 1,
         "created": "2017-12-01T10:00:00Z",
         "execution_date": null,
+        "comment": "Cancellation",
         "provider": "manual"
       }
 

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

@@ -62,6 +62,7 @@ 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
 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,28 +76,6 @@ 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.
@@ -105,6 +84,10 @@ dependency_value                      string                     An old version
 
   The attributes ``valid_*`` have been added.
 
+.. versionchanged:: 3.18
+
+  The attribute ``valid_file_portrait`` have been added.
+
 Endpoints
 ---------
 
@@ -156,6 +139,7 @@ Endpoints
             "valid_date_max": null,
             "valid_datetime_min": null,
             "valid_datetime_max": null,
+            "valid_file_portrait": false,
             "dependency_question": null,
             "dependency_value": null,
             "dependency_values": [],
@@ -233,6 +217,7 @@ Endpoints
         "valid_date_max": null,
         "valid_datetime_min": null,
         "valid_datetime_max": null,
+        "valid_file_portrait": false,
         "dependency_question": null,
         "dependency_value": null,
         "dependency_values": [],
@@ -333,6 +318,7 @@ Endpoints
         "valid_date_max": null,
         "valid_datetime_min": null,
         "valid_datetime_max": null,
+        "valid_file_portrait": false,
         "options": [
           {
             "id": 1,
@@ -414,6 +400,7 @@ Endpoints
         "valid_date_max": null,
         "valid_datetime_min": null,
         "valid_datetime_max": null,
+        "valid_file_portrait": false,
         "options": [
           {
             "id": 1,

doc/api/resources/quotas.rst

@@ -28,20 +28,22 @@ 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
-
-   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.
 
+.. versionchanged:: 4.1
+
+    The ``with_availability`` query parameter has been added.
+
 
 Endpoints
 ---------
@@ -88,6 +90,7 @@ Endpoints
    :query string ordering: Manually set the ordering of results. Valid fields to be used are ``id`` and ``position``.
                            Default: ``position``
    :query integer subevent: Only return quotas of the sub-event with the given ID
+   :query 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 +131,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/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/subevents.rst

@@ -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,25 +59,6 @@ seat_category_mapping                 object                     An object mappi
 last_modified                         datetime                   Last modification of this object
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.7
-
-   The ``meta_data`` field has been added.
-
-.. versionchanged:: 2.1
-
-   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.
@@ -85,6 +71,10 @@ last_modified                         datetime                   Last modificati
 
    The ``last_modified`` attribute has been added.
 
+.. versionchanged:: 3.18
+
+   The ``available_from``/``available_until`` attributes have been added to ``item_price_overrides`` and ``variation_price_overrides``.
+
 Endpoints
 ---------
 
@@ -92,6 +82,10 @@ Endpoints
 
     The sub-events resource can now be filtered by meta data attributes.
 
+.. versionchanged:: 4.1
+
+    The ``with_availability_for`` parameter has been added.
+
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/subevents/
 
    Returns a list of all sub-events of an event.
@@ -137,6 +131,8 @@ Endpoints
               {
                 "item": 2,
                 "disabled": false,
+                "available_from": null,
+                "available_until": null,
                 "price": "12.00"
               }
             ],
@@ -160,6 +156,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 +197,8 @@ Endpoints
           {
             "item": 2,
             "disabled": false,
+            "available_from": null,
+            "available_until": null,
             "price": "12.00"
           }
         ],
@@ -232,6 +234,8 @@ Endpoints
           {
             "item": 2,
             "disabled": false,
+            "available_from": null,
+            "available_until": null,
             "price": "12.00"
           }
         ],
@@ -288,6 +292,8 @@ Endpoints
           {
             "item": 2,
             "disabled": false,
+            "available_from": null,
+            "available_until": null,
             "price": "12.00"
           }
         ],
@@ -325,6 +331,8 @@ Endpoints
           {
             "item": 2,
             "disabled": false,
+            "available_from": null,
+            "available_until": null,
             "price": "23.42"
           }
         ],
@@ -358,6 +366,8 @@ Endpoints
           {
             "item": 2,
             "disabled": false,
+            "available_from": null,
+            "available_until": null,
             "price": "23.42"
           }
         ],
@@ -447,6 +457,8 @@ Endpoints
               {
                 "item": 2,
                 "disabled": false,
+                "available_from": null,
+                "available_until": null,
                 "price": "12.00"
               }
             ],

doc/api/resources/taxrules.rst

@@ -16,22 +16,21 @@ 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
 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``)
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.7
 
-   This resource has been added.
-
-.. versionchanged:: 1.9
-
-   The write operations ``POST``, ``PATCH``, ``PUT``, and ``DELETE`` have been added.
+.. versionchanged:: 4.6
 
+    The ``internal_name`` and ``keep_gross_if_rate_changes`` attributes have been added.
 
 Endpoints
 ---------
@@ -64,9 +63,11 @@ 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,
             "home_country": "DE"
           }
         ]
@@ -102,9 +103,11 @@ 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,
         "home_country": "DE"
       }
 
@@ -148,9 +151,11 @@ 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,
         "home_country": "DE"
       }
 
@@ -193,9 +198,11 @@ 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,
         "home_country": "DE"
       }
 

doc/api/resources/teams.rst

@@ -1,4 +1,4 @@
-.. spelling:: fullname
+.. spelling:: fullname checkin
 
 .. _`rest-teams`:
 
@@ -25,6 +25,7 @@ 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_gift_cards                 boolean
 can_change_event_settings             boolean
 can_change_items                      boolean
@@ -32,6 +33,7 @@ can_view_orders                       boolean
 can_change_orders                     boolean
 can_view_vouchers                     boolean
 can_change_vouchers                   boolean
+can_checkin_orders                    boolean
 ===================================== ========================== =======================================================
 
 Team member resource

doc/api/resources/vouchers.rst

@@ -1,3 +1,5 @@
+.. _`rest-vouchers`:
+
 Vouchers
 ========
 
@@ -46,14 +48,6 @@ show_hidden_items                     boolean                    Only if set to
 ===================================== ========================== =======================================================
 
 
-.. 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.

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

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/general.rst

@@ -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
@@ -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

doc/development/api/payment.rst

@@ -62,6 +62,8 @@ The provider class
 
    .. autoattribute:: public_name
 
+   .. autoattribute:: confirm_button_name
+
    .. autoattribute:: is_enabled
 
    .. autoattribute:: priority
@@ -106,14 +108,22 @@ The provider class
 
    .. automethod:: payment_control_render
 
+   .. automethod:: payment_control_render_short
+
    .. automethod:: payment_refund_supported
 
    .. automethod:: payment_partial_refund_supported
 
+   .. automethod:: payment_presale_render
+
    .. automethod:: execute_refund
 
    .. automethod:: refund_control_render
 
+   .. automethod:: new_refund_control_form_render
+
+   .. automethod:: new_refund_control_form_process
+
    .. automethod:: api_payment_details
 
    .. automethod:: matching_id

doc/development/api/plugins.rst

@@ -45,13 +45,17 @@ Attribute          Type                 Description
 name               string               The human-readable name of your plugin
 author             string               Your name
 version            string               A human-readable version code of your plugin
-description        string               A more verbose description of what your plugin does.
+description        string               A more verbose description of what your plugin does. May contain HTML.
 category           string               Category of a plugin. Either one of ``"FEATURE"``, ``"PAYMENT"``,
                                         ``"INTEGRATION"``, ``"CUSTOMIZATION"``, ``"FORMAT"``, or ``"API"``,
                                         or any other string.
+picture            string (optional)    Path to a picture resolvable through the static file system.
+featured           boolean (optional)   ``False`` by default, can promote a plugin if it's something many users will want, use carefully.
 visible            boolean (optional)   ``True`` by default, can hide a plugin so it cannot be normally activated.
 restricted         boolean (optional)   ``False`` by default, restricts a plugin such that it can only be enabled
                                         for an event by system administrators / superusers.
+experimental       boolean (optional)   ``False`` by default, marks a plugin as an experimental feature in the plugins list.
+picture            string (optional)    Path to a picture resolvable through the static file system.
 compatibility      string               Specifier for compatible pretix versions.
 ================== ==================== ===========================================================
 
@@ -74,8 +78,10 @@ A working example would be:
             name = _("PayPal")
             author = _("the pretix team")
             version = '1.0.0'
-            category = 'PAYMENT
+            category = 'PAYMENT'
+            picture = 'pretix_paypal/paypal_logo.svg'
             visible = True
+            featured = False
             restricted = False
             description = _("This plugin allows you to receive payments via PayPal")
             compatibility = "pretix>=2.7.0"
@@ -92,6 +98,7 @@ those will be displayed but not block the plugin execution.
 
 The ``AppConfig`` class may implement a method ``is_available(event)`` that checks if a plugin
 is available for a specific event. If not, it will not be shown in the plugin list of that event.
+You should not define ``is_available`` and ``restricted`` on the same plugin.
 
 Plugin registration
 -------------------

doc/development/api/quality.rst

@@ -94,7 +94,7 @@ F. Functionality
 
     #. Refunds are implemented, if possible.
 
-    #. In case of overpayment or external refunds, a "required action" is created to notify the event organizer.
+    #. In case of overpayment or external refunds, an external refund is properly created.
 
 #. If the plugin adds steps to the checkout process, it has been tested in combination with the pretix widget.
 

doc/development/concepts.rst

@@ -82,11 +82,15 @@ Orders
 ^^^^^^
 
 If a customer completes the checkout process, an **Order** will be created containing all the entered information.
-An order can be in one of currently four states that are listed in the diagram below:
+An order can be in one of currently six states that are listed in the diagram below:
 
 .. image:: /images/order_states.png
 
-There are additional "fake" states that are displayed like states but not represented as states in the system:
+The dotted lines represent status changes that usually do not happen as part of the regular process, but can be
+performed manually in the admin backend.
+
+For historical reasons, there are only four valid values of the ``status`` field, and the two additional states are
+represented differently:
 
 * An order is considered **canceled (with paid fee)** if it is in **paid** status but does not include any non-cancelled positions.
 

doc/development/contribution/style.rst

@@ -1,6 +1,11 @@
+.. spelling:: Rebase rebasing
+
 Coding style and quality
 ========================
 
+Code
+----
+
 * Basically, we want all python code to follow the `PEP 8`_ standard. There are a few exceptions where
   we see things differently or just aren't that strict. The ``setup.cfg`` file in the project's source
   folder contains definitions that allow `flake8`_ to check for violations automatically. See :ref:`checksandtests`
@@ -20,8 +25,62 @@ Coding style and quality
   test suite are in the style of Python's unit test module. If you extend those files, you might continue in this style,
   but please use ``pytest`` style for any new test files.
 
-* Please keep the first line of your commit messages short. When referencing an issue, please phrase it like
-  ``Fix #123 -- Problems with order creation`` or ``Refs #123 -- Fix this part of that bug``.
+Commits and Pull Requests
+-------------------------
+
+
+
+Most commits should start as pull requests, therefore this applies to the titles of pull requests as well since
+the pull request title will become the commit message on merge. We prefer merging with GitHub's "Squash and merge"
+feature if the PR contains multiple commits that do not carry value to keep. If there is value in keeping the
+individual commits, we use "Rebase and merge" instead. Merge commits should be avoided.
+
+* The commit message should start with a single subject line and can optionally be followed by a commit message body.
+
+  * The subject line should be the shortest possible representation of what the commit changes. Someone who reviewed
+    the commit should able to immediately remember the commit in a couple of weeks based on the subject line and tell
+    it apart from other commits.
+
+  * If there's additional useful information that we should keep, such as reasoning behind the commit, you can
+    add a longer body, separated from the first line by a blank line.
+
+  * The body should explain **what** you changed and more importantly **why** you changed it. There's no need to iterate
+    **how** you changed something.
+
+* The subject line should be capitalized ("Add new feature" instead of "add new feature") and should not end with a period
+  ("Add new feature" instead of "Add new feature.")
+
+* The subject line should be written in imperative mood, as if you were giving a command what the computer should do if the
+  commit is applied. This is how generated commit messages by git itself are already written ("Merge branch …", "Revert …")
+  and makes for short and consistent messages.
+
+  * Good: "Fix typo in template"
+  * Good: "Add Chinese translation"
+  * Good: "Remove deprecated method"
+  * Good: "Bump version to 4.4.0"
+  * Bad: "Fixed bug with …"
+  * Bad: "Fixes bug with …"
+  * Bad: "Fixing bug …"
+
+* If all changes in your commit are in context of a single feature or e.g. a bundled plugin, it makes sense to prefix the
+  subject line with the name of that feature. Examples:
+
+  * "API: Add support for PATCH on customers"
+  * "Docs: Add chapter on alpaca feeding"
+  * "Stripe: Fix duplicate payments"
+  * "Order change form: Fix incorrect validation"
+
+* If your commit references a GitHub issue that is fully resolved by your commit, start your subject line with the issue
+  ID in the form of "Fix #1234 -- Crash in order list". In this case, you can omit the verb "Fix" at the beginning of the
+  second part of the message to avoid repetition of the word "fix". If your commit only partially resolves the issue, use
+  "Refs #1234 -- Crash in order list" instead.
+
+* Applies to pretix employees only: If your commit references a sentry issue, please put it in parentheses at the end
+  of the subject line or inside the body ("Fix crash in order list (PRETIXEU-ABC)"). If your commit references a support
+  ticket, please put it in parentheses at the end of the subject line with a "Z#" prefix ("Fix crash in order list (Z#12345)").
+
+* If your PR was open for a while and might cause conflicts on merge, please prefer rebasing it (``git rebase -i master``)
+  over merging ``master`` into your branch unless it is prohibitively complicated.
 
 
 .. _PEP 8: https://legacy.python.org/dev/peps/pep-0008/

doc/development/implementation/models.rst

@@ -34,9 +34,6 @@ Organizers and events
 .. autoclass:: pretix.base.models.TeamAPIToken
    :members:
 
-.. autoclass:: pretix.base.models.RequiredAction
-   :members:
-
 .. autoclass:: pretix.base.models.EventMetaProperty
    :members:
 
@@ -95,6 +92,9 @@ Carts and Orders
 .. autoclass:: pretix.base.models.OrderRefund
    :members:
 
+.. autoclass:: pretix.base.models.Transaction
+   :members:
+
 .. autoclass:: pretix.base.models.CartPosition
    :members:
 

doc/development/index.rst

@@ -8,6 +8,7 @@ Developer documentation
    setup
    contribution/index
    implementation/index
-   translation/index
+   algorithms/index
    api/index
    structure
+   translation/index

doc/development/setup.rst

@@ -26,7 +26,7 @@ Your should install the following on your system:
 * ``libssl`` (Debian package: ``libssl-dev``)
 * ``libxml2`` (Debian package ``libxml2-dev``)
 * ``libxslt`` (Debian package ``libxslt1-dev``)
-* ``libenchant1c2a`` (Debian package ``libenchant1c2a``)
+* ``libenchant-2-2`` (Debian package ``libenchant-2-2``)
 * ``msgfmt`` (Debian package ``gettext``)
 * ``git``
 
@@ -51,10 +51,15 @@ the dependencies might fail::
 
 Working with the code
 ---------------------
-The first thing you need are all the main application's dependencies::
+If you do not have a recent installation of ``nodejs``, install it now::
+
+    curl -sL https://deb.nodesource.com/setup_17.x | sudo -E bash -
+    sudo apt install nodejs
+
+To make sure it is on your path variable, close and reopen your terminal. Now, install the Python-level dependencies of pretix::
 
     cd src/
-    pip3 install -r requirements.txt -r requirements/dev.txt
+    pip3 install -e ".[dev]"
 
 Next, you need to copy the SCSS files from the source folder to the STATIC_ROOT directory::
 
@@ -67,6 +72,10 @@ Then, create the local database::
 A first user with username ``admin@localhost`` and password ``admin`` will be automatically
 created.
 
+You will also need to install a few JavaScript dependencies::
+
+    make npminstall
+
 If you want to see pretix in a different language than English, you have to compile our language
 files::
 

doc/images/cart_pricing.puml

@@ -0,0 +1,28 @@
+@startuml
+
+partition "For every cart position" {
+    (*) --> "Get default price from product"
+    --> if "Product has variations?" then
+        -->[yes] "Override with price from variation"
+        --> if "Event series?" then
+            -->[yes] "Override with price from subevent"
+            -down-> "Store as listed_price"
+        else
+            -down->[no] "Store as listed_price"
+        endif
+    else
+        -down->[no] "Store as listed_price"
+    endif
+    --> if "Voucher applied?" then
+        -->[yes] "Apply voucher pricing"
+        --> "Store as price_after_voucher"
+    else
+        -->[no] "Store as price_after_voucher"
+    endif
+    --> "Apply custom price if product allows\nApply tax rule\nSubtract bundled products"
+    --> "Store as line_price (gross), tax_rate"
+}
+--> "Apply discount engine"
+--> "Store as price (gross)"
+
+@enduml

doc/images/checkin_offline.puml

@@ -0,0 +1,146 @@
+@startuml
+
+
+partition "data-based check" {
+    "Check based on local database" --> "Is the order in status PAID or PENDING\nand is the position not canceled?"
+    --> if "" then
+        -right->[no] "Return error CANCELED"
+    else
+        -down->[yes] "Is the product part of the check-in list?"
+        --> if "" then
+            -right->[no] "Return error PRODUCT"
+        else
+            -down->[yes] "Is the subevent part of the check-in list?"
+            --> if "" then
+                -right->[no] "Return error INVALID"
+                note bottom: TODO\ninconsistent\nwith online\ncheck
+            else
+                -down->[yes] "Is the order in status PAID?"
+                --> if "" then
+                    -right->[no] "Does the check-in list include pending orders?"
+                    --> if "" then
+                        -right->[no] "Return error UNPAID "
+                    else
+                        -down->[yes] "Is ignore_unpaid set?\n(Has the operator confirmed\nthe checkin?)"
+                        --> if "" then
+                            -right->[no] "Return error UNPAID "
+                        else
+                            -down->[yes] "Is this an entry or exit?"
+                        endif
+                    endif
+                else
+                    -down->[yes] "Is this an entry or exit?"
+                endif
+            endif
+        endif
+    endif
+
+    "Is this an entry or exit?" --> if "" then
+        -right->[entry] Evaluate custom logic (rules)
+        --> if "" then
+            -right->[error] "Return error RULES"
+        else
+            -down->[ok] "Are all required questions answered?"
+            --> if "" then
+                -right->[no] "Return error INCOMPLETE"
+            else
+                -down->[yes] "Does the check-in list allow multi-entry?"
+            endif
+        endif
+    else
+        -->[exit] "Return OK "
+    endif
+
+    "Does the check-in list allow multi-entry?" --> if "" then
+        -right->[yes] "Return OK"
+    else
+        -down->[no] "Is this the first checkin\nfor this ticket on this list?"
+        --> if "" then
+            -right->[yes] "Return OK"
+        else
+            -down->[no] "Are all previous checkins\nfor this ticket on this list exits?"
+            --> if "" then
+                -right->[yes] "Return OK"
+            else
+                -down->[no] "Does the check-in list\n allow entry after exit\nand is the last checkin\nan exit?"
+                --> if "" then
+                    -right->[yes] "Return OK"
+                else
+                    -down->[no] "Return error ALREADY_REDEEMED"
+                endif
+            endif
+        endif
+    endif
+}
+
+partition "dataless check" {
+    "Check based on secret content" --> "Does the secret decode with\nany supported scheme\nand has a valid signature?"
+
+    --> if "" then
+        -down->[yes] "Is the ticket secret on the revocation list?"
+        --> if "" then
+            -right->[yes] "Return error REVOKED"
+        else
+            -down->[no] "Is the product part of the check-in list? "
+            --> if "" then
+                -right->[no] "Return error PRODUCT "
+            else
+                -down->[yes] "Is the subevent part of the check-in list? "
+                --> if "" then
+                    -right->[no] "Return error INVALID  "
+                    note bottom: TODO\ninconsistent\nwith online\ncheck
+                else
+                  --> "Is this an entry or exit? "
+                endif
+            endif
+        endif
+    else
+        -right>[no] "Return error INVALID "
+    endif
+
+    "Is this an entry or exit? " --> if "" then
+        -right->[entry] "Evaluate custom logic (rules) "
+        --> if "" then
+            -right->[error] "Return error RULES "
+        else
+            -down->[ok] "Are all required questions answered? "
+            --> if "" then
+                -right->[no] "Return error INCOMPLETE "
+            else
+                -down->[yes] "Does the check-in list allow multi-entry? "
+            endif
+        endif
+    else
+        -->[exit] " Return OK "
+    endif
+
+    "Does the check-in list allow multi-entry? " --> if "" then
+        -right->[yes] "  Return OK  "
+    else
+        -down->[no] "Are any locally queued checkins for\nthis ticket of this list known?"
+        --> if "" then
+            -right->[no] "  Return OK  "
+        else
+            -down->[yes] "Are all locally queued checkins\nfor this ticket on this list exits? "
+            --> if "" then
+                -right->[yes] "  Return OK  "
+            else
+                -down->[no] "Does the check-in list\n allow entry after exit\nand is the last locally\nqueued checkin\nan exit? "
+                --> if "" then
+                    -right->[yes] "  Return OK  "
+                else
+                    -down->[no] "Return error ALREADY_REDEEMED "
+                endif
+            endif
+        endif
+    endif
+}
+
+(*) --> "Check if order position with\nscanned ticket secret exists"
+--> if "" then
+    -down->[yes] "Check based on local database"
+else
+    -->[no] "Check based on secret content"
+endif
+
+@enduml

doc/images/checkin_online.puml

@@ -0,0 +1,92 @@
+@startuml
+
+(*) --> "Check if order position with\nscanned ticket secret exists"
+--> if "" then
+    -down->[yes] ===CHECK===
+else
+    -->[no] "Check if secret exists\nin revocation list"
+    --> if "" then
+        --> "Is this a forced upload?"
+        --> if "" then
+            -->[yes] ===CHECK===
+        else
+            -right->[no] "Return error REVOKED"
+        endif
+    else
+        -right->[no] "Return error INVALID"
+    endif
+
+endif
+
+
+===CHECK=== -down-> "Is the order in status PAID or PENDING\nand is the position not canceled?"
+--> if "" then
+    -right->[no] "Return error CANCELED"
+else
+    -down->[yes] "Is the product part of the check-in list?"
+    --> if "" then
+        -right->[no] "Return error PRODUCT"
+    else
+        -down->[yes] "Is the subevent part of the check-in list?"
+        --> if "" then
+            -right->[no] "Return error PRODUCT "
+        else
+            -down->[yes] "Is the order in status PAID\nor is this a forced upload?"
+            --> if "" then
+                -right->[no] "Does the check-in list include pending orders?"
+                --> if "" then
+                    -right->[no] "Return error UNPAID "
+                else
+                    -down->[yes] "Is ignore_unpaid set?\n(Has the operator confirmed\nthe checkin?)"
+                    --> if "" then
+                        -right->[no] "Return error UNPAID "
+                    else
+                        -down->[yes] "Is this an entry or exit?\nIs the upload forced?"
+                    endif
+                endif
+            else
+                -down->[yes] "Is this an entry or exit?\nIs the upload forced?"
+            endif
+        endif
+    endif
+endif
+
+"Is this an entry or exit?\nIs the upload forced?" --> if "" then
+    -right->[entry && not force] Evaluate custom logic (rules)
+    --> if "" then
+        -right->[error] "Return error RULES"
+    else
+        -down->[ok] "Are all required questions answered?"
+        --> if "" then
+            -right->[no && questions_supported] "Return error INCOMPLETE"
+        else
+            -down->[yes || not questions_supported] "Does the check-in list allow multi-entry?"
+        endif
+    endif
+else
+    -->[exit || force=true] "Return OK "
+endif
+
+"Does the check-in list allow multi-entry?" --> if "" then
+    -right->[yes] "Return OK"
+else
+    -down->[no] "Is this the first checkin\nfor this ticket on this list?"
+    --> if "" then
+        -right->[yes] "Return OK"
+    else
+        -down->[no] "Are all previous checkins\nfor this ticket on this list exits?"
+        --> if "" then
+            -right->[yes] "Return OK"
+        else
+            -down->[no] "Does the check-in list\n allow entry after exit\nand is the last checkin\nan exit?"
+            --> if "" then
+                -right->[yes] "Return OK"
+            else
+                -down->[no] "Return error ALREADY_REDEEMED"
+            endif
+        endif
+    endif
+endif
+
+
+@enduml

doc/images/order_objects.puml

@@ -0,0 +1,34 @@
+@startuml
+
+participant User
+collections "OrderPayment\nOrderRefund" as P
+collections "Order\nOrderPosition" as O
+collections "Invoice\nInvoiceLine" as I
+
+User -> O: Order placed (€100)
+rnote over O #6DD96D: Order A1B2C\nstatus = **n**\ntotal = €100
+O -> P: Payment created
+O -> I: Invoice created\n(can also happen later)
+rnote over I #6DD96D: Invoice 00001\n€100
+rnote over P #6DD96D: OrderPayment A1B2C-P-1\nstate = **created**
+P -> User: Payment details (web, email)
+User -> P: Payment performed
+rnote over P #EFF46B: OrderPayment A1B2C-P-1\nstate = **confirmed**
+P -> O: Order marked as paid
+rnote over O #EFF46B: Order A1B2C\nstatus = **p**\ntotal = €100
+User -> O: Data change (e.g. invoice address)
+O -> I: Invoice reissued
+rnote over I #6DD96D: Invoice 00002\n€-100
+rnote over I #6DD96D: Invoice 00003\n€100
+rnote over O #EFF46B: Order A1B2C\nstatus = **p**\ntotal = €100
+User -> O: Order canceled
+rnote over O #EFF46B: Order A1B2C\nstatus = **c**
+O -> I: Invoice canceled
+rnote over I #6DD96D: Invoice 00004\n€-100
+O -> P: Refund started
+rnote over P #6DD96D: OrderRefund\nA1B2C-R-1\nstate = **created**
+P -> User: Money sent
+rnote over P #EFF46B: OrderRefund\nA1B2C-R-1\nstate = **done**
+
+@enduml
+

doc/images/order_states.puml

@@ -1,19 +1,39 @@
 @startuml
 
-Pending: Order is expecting payment\nOrder reduces quotas
-Expired: Payment period is over\nOrder does not affect quotas
-Paid: Order was successful\nOrder reduces quotas
-Canceled: Order has been canceled\nOrder does not affect quotas
+state "Approval Pending" as AP
+state "Canceled (with paid fee)" as CP
+AP: status = "n"
+AP: require_approval = true
+Pending: status = "n"
+Pending: require_approval = false
+Pending: Tickets reserved: yes
+Expired: status = "e"
+Expired: Tickets reserved: no
+Paid: status = "p"
+Paid: count(positions | !canceled) > 0
+Paid: Tickets reserved: yes
+CP: status = "p"
+CP: count(positions | !canceled) = 0
+Canceled: status = "c"
+Canceled: Tickets reserved: no
 
-[*] --> Pending: customer\nplaces order
-Pending --> Paid: successful payment
-Pending --> Expired: automatically\nor manually\non admin action
-Expired --> Paid: if payment is received\nonly if quota left
-Expired --> Canceled
-Expired --> Pending: manually\non admin action
-Paid --> Canceled: manually on\nadmin action\nor if an external\npayment provider\nnotifies about a\npayment refund
-Pending --> Canceled: on admin or\ncustomer action
-Paid -> Pending: manually on admin action
-[*] --> Paid: customer\nplaces free order
+
+[*] -> Pending: order placed\ntotal > 0
+[*] -> Paid: order placed\ntotal = 0
+[*] -> AP: order placed\napproval required
+Pending --> Paid: order paid
+Pending --> Expired: after payment\ndeadline
+Expired --> Paid: order paid\n(only if quota left)
+Expired -[dashed]-> Canceled
+Expired -[dashed]-> Pending: order extended
+Paid --> Canceled: order canceled
+Pending --> Canceled: order canceled
+Paid -[dashed]-> Pending: refund
+AP --> Pending: order approved
+AP --> Canceled: order denied
+Paid --> CP: order canceled\n(with cancellation fee)
+Canceled -[dashed]-> Pending: order reactivated
+Canceled -[dashed]-> Paid: order reactivated
+CP -[dashed]-> Canceled: fee canceled
 
 @enduml

doc/images/ticket_layouts.puml

@@ -0,0 +1,52 @@
+@startuml
+
+(*) --> "Which implementation?"
+--> if "" then
+    -down->[pretixPOS] "Check for TicketLayoutItem with\nsales_channel=pretixpos [libpretixsync]"
+    --> if "" then
+        --> (*)
+    else
+        -->[not found] "Check for TicketLayoutItem with\nsales_channel=web [libpretixsync]"
+        --> if "" then
+            --> (*)
+        else
+            -->[not found] "Use event default [libpretixsync]"
+            --> (*)
+        endif
+    endif
+
+else
+    -right->[pretix] "Check for TicketLayoutItem with\nsales_channel=order.sales_channel"
+    --> if "" then
+        -right-> "Run override_layout plugin signal on result"
+    else
+        -down->[not found] "Check for TicketLayoutItem with\nsales_channel=web"
+        --> if "" then
+            --> "Run override_layout plugin signal on result"
+        else
+            -->[not found] "Use event default"
+            --> "Run override_layout plugin signal on result"
+        endif
+    endif
+endif
+
+
+"Run override_layout plugin signal on result" -> (*)
+
+
+partition pretix_shipping {
+  "Run override_layout plugin signal on result" --> "Check for ShippingLayoutItem with\nmethod=order.shipping_method"
+--> if "" then
+    --> (*)
+else
+    -down->[not found] "Check for ShippingMethod.layout"
+    --> if "" then
+        --> (*)
+    else
+        -down->[not found] "Keep original layout"
+        --> (*)
+    endif
+endif
+}
+
+@enduml

doc/license/faq.rst

@@ -0,0 +1,177 @@
+.. spelling::
+
+   AGPL
+   AGPLv3
+   GPL
+   LGPL
+   Apache
+   BSD
+   MIT
+   CLA
+   django
+   i18nfields
+   hierarkey
+   rami.io
+   rami
+   io
+   GmbH
+
+License FAQ
+===========
+
+.. warning::
+
+   This FAQ tries to explain in simpler terms what the license of the pretix open source project does and does not
+   allow. It is based on our interpretation of the license and is not legal advice. The contents of this page are not
+   legally binding, only the original text of the license in the `license file`_ is legally binding.
+
+How is pretix licensed?
+-----------------------
+
+pretix follows the popular dual licensing model. It is available under the `GNU Affero General Public License 3`_ (AGPL)
+plus some additional terms, as well as under a proprietary license ("pretix Enterprise license") on request.
+
+How can it be AGPL if there are additional terms?
+-------------------------------------------------
+
+Even though it is fairly unknown, the AGPL's section 7 is titled "Additional Terms" and outlines specific conditions
+under which additional terms can be imposed on an AGPL-licensed work. In our case, we add three additional terms.
+
+The first additional term for pretix is an additional **permission**. It allows you to do something that the AGPL would
+generally not allow. As it doesn't restrict your freedoms granted by AGPL, if you don't like it, you can ignore it, and
+if you distribute pretix further, you can remove it.
+
+The second and third additional term for pretix are additional terms that restrict or specify other provisions of the
+license. AGPL specifically requires that these terms can only restrict or specify very specific things and we believe
+our additional terms are in compliance with that and are thus valid and may not be removed.
+
+Why did you choose this license model?
+--------------------------------------
+
+pretix was born in the open source community and we're deeply committed to building the best open source ticketing
+solution in the world. It is important to us that pretix is available with a comprehensive feature set under term that
+are compatible with the `Open Source Definition`_. This enables event organizers from all industries and regions
+to have access to a self-hosted, privacy-friendly and secure option to host their events.
+
+However, developing and maintaining pretix is a lot of work. Between 2014 and 2021, we've received external
+contributions from more than 150 individuals. Not counting translations over 90 % of the development was
+done by staff engineers of rami.io GmbH, the company that started pretix. While we're very happy to receive many more
+contributions in the future, we also want to ensure that we continue to be able to pay people working on pretix
+full-time.
+
+We believe our model creates a good balance between ensuring pretix is available freely as well as protecting our
+business interests. Unlike licenses chosen by other projects recently, such as the Server-Side Public License, our
+choice does not restrict using pretix for any possible use case, it just sets a few rules that you have to play by
+if you do.
+
+What do I need to do if I use pretix unmodified?
+------------------------------------------------
+
+If you use pretix without any modifications or plugins, you can use it for whatever you want, as long as you keep
+all copyright notices (including the link to pretix at the bottom of the site) intact.
+
+You are also allowed to make copies of the unmodified source code and distribute them to others as long as you keep
+all copyright and license information intact.
+
+If you install **plugins**, you must follow the same terms as when using a **modified** version (see below).
+
+What do I need to do if I modify pretix?
+----------------------------------------
+
+If you want to modify pretix, you have the right to do so. However, you need to follow the following rules:
+
+* If you **run it for your own events** (events run by you or your company as well as companies from the same
+  corporate groups) our additional permission allows you to do so **without needing to share your source code
+  modifications** as long as you keep the link to pretix at the bottom of the site intact.
+
+* If you **run it for others**, for example as part of a Software-as-a-Service offering or a managed hosting service
+  you **must** make the source code **including all your modifications and all installed plugins** available under the
+  same license as pretix to every visitor of your site. You need to do so in a prominent place such as a link at the bottom of the
+  site. You also **must** keep the existing link intact.
+  You **may not** add additional restrictions on the result as a whole. You **may** add additional permissions, but
+  only on the parts you added. You **must** make clear which changes you made and you must not give the impression that
+  your modified version is an official version of pretix.
+
+* If you **distribute** the modified version, for example as a source code or software package, you **must** license it
+  under the AGPL license with the same additional terms. You **may not** add additional restrictions on the result as a
+  whole. You **may** add additional permissions, but only on the parts you added. You **must** make clear which changes
+  you made and you must not give the impression that your modified version is an official version of pretix.
+
+Does the AGPL copyleft mechanism extend to plugins?
+---------------------------------------------------
+
+Yes. pretix plugins are tightly integrated with pretix, so when running pretix together with a plugin in the same
+environment they form a `combined work`_ and the copyleft mechanism of AGPL applies.
+
+Can I create proprietary or secret plugins?
+-------------------------------------------
+
+Yes, you can create a proprietary or secret plugin, but it may only ever be **used** in an environment that is covered
+by the additional permission from our license. As soon as the plugin is installed in an installation that is not covered
+by our additional permission (e.g. when it is used in a SaaS environment) or covered by an active pretix Enterprise
+license it **must** be released to the visitors of the site under the same license as pretix (like a modified version
+of pretix).
+
+What licenses can plugins use?
+------------------------------
+
+Technically, you can distribute a plugin under any free or proprietary license as long as it is distributed separately.
+However, once it is either **distributed together with pretix or used in an environment not covered by our
+additional permission** or an active pretix Enterprise license, you **must** release it to all recipients of the
+distribution or all visitors of your site under the same license as pretix (like a modified version of pretix).
+
+If you release a plugin publicly, it is therefore most practical to use a license that is `compatible to AGPL`_.
+This includes most open source licenses such as AGPL, GPL, Apache, 3-clause BSD or MIT.
+
+Note however that when you license a plugin with pure AGPL, it will be incompatible with our additional permission.
+Therefore, if you want to use an AGPL-licensed plugin, you'll need to publish the source code of **all** your plugins
+under AGPL terms **even if you only use it for your own events**. A plugin would add its `own additional permission`_
+to its license to allow combining it with pretix for this use case.
+
+To make things less complicated, if you want to distribute a plugin freely, we therefore recommend distributing the
+plugin under **Apache License 2.0**, like we do for most plugins we distribute as open source.
+
+What do I need to do if I want to contribute my changes back?
+-------------------------------------------------------------
+
+In order to retain the possibility for us to offer pretix in a dual licensing model, we unfortunately need you to sign
+a Contributor License Agreement (CLA) that gives us permission to use your contribution in all present and future
+distributions of pretix. We know the bureaucracy sucks. Sorry.
+
+What if I want to re-use a minor part of pretix in my project?
+--------------------------------------------------------------
+
+This is the main part we dislike about AGPL: If you see a specific thing in pretix that you'd like to use in another
+project, you'll need to distribute your other project under AGPL terms as well which is often not practical.
+
+In this case, feel free to get in touch with us! We're happy to grant you special permission or pull the component
+out into a separately, permissively licensed repository. We already did that with `django-hierarkey`_ and
+`django-i18nfield`_ which have previously been parts of pretix.
+
+What can I use the name "pretix" for?
+-------------------------------------
+
+The name pretix is a registered trademark by rami.io GmbH.
+
+* You **may** use it to **indicate copyright**, such as in the "powered by pretix" or "based on pretix" line, or when
+  indicating that a distribution is based on pretix.
+
+* You **may** use it to **indicate compatibility**, for example you are allowed to name your plugin "<name> for pretix"
+  or you may state that an external service is compatible with pretix.
+
+* You **may not** give the impression that your modified version, plugin or compatible service is official or authorized
+  by rami.io GmbH or pretix unless we specifically allowed you to do so.
+
+* You **may not** use it to name your modified version of pretix. End-users must be able to easily identify whether
+  a version of pretix is distributed by us.
+
+* You **may not** use any variations of the name, such as "MyPretix".
+
+.. _license file: https://github.com/pretix/pretix/blob/master/LICENSE
+.. _GNU Affero General Public License 3: https://www.gnu.org/licenses/agpl-3.0.en.html
+.. _compatible to AGPL: https://www.gnu.org/licenses/license-list.en.html#GPLCompatibleLicenses
+.. _Open Source Definition: https://opensource.org/osd
+.. _combined work: https://www.gnu.org/licenses/gpl-faq.html#GPLPlugins
+.. _own additional permission: https://www.gnu.org/licenses/gpl-faq.html#GPLIncompatibleLibs
+.. _django-hierarkey: https://github.com/raphaelm/django-hierarkey
+.. _django-i18nfield: https://github.com/raphaelm/django-i18nfield

doc/plugins/badges.rst

@@ -22,10 +22,6 @@ item_assignments                      list of objects            Products this l
 └ item                                integer                    Item ID
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.16
-
-   This resource has been added.
-
 
 Endpoints
 ---------

doc/plugins/certificates.rst

@@ -0,0 +1,64 @@
+Certificates of attendance
+==========================
+
+The certificates plugin provides a HTTP API that allows you to download the certificate for a specific attendee.
+
+
+Certificate download
+--------------------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/certificate/
+
+   Downloads the certificate for one order position, identified by its internal ID. Download is a two-step
+   process. You will always get a :http:statuscode:`303` response with a ``Location`` header to a different
+   URL. In the background, our server starts preparing the PDF file.
+
+   If you then do a ``GET`` to the URL you were given, you will either receive a :http:statuscode:`409` response
+   indicating to retry after a few seconds, or a :http:statuscode:`200` response with the PDF file.
+
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/certificate/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 303 See Other
+      Location: /api/v1/organizers/democon/events/3vjrh/orderpositions/426/certificate/?result=1f550651-ae7b-4911-a76c-2be8f348aaa5
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/certificate/?result=1f550651-ae7b-4911-a76c-2be8f348aaa5 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/pdf
+
+      ...
+
+   :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 order position to fetch
+   :statuscode 200: File ready for download
+   :statuscode 303: Processing started
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource
+                    **or** downloads are not available for this order position at this time. The response content will
+                    contain more details.
+   :statuscode 404: The requested order position or download provider does not exist.
+   :statuscode 409: The file is not yet ready and will now be prepared. Retry the request after waiting for a few
+                    seconds.

doc/plugins/digital.rst

@@ -52,6 +52,7 @@ Variable                            Description
 ``order_email``                     E-mail address of the ticket purchaser
 ``product_id``                      Internal ID of the purchased product
 ``product_variation``               Internal ID of the purchased product variation (or empty)
+``secret``                          The secret ticket code, would be used as the QR code for physical tickets
 ``attendee_name``                   Full name of the ticket holder (or empty)
 ``attendee_name_*``                 Name parts of the ticket holder, depending on configuration, e.g. ``attendee_name_given_name`` or ``attendee_name_family_name``
 ``attendee_email``                  E-mail address of the ticket holder (or empty)
@@ -61,7 +62,7 @@ Variable                            Description
 ``attendee_city``                   City of the ticket holder's address (or empty)
 ``attendee_country``                Country code of the ticket holder's address (or empty)
 ``attendee_state``                  State of the ticket holder's address (or empty)
-``answer[XYZ]``                     Answer to the custom question with identifier ``XYZ``
+``answers[XYZ]``                    Answer to the custom question with identifier ``XYZ``
 ``invoice_name``                    Full name of the invoice address (or empty)
 ``invoice_name_*``                  Name parts of the invoice address, depending on configuration, e.g. ``invoice_name_given_name`` or ``invoice_name_family_name``
 ``invoice_company``                 Company of the invoice address (or empty)

doc/plugins/exhibitors.rst

@@ -0,0 +1,630 @@
+Exhibitors
+==========
+
+The exhibitors plugin allows to manage exhibitors at your trade show or conference. After signing up your exhibitors
+in the system, you can assign vouchers to exhibitors and give them access to the data of these vouchers. The exhibitors
+module is also the basis of the pretixLEAD lead scanning application.
+
+.. note:: On pretix Hosted, using the lead scanning feature of the exhibitors plugin can add additional costs
+          depending on your contract.
+
+The plugin exposes two APIs. One (REST API) is intended for bulk-data operations from the admin side, and one
+(App API) that is used by the pretixLEAD app.
+
+REST API
+---------
+
+The REST API for exhibitors requires the usual :ref:`rest-auth`.
+
+Resources
+"""""""""
+
+The exhibitors plugin provides a HTTP API that allows you to create new exhibitors.
+
+The exhibitors resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal exhibitor ID in pretix
+name                                  string                     Exhibitor name
+internal_id                           string                     Can be used for the ID in your exhibition system, your customer ID, etc. Can be ``null``. Maximum 255 characters.
+contact_name                          string                     Contact person (or ``null``)
+contact_name_parts                    object of strings          Decomposition of contact name (i.e. given name, family name)
+contact_email                         string                     Contact person email address (or ``null``)
+booth                                 string                     Booth number (or ``null``). Maximum 100 characters.
+locale                                string                     Locale for communication with the exhibitor (or ``null``).
+access_code                           string                     Access code for the exhibitor to access their data or use the lead scanning app (read-only).
+allow_lead_scanning                   boolean                    Enables lead scanning app
+allow_lead_access                     boolean                    Enables access to data gathered by the lead scanning app
+allow_voucher_access                  boolean                    Enables access to data gathered by exhibitor vouchers
+comment                               string                     Internal comment, not shown to exhibitor
+===================================== ========================== =======================================================
+
+You can also access the scanned leads through the API which contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+attendee_order                        string                     Order code of the order the scanned attendee belongs to
+attendee_positionid                   integer                    ``positionid`` if the attendee within the order specified by ``attendee_order``
+rating                                integer                    A rating of 0 to 5 stars (or ``null``)
+notes                                 string                     A note taken by the exhibitor after scanning
+tags                                  list of strings            Additional tags selected by the exhibitor
+first_upload                          datetime                   Date and time of the first upload of this lead
+data                                  list of objects            Attendee data set that may be shown to the exhibitor based o
+                                                                 the event's configuration. Each entry contains the fields ``id``,
+                                                                 ``label``, ``value``, and ``details``. ``details`` is usually empty
+                                                                 except in a few cases where it contains an additional list of objects
+                                                                 with ``value`` and ``label`` keys (e.g. splitting of names).
+device_name                           string                     User-defined name for the device used for scanning (or ``null``).
+===================================== ========================== =======================================================
+
+Endpoints
+"""""""""
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/
+
+   Returns a list of all exhibitors configured for an event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/exhibitors/ 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": "Aperture Science",
+            "internal_id": null,
+            "contact_name": "Dr Cave Johnson",
+            "contact_name_parts": {
+                "_scheme": "salutation_title_given_family",
+                "family_name": "Johnson",
+                "given_name": "Cave",
+                "salutation": "",
+                "title": "Dr"
+            },
+            "contact_email": "johnson@as.example.org",
+            "booth": "A2",
+            "locale": "de",
+            "access_code": "VKHZ2FU8",
+            "allow_lead_scanning": true,
+            "allow_lead_access": true,
+            "allow_voucher_access": true,
+            "comment": ""
+          }
+        ]
+      }
+
+   :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 or event does not exist **or** you have no permission to view it.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/
+
+   Returns information on one exhibitor, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/exhibitors/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": "Aperture Science",
+        "internal_id": null,
+        "contact_name": "Dr Cave Johnson",
+        "contact_name_parts": {
+            "_scheme": "salutation_title_given_family",
+            "family_name": "Johnson",
+            "given_name": "Cave",
+            "salutation": "",
+            "title": "Dr"
+        },
+        "contact_email": "johnson@as.example.org",
+        "booth": "A2",
+        "locale": "de",
+        "access_code": "VKHZ2FU8",
+        "allow_lead_scanning": true,
+        "allow_lead_access": true,
+        "allow_voucher_access": true,
+        "comment": ""
+      }
+
+   :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 exhibitor to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/exhibitor does not exist **or** you have no permission to view it.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/leads/
+
+   Returns a list of all scanned leads of an exhibitor.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/exhibitors/1/leads/ 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": [
+          {
+            "attendee_order": "T0E7E",
+            "attendee_positionid": 1,
+            "rating": 1,
+            "notes": "",
+            "tags": [],
+            "first_upload": "2021-07-06T11:03:31.414491+01:00",
+            "data": [
+              {
+                "id": "attendee_name",
+                "label": "Attendee name",
+                "value": "Peter Miller",
+                "details": [
+                  {"label": "Given name", "value": "Peter"},
+                  {"label": "Family name", "value": "Miller"},
+                ]
+              }
+            ]
+          }
+        ]
+      }
+
+   :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
+   :param id: The ``id`` field of the exhibitor to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer or event or exhibitor does not exist **or** you have no permission to view it.
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/
+
+   Create a new exhibitor.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/exhibitors/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 166
+
+      {
+        "name": "Aperture Science",
+        "internal_id": null,
+        "contact_name_parts": {
+            "_scheme": "salutation_title_given_family",
+            "family_name": "Johnson",
+            "given_name": "Cave",
+            "salutation": "",
+            "title": "Dr"
+        },
+        "contact_email": "johnson@as.example.org",
+        "booth": "A2",
+        "locale": "de",
+        "access_code": "VKHZ2FU8",
+        "allow_lead_scanning": true,
+        "allow_lead_access": true,
+        "allow_voucher_access": true,
+        "comment": ""
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "name": "Aperture Science",
+        "internal_id": null,
+        "contact_name": "Dr Cave Johnson",
+        "contact_name_parts": {
+            "_scheme": "salutation_title_given_family",
+            "family_name": "Johnson",
+            "given_name": "Cave",
+            "salutation": "",
+            "title": "Dr"
+        },
+        "contact_email": "johnson@as.example.org",
+        "booth": "A2",
+        "locale": "de",
+        "access_code": "VKHZ2FU8",
+        "allow_lead_scanning": true,
+        "allow_lead_access": true,
+        "allow_voucher_access": true,
+        "comment": ""
+      }
+
+   :param organizer: The ``slug`` field of the organizer to create new exhibitor for
+   :param event: The ``slug`` field of the event to create new exhibitor for
+   :statuscode 201: no error
+   :statuscode 400: The exhibitor 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 exhibitors.
+
+
+.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/
+
+   Update an exhibitor. 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/digitalcontents/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 34
+
+      {
+        "internal_id": "ABC"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: text/javascript
+
+      {
+        "id": 1,
+        "name": "Aperture Science",
+        "internal_id": "ABC",
+        "contact_name": "Dr Cave Johnson",
+        "contact_name_parts": {
+            "_scheme": "salutation_title_given_family",
+            "family_name": "Johnson",
+            "given_name": "Cave",
+            "salutation": "",
+            "title": "Dr"
+        },
+        "contact_email": "johnson@as.example.org",
+        "booth": "A2",
+        "locale": "de",
+        "access_code": "VKHZ2FU8",
+        "allow_lead_scanning": true,
+        "allow_lead_access": true,
+        "allow_voucher_access": true,
+        "comment": ""
+      }
+
+   :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 exhibitor to modify
+   :statuscode 200: no error
+   :statuscode 400: The exhibitor could not be modified due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/exhibitor does not exist **or** you have no permission to change it.
+
+
+.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/
+
+   Delete an exhibitor.
+
+   .. warning:: This deletes all lead scan data and removes all connections to vouchers (the vouchers are not deleted).
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/exhibitors/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 exhibitor to delete
+   :statuscode 204: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/exhibitor does not exist **or** you have no permission to change it
+
+
+App API
+-------
+
+The App API is used for communication between the pretixLEAD app and the pretix server.
+
+.. warning:: We consider this an internal API, it is not intended for external use. You may still use it, but
+             our :ref:`compatibility commitment <rest-compat>` does not apply.
+
+Authentication
+""""""""""""""
+
+Every exhibitor has an "access code", usually consisting of 8 alphanumeric uppercase characters.
+This access code is communicated to event exhibitors by the event organizers, so this is also what
+exhibitors should enter into a login screen.
+
+All API requests need to contain this access code as a header like this::
+
+    Authorization: Exhibitor ABCDE123
+
+Exhibitor profile
+"""""""""""""""""
+
+Upon login and in regular intervals after that, the API should fetch the exhibitors profile.
+This serves two purposes:
+
+* Checking if the authorization code is actually valid
+
+* Obtaining information that can be shown in the app
+
+The resource consists of the following fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+name                                  string                     Exhibitor name
+booth                                 string                     Booth number (or ``null``)
+event                                 object                     Object describing the event
+├ name                                multi-lingual string       Event name
+├ imprint_url                         string                     URL to legal notice page. If not ``null``, a button in the app should link to this page.
+├ privacy_url                         string                     URL to privacy notice page. If not ``null``, a button in the app should link to this page.
+├ help_url                            string                     URL to help page. If not ``null``, a button in the app should link to this page.
+├ logo_url                            string                     URL to event logo. If not ``null``, this logo may be shown in the app.
+├ slug                                string                     Event short form
+└ organizer                           string                     Organizer short form
+notes                                 boolean                    Specifies whether the exhibitor is allowed to take notes on leads
+tags                                  list of strings            List of tags the exhibitor can assign to their leads
+scan_types                            list of objects            Only used for a special case, fixed value that external API consumers should ignore
+===================================== ========================== =======================================================
+
+.. http:get:: /exhibitors/api/v1/profile
+
+   **Example request:**
+
+   .. sourcecode:: http
+
+    GET /exhibitors/api/v1/profile HTTP/1.1
+    Authorization: Exhibitor ABCDE123
+    Accept: application/json, text/javascript
+
+   **Example response:**
+
+   .. sourcecode:: http
+
+    HTTP/1.1 200 OK
+    Vary: Accept
+    Content-Type: application/json
+
+    {
+      "name": "Aperture Science",
+      "booth": "A2",
+      "event": {
+        "name": {"en": "Sample conference", "de": "Beispielkonferenz"},
+        "slug": "bigevents",
+        "imprint_url": null,
+        "privacy_url": null,
+        "help_url": null,
+        "logo_url": null,
+        "organizer": "sampleconf"
+      },
+      "notes": true,
+      "tags": ["foo", "bar"],
+      "scan_types": [
+        {
+          "key": "lead",
+          "label": "Lead Scanning"
+        }
+      ]
+    }
+
+   :statuscode 200: no error
+   :statuscode 401: Invalid authentication code
+
+Submitting a lead
+"""""""""""""""""
+
+After a ticket/badge is scanned, it should immediately be submitted to the server
+so the scan is stored and information about the person can be shown in the app. The same
+code can be submitted multiple times, so it's no problem to just submit it again after the
+exhibitor set a note or a rating (0-5) inside the app.
+
+On the request, you should set the following properties:
+
+* ``code`` with the scanned barcode
+* ``notes`` with the exhibitor's notes
+* ``scanned`` with the date and time of the actual scan (not the time of the upload)
+* ``scan_type`` set to ``lead`` statically
+* ``tags`` with the list of selected tags
+* ``rating`` with the rating assigned by the exhibitor
+* ``device_name`` with a user-specified name of the device used for scanning (max. 190 characters), or ``null``
+
+If you submit ``tags`` and ``rating`` to be ``null`` and ``notes`` to be ``""``, the server
+responds with the previously saved information and will not delete that information. If you
+supply other values, the information saved on the server will be overridden.
+
+The response will also contain ``tags``, ``rating``, and ``notes``. Additionally,
+it will include ``attendee`` with a list of ``fields`` that can be shown to the
+user. Each field has an internal ``id``, a human-readable ``label``, and a ``value`` (all strings).
+
+Note that the ``fields`` array can contain any number of dynamic keys!
+Depending on the exhibitors permission and event configuration this might be empty,
+or contain lots of details. The app should dynamically show these values (read-only)
+with the labels sent by the server.
+
+The request for this looks like this:
+
+.. http:post:: /exhibitors/api/v1/leads/
+
+   **Example request:**
+
+   .. sourcecode:: http
+
+    POST /exhibitors/api/v1/leads/ HTTP/1.1
+    Authorization: Exhibitor ABCDE123
+    Accept: application/json, text/javascript
+    Content-Type: application/json
+
+    {
+      "code": "qrcodecontent",
+      "notes": "Great customer, wants our newsletter",
+      "scanned": "2020-10-18T12:24:23.000+00:00",
+      "scan_type": "lead",
+      "tags": ["foo"],
+      "rating": 4,
+      "device_name": "DEV1"
+    }
+
+   **Example response:**
+
+   .. sourcecode:: http
+
+    HTTP/1.1 201 Created
+    Vary: Accept
+    Content-Type: application/json
+
+    {
+      "attendee": {
+        "fields": [
+          {
+            "id": "attendee_name",
+            "label": "Name",
+            "value": "Jon Doe",
+            "details": [
+              {"label": "Given name", "value": "John"},
+              {"label": "Family name", "value": "Doe"},
+            ]
+          },
+          {
+            "id": "attendee_email",
+            "label": "Email",
+            "value": "test@example.com",
+            "details": []
+          }
+         ]
+        },
+        "rating": 4,
+        "tags": ["foo"],
+        "notes": "Great customer, wants our newsletter"
+    }
+
+   :statuscode 200: No error, leads was not scanned for the first time
+   :statuscode 201: No error, leads was scanned for the first time
+   :statuscode 400: Invalid data submitted
+   :statuscode 401: Invalid authentication code
+
+You can also fetch existing leads (if you are authorized to do so):
+
+.. http:get:: /exhibitors/api/v1/leads/
+
+   **Example request:**
+
+   .. sourcecode:: http
+
+    GET /exhibitors/api/v1/leads/ HTTP/1.1
+    Authorization: Exhibitor ABCDE123
+    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": [
+        {
+          "attendee": {
+            "fields": [
+              {
+                "id": "attendee_name",
+                "label": "Name",
+                "value": "Jon Doe",
+                "details": [
+                  {"label": "Given name", "value": "John"},
+                  {"label": "Family name", "value": "Doe"},
+                ]
+              },
+              {
+                "id": "attendee_email",
+                "label": "Email",
+                "value": "test@example.com",
+                "details": []
+              }
+           ]
+          },
+          "rating": 4,
+          "tags": ["foo"],
+          "notes": "Great customer, wants our newsletter"
+        }
+      ]
+    }
+
+   :statuscode 200: No error
+   :statuscode 401: Invalid authentication code
+   :statuscode 403: Not permitted to access bulk data

doc/plugins/imported_secrets.rst

@@ -0,0 +1,301 @@
+Secrets Import
+==============
+
+Usually, pretix generates ticket secrets (i.e. the QR code used for scanning) itself. You can read more about this
+process at :ref:`secret_generators`.
+
+With the "Secrets Import" plugin, you can upload your own list of secrets to be used instead. This is useful for
+integrating with third-party check-in systems.
+
+
+API Resource description
+-------------------------
+
+The secrets import plugin provides a HTTP API that allows you to create new secrets.
+
+The imported secret resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of the secret
+secret                                string                     Actual string content of the secret (QR code content)
+used                                  boolean                    Whether the secret was already used for a ticket. If ``true``,
+                                                                 the secret can no longer be deleted. Secrets are never used
+                                                                 twice, even if an order is canceled or deleted.
+item                                  integer                    Internal ID of a product, or ``null``. If set, the secret
+                                                                 will only be used for tickets of this product.
+variation                             integer                    Internal ID of a product variation, or ``null``. If set, the secret
+                                                                 will only be used for tickets of this product variation.
+subevent                              integer                    Internal ID of an event series date, or ``null``. If set, the secret
+                                                                 will only be used for tickets of this event series date.
+===================================== ========================== =======================================================
+
+API Endpoints
+-------------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/imported_secrets/
+
+   Returns a list of all secrets imported for an event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/imported_secrets/ 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,
+            "secret": "foobar",
+            "used": false,
+            "item": null,
+            "variation": null,
+            "subevent": null
+          }
+        ]
+      }
+
+   :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 or event does not exist **or** you have no permission to view it.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/imported_secrets/(id)/
+
+   Returns information on one secret, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/imported_secrets/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,
+        "secret": "foobar",
+        "used": false,
+        "item": null,
+        "variation": null,
+        "subevent": null
+      }
+
+   :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 secret to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/secret does not exist **or** you have no permission to view it.
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/imported_secrets/
+
+   Create a new secret.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/imported_secrets/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 166
+
+      {
+        "secret": "foobar",
+        "used": false,
+        "item": null,
+        "variation": null,
+        "subevent": null
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "secret": "foobar",
+        "used": false,
+        "item": null,
+        "variation": null,
+        "subevent": null
+      }
+
+   :param organizer: The ``slug`` field of the organizer to a create new secret for
+   :param event: The ``slug`` field of the event to create a new secret for
+   :statuscode 201: no error
+   :statuscode 400: The secret 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 secrets.
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/imported_secrets/bulk_create/
+
+   Create new secrets in bulk (up to 500 per request). The request either succeeds or fails entirely.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/imported_secrets/bulk_create/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 166
+
+      [
+        {
+          "secret": "foobar",
+          "used": false,
+          "item": null,
+          "variation": null,
+          "subevent": null
+        },
+        {
+          "secret": "baz",
+          "used": false,
+          "item": null,
+          "variation": null,
+          "subevent": null
+        }
+      ]
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      [
+        {
+          "id": 1,
+          "secret": "foobar",
+          "used": false,
+          "item": null,
+          "variation": null,
+          "subevent": null
+        },
+        {
+          "id": 2,
+          "secret": "baz",
+          "used": false,
+          "item": null,
+          "variation": null,
+          "subevent": null
+        }
+      ]
+
+   :param organizer: The ``slug`` field of the organizer to create new secrets for
+   :param event: The ``slug`` field of the event to create new secrets for
+   :statuscode 201: no error
+   :statuscode 400: The secrets 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 secrets.
+
+
+.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/imported_secrets/(id)/
+
+   Update a secret. 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/imported_secrets/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 34
+
+      {
+        "item": 2
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: text/javascript
+
+      {
+        "id": 1,
+        "secret": "foobar",
+        "used": false,
+        "item": 2,
+        "variation": null,
+        "subevent": null
+      }
+
+   :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 secret to modify
+   :statuscode 200: no error
+   :statuscode 400: The secret could not be modified due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/secret does not exist **or** you have no permission to change it.
+
+
+.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/imported_secrets/(id)/
+
+   Delete a secret. You can only delete secrets that have not yet been used.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/imported_secrets/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 secret to delete
+   :statuscode 204: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/secret does not exist **or** you have no permission to change it **or** the secret has already been used
+

doc/plugins/index.rst

@@ -1,3 +1,5 @@
+.. _`plugin-docs`:
+
 Plugin documentation
 ====================
 
@@ -10,10 +12,13 @@ If you want to **create** a plugin, please go to the
    :maxdepth: 2
 
    list
-   pretixdroid
    banktransfer
    ticketoutputpdf
    badges
    campaigns
+   certificates
    digital
+   exhibitors
+   imported_secrets
    webinar
+   presale-saml

doc/plugins/list.rst

@@ -5,6 +5,6 @@ List of plugins
 ===============
 
 A detailed list of plugins that are available for pretix can be found on the
-`project website`_.
+`pretix Marketplace`_.
 
-.. _project website: https://pretix.eu/about/en/plugins
+.. _pretix Marketplace: https://marketplace.pretix.eu

doc/plugins/presale-saml.rst

@@ -0,0 +1,405 @@
+.. highlight:: ini
+.. spelling::
+
+   IdP
+   skIDentity
+   ePA
+   NPA
+
+Presale SAML Authentication
+===========================
+
+The Presale SAML Authentication plugin is an advanced plugin, which most event
+organizers will not need to use. However, for the select few  who do require
+strong customer authentication that cannot be covered by the built-in customer
+account functionality, this plugin allows pretix to connect to a SAML IdP and
+perform authentication and retrieval of user information.
+
+Usage of the plugin is governed by two separate sets of settings: The plugin
+installation, the Service Provider (SP) configuration and the event
+configuration.
+
+Plugin installation and initial configuration
+---------------------------------------------
+
+.. note:: If you are a customer of our hosted `pretix.eu`_ offering, you can
+          skip this section.
+
+The plugin is installed as any other plugin in the pretix ecosystem. As a
+pretix system administrator, please follow the instructions in the the
+:ref:`Administrator documentation <admindocs>`.
+
+Once installed, you will need to assess, if you want (or need) your pretix
+instance to be a single SP for all organizers and events or if every event
+organizer has to provide their own SP.
+
+Take the example of a university which runs pretix under an pretix Enterprise
+agreement. Since they only provide ticketing services to themselves (every
+organizer is still just a different department of the same university), a
+single SP should be enough.
+
+On the other hand, a reseller such as `pretix.eu`_ who services a multitude
+of clients would not work that way. Here, every organizer is a separate
+legal entity and as such will also need to provide their own SP configuration:
+Company A will expect their SP to reflect their company - and not a generalized
+"pretix SP".
+
+Once you have decided on the mode of operation, the :ref:`Configuration file
+<config>` needs to be extended to reflect your choice.
+
+Example::
+
+    [presale-saml]
+    level=global
+
+``level``
+    ``global`` to use only a single, system-wide SP, ``organizer`` for multiple
+    SPs, configured on the organizer-level. Defaults to ``organizer``.
+
+Service Provider configuration
+------------------------------
+
+Global Level
+^^^^^^^^^^^^
+
+.. note:: If you are a customer of our hosted `pretix.eu`_ offering, you can
+          skip this section and follow the instructions on the upcoming
+          Organizer Level settings.
+
+As a user with administrative privileges, please activate them by clicking the
+`Admin Mode` button in the top right hand corner.
+
+You should now see a new menu-item titled `SAML` appear.
+
+Organizer Level
+^^^^^^^^^^^^^^^
+
+Navigate to the organizer settings in the pretix backend. In the navigation
+bar, you will find a menu-item titled `SAML` if your user has the `Can
+change organizer settings` permission.
+
+
+.. note:: If you are a customer of our hosted `pretix.eu`_ offering, the menu
+          will only appear once one of our friendly customer service agents
+          has enabled the Presale SAML Authentication plugin for at least one
+          of your events. Feel free to get in touch with us!
+
+Setting up the SP
+^^^^^^^^^^^^^^^^^
+
+No matter where your SP configuration lives, you will be greeted by a very
+long list of fields of which almost all of them will need to be filled. Please
+don't be discouraged - most of the settings don't need to be decided by yourself
+and/or are already preset with a sensible default setting.
+
+If you are not sure what setting you should choose for any of the fields, you
+should reach out to your IdP operator as they can tell you exactly what the IdP
+expects and - more importantly - supports.
+
+``IdP Metadata URL``
+    Please provide the URL where your IdP outputs its metadata. For most IdPs,
+    this URL is static and the same for all SPs. If you are a member of the
+    DFN-AAI, you can find the meta-data for the `Test-, Basic- and
+    Advanced-Federation`_ on their website. Please do talk with your local
+    IdP operator though, as you might not even need to go through the DFN-AAI
+    and might just use your institutions local IdP which will also host their
+    metadata on a different URL.
+
+    The URL needs to be publicly accessible, as saving the settings form will
+    fail if the IdP metadata cannot be retrieved. pretix will also automatically
+    refresh the IdP metadata on a regular basis.
+
+``SP Entity Id``
+    By default, we recommend that you use the system-proposed metadata-URL as
+    the Entity Id of your SP. However, if so desired or required by your IdP,
+    you can also set any other, arbitrary URL as the SP Entity Id.
+
+``SP Name / SP Decription``
+    Most IdP will display the name and description of your SP to the users
+    during authentication. The description field can be used to explain to the
+    users how their data is being used.
+
+``SP X.509 Certificate / SP X.509 Private Key``
+    Your SP needs a certificate and a private key for said certificate. Please
+    coordinate with your IdP, if you are supposed to generate these yourself or
+    if they are provided to you.
+
+``SP X.509 New Certificate``
+    As certificates have an expiry date, they need to be renewed on a regular
+    basis. In order to facilitate the rollover from the expiring to the new
+    certificate, you can provide the new certificate already before the expiration
+    of the existing one. That way, the system will automatically use the correct
+    one. Once the old certificate has expired and is not used anymore at all,
+    you can move the new certificate into the slot of the normal certificate and
+    keep the new slot empty for your next renewal process.
+
+``Requested Attributes``
+    An IdP can hold a variety of attributes of an authenticating user. While
+    your IdP will dictate which of the available attributes your SP can consume
+    in theory, you will still need to define exactly which attributes the SP
+    should request.
+
+    The notation is a JSON list of objects with 5 attributes each:
+
+      * ``attributeValue``: Can be defaulted to ``[]``.
+      * ``friendlyName``: String used in the upcoming event-level settings to
+        retrieve the attributes data.
+      * ``isRequired``: Boolean indicating whether the IdP must enforce the
+        transmission of this attribute. In most cases, ``true`` is the best
+        choice.
+      * ``name``: String of the internal, technical name of the requested
+        attribute. Often starting with ``urn:mace:dir:attribute-def:``,
+        ``urn:oid:`` or ``http://``/``https://``.
+      * ``nameFormat``: String describing the type of ``name`` that has been
+        set in the previous section. Often starting with
+        ``urn:mace:shibboleth:1.0:`` or ``urn:oasis:names:tc:SAML:2.0:``.
+
+    Your IdP can provide you with a list of available attributes. See below
+    for a sample configuration in an academic context.
+
+    Note, that you can have multiple attributes with the same ``friendlyName``
+    but different ``name``s. This is often used in systems, where the same
+    information (for example a persons name) is saved in different fields -
+    for example because one institution is returning SAML 1.0 and other
+    institutions are returning SAML 2.0 style attributes. Typically, this only
+    occurs in mix environments like the DFN-AAI with a large number of
+    participants. If you are only using your own institutions IdP and not
+    authenticating anyone outside of your realm, this should not be a common
+    sight.
+
+``Encrypt/Sign/Require ...``
+    Does what is says on the box - please inquire with your IdP for the
+    necessary settings. Most settings can be turned on as they increase security,
+    however some IdPs might stumble over some of them.
+
+``Signature / Digest Algorithm``
+    Please chose appropriate algorithms, that both pretix/your SP and the IdP
+    can communicate with. A common source of issues when connecting to a
+    Shibboleth-based IdP is the Digest Algorithm: pretix does not support
+    ``http://www.w3.org/2009/xmlenc11#rsa-oaep`` and authentication will fail
+    if the IdP enforces this.
+
+``Technical/Support Contacts``
+    Those contacts are encoded into the SPs public meta data and might be
+    displayed to users having trouble authenticating. It is recommended to
+    provide a dedicated point of contact for technical issues, as those will
+    be the ones to change the configuration for the SP.
+
+Event / Authentication configuration
+------------------------------------
+
+Basic settings
+^^^^^^^^^^^^^^
+
+Once the plugin has been enabled for a pretix event using the Plugins-menu from
+the event's settings, a new *SAML* menu item will show up.
+
+On this page, the actual authentication can be configured.
+
+``Checkout Explanation``
+    Since most users probably won't be familiar with why they have to authenticate
+    to buy a ticket, you can provide them a small blurb here. Markdown is supported.
+
+``Attribute RegEx``
+    By default, any successful authentication with the IdP will allow the user to
+    proceed with their purchase. Should the allowed audience needed to be restricted
+    further, a set of regular Expressions can be used to do this.
+
+    An Attribute RegEx of ``{}`` will allow any authenticated user to pass.
+
+    A RegEx of ``{ "affiliation": "^(employee@pretix.eu|staff@pretix.eu)$" }`` will
+    only allow user to pass which have the ``affiliation`` attribute and whose
+    attribute either matches ``employee@pretix.eu`` or ``staff@pretix.eu``.
+
+    Please make sure that the attribute you are querying is also requested from the
+    IdP in the first place - for a quick check you can have a look at the top of
+    the page where all currently configured attributes are listed.
+
+``RegEx Fail Explanation``
+    Only used in conjunction with the above Attribute RegEx. Should the user not
+    pass the restrictions imposed by the regular expression, the user is shown
+    this error-message.
+
+    If you are - for example in an university context - restricting access to
+    students only, you might want to explain here that Employees are not allowed
+    to book tickets.
+
+``Ticket Secret SAML Attribute``
+    In very specific instances, it might be desirable that the ticket-secret is
+    not the randomly one generated by pretix but rather based on one of the
+    users attributes - for example their unique ID or access card number.
+
+    To achieve this, the name of a SAML-attribute can be specified here.
+
+    It is however necessary to note, that even with this setting in use,
+    ticket-secrets need to be unique. This is why when this setting is enabled,
+    the default, pretix-generated ticket-secret is prefixed with the attributes
+    value.
+
+    Example: A users ``cardid`` attribute has the value of ``01189998819991197253``.
+    The default random ticket secret would have been
+    ``yczygpw9877akz2xwdhtdyvdqwkv7npj``. The resulting new secret will now be
+    ``01189998819991197253_yczygpw9877akz2xwdhtdyvdqwkv7npj``.
+
+    That way, the ticket secret is still unique, but when checking into an event,
+    the user can easily be searched and found using their identifier.
+
+IdP-provided E-Mail addresses, names
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+By default, pretix will only authenticate the user and not process the received
+data any further.
+
+However, there are a few exceptions to this rule.
+
+There are a few `magic` attributes that pretix will use to automatically populate
+the corresponding fields within the checkout process **and lock them out from
+user editing**.
+
+  * ``givenName`` and ``sn``: If both of those attributes are present and pretix
+    is configured to collect the users name, these attributes' values are used
+    for the given and family name respectively.
+  * ``email``: If this attribute is present, the E-Mail-address of the users will
+    be set to the one transmitted through the attributes.
+
+The latter might pose a problem, if the IdP is transmitting an ``email`` attribute
+which does contain a system-level mail address which is only used as an internal
+identifier but not as a real mailbox. In this case, please consider setting the
+``friendlyName`` of the attribute to a different value than ``email`` or removing
+this field from the list of requested attributes altogether.
+
+Saving attributes to questions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+By setting the ``internal identifier`` of a user-defined question to the same name
+as a SAML attribute, pretix will save the value of said attribute into the question.
+
+All the same as in the above section on E-Mail addresses, those fields become
+non-editable by the user.
+
+Please be aware that some specialty question types might not be compatible with
+the SAML attributes due to specific format requirements. If in doubt (or if the
+checkout fails/the information is not properly saved), try setting the question
+type to a simple type like "Text (one line)".
+
+Notes and configuration examples
+--------------------------------
+
+Requesting SAML 1.0 and 2.0 attributes from an academic IdP
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This requests the ``eduPersonPrincipalName`` (also sometimes called EPPN),
+``email``, ``givenName`` and ``sn`` both in SAML 1.0 and SAML 2.0 attributes.
+
+.. sourcecode:: json
+
+    [
+        {
+            "attributeValue": [],
+            "friendlyName": "eduPersonPrincipalName",
+            "isRequired": true,
+            "name": "urn:mace:dir:attribute-def:eduPersonPrincipalName",
+            "nameFormat": "urn:mace:shibboleth:1.0:attributeNamespace:uri"
+        },
+        {
+            "attributeValue": [],
+            "friendlyName": "eduPersonPrincipalName",
+            "isRequired": true,
+            "name": "urn:oid:1.3.6.1.4.1.5923.1.1.1.6",
+            "nameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
+        },
+        {
+            "attributeValue": [],
+            "friendlyName": "email",
+            "isRequired": true,
+            "name": "urn:mace:dir:attribute-def:mail",
+            "nameFormat": "urn:mace:shibboleth:1.0:attributeNamespace:uri"
+        },
+        {
+            "attributeValue": [],
+            "friendlyName": "email",
+            "isRequired": true,
+            "name": "urn:oid:0.9.2342.19200300.100.1.3",
+            "nameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
+        },
+        {
+            "attributeValue": [],
+            "friendlyName": "givenName",
+            "isRequired": true,
+            "name": "urn:mace:dir:attribute-def:givenName",
+            "nameFormat": "urn:mace:shibboleth:1.0:attributeNamespace:uri"
+        },
+        {
+            "attributeValue": [],
+            "friendlyName": "givenName",
+            "isRequired": true,
+            "name": "urn:oid:2.5.4.42",
+            "nameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
+        },
+        {
+            "attributeValue": [],
+            "friendlyName": "sn",
+            "isRequired": true,
+            "name": "urn:mace:dir:attribute-def:sn",
+            "nameFormat": "urn:mace:shibboleth:1.0:attributeNamespace:uri"
+        },
+        {
+            "attributeValue": [],
+            "friendlyName": "sn",
+            "isRequired": true,
+            "name": "urn:oid:2.5.4.4",
+            "nameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
+        }
+    ]
+
+skIDentity IdP Metadata URL
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Since the IdP Metadata URL for `skIDentity`_ is not readily documented/visible
+in their backend, we document it here:
+``https://service.skidentity.de/fs/saml/metadata``
+
+Requesting skIDentity attributes for electronic identity cards
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This requests the basic ``eIdentifier``, ``IDType``, ``IDIssuer``, and
+``NameID`` from the `skIDentity`_ SAML service, which are available for
+electronic ID cards such as the German ePA/NPA. (Other attributes such as
+the name and address are available at additional cost from the IdP).
+
+.. sourcecode:: json
+
+    [
+        {
+            "attributeValue": [],
+            "friendlyName": "eIdentifier",
+            "isRequired": true,
+            "name": "http://www.skidentity.de/att/eIdentifier",
+            "nameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
+        },
+        {
+            "attributeValue": [],
+            "friendlyName": "IDType",
+            "isRequired": true,
+            "name": "http://www.skidentity.de/att/IDType",
+            "nameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
+        },
+        {
+            "attributeValue": [],
+            "friendlyName": "IDIssuer",
+            "isRequired": true,
+            "name": "http://www.skidentity.de/att/IDIssuer",
+            "nameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
+        },
+        {
+            "attributeValue": [],
+            "friendlyName": "NameID",
+            "isRequired": true,
+            "name": "http://www.skidentity.de/att/NameID",
+            "nameFormat": "urn:oasis:names:tc:SAML:2.0:attrname-format:uri"
+        }
+    ]
+
+.. _pretix.eu: https://pretix.eu
+.. _Test-, Basic- and Advanced-Federation: https://doku.tid.dfn.de/en:metadata
+.. _skIDentity: https://www.skidentity.de/