Operational

Enterprise feature

undefined

get/api/admin/invoices

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/invoices
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Response

invoicesSchema

amountFormattedstring required

A formatted representation of the amount due.

paidboolean required

true if the invoice has been paid, false if it has not.

statusstring required

The current status of the invoice

dueDatestring

When the invoice is due

invoiceURLstring uri required

A URL pointing to where the invoice can be found.

invoicePDFstring uri required

A link to a PDF-version of the invoice.

Example response

[
  {
    "amountFormatted": "€ 123.00",
    "paid": true,
    "status": "pending",
    "dueDate": "2018-11-13",
    "invoiceURL": "https://invoice.url",
    "invoicePDF": "https://invoice.url/pdf"
  }
]

Changes

No recorded changes to this operation across all 7 revisions of this API.