pretix Hosted billing invoices

This endpoint allows you to access invoices you received for pretix Hosted. It only contains invoices created starting November 2017.

Note

Only available on pretix Hosted, not on self-hosted pretix instances.

Resource description

The resource contains the following public fields:

Field Type Description
invoice_number string Invoice number
date_issued date Invoice date

Endpoints

GET /api/v1/organizers/(organizer)/billing_invoices/

Returns a list of all invoices to a given organizer.

Example request:

GET /api/v1/organizers/bigevents/billing_invoices/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "invoice_number": "R2019002",
      "date_issued": "2019-06-03"
    }
  ]
}
Query Parameters:
 
  • page (integer) – The page number in case of a multi-page result set, default is 1
  • ordering (string) – Manually set the ordering of results. Valid fields to be used are date_issued and its reverse, -date_issued. Default: date_issued.
Parameters:
  • organizer – The slug field of the organizer to fetch
Status Codes:
  • 200 OK – no error
  • 401 Unauthorized – Authentication failure
  • 403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
GET /api/v1/organizers/(organizer)/billing_invoices/(invoice_number)/

Returns information on one invoice, identified by its invoice number.

Example request:

GET /api/v1/organizers/bigevents/billing_invoices/R2019002/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "invoice_number": "R2019002",
  "date_issued": "2019-06-03"
}
Parameters:
  • organizer – The slug field of the organizer to fetch
  • invoice_number – The invoice_number field of the invoice to fetch
Status Codes:
  • 200 OK – no error
  • 401 Unauthorized – Authentication failure
  • 403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
GET /api/v1/organizers/(organizer)/billing_invoices/(invoice_number)/download/

Download an invoice in PDF format.

Warning

After we created the invoices, they are placed in review with our accounting department. You will already see them in the API at this point, but you are not able to download them until they completed review and are sent to you via email. This usually takes a few hours. If you try to download them in this time frame, you will receive a status code 423 Locked.

Example request:

GET /api/v1/organizers/bigevents/billing_invoices/R2019002/download/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/pdf

...
Parameters:
  • organizer – The slug field of the organizer to fetch
  • invoice_number – The invoice_number field of the invoice to fetch
Status Codes:
  • 200 OK – no error
  • 401 Unauthorized – Authentication failure
  • 403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.
  • 423 Locked – The file is not yet ready and will now be prepared. Retry the request after waiting for a few seconds.