Invoices

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/invoices",
  "title": "Invoices",
  "type": "object",
  "minItems": 1,
  "description": "An array of merchant invoices. Includes the total invoices count and [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links) for navigation.",
  "properties": {
    "total_pages": {
      "type": "integer",
      "description": "The total number of pages that are available for the search criteria. <blockquote><strong>Note:</strong> Clients MUST NOT assume that the value of total_pages is constant. The value MAY change from one request to the next</blockquote>",
      "readOnly": true
    },
    "total_items": {
      "type": "integer",
      "description": "The total number of invoices that match the search criteria.<blockquote><strong>Note:</strong> Clients MUST NOT assume that the value of <code>total_items</code> is constant. The value MAY change from one request to the next.</blockquote>",
      "readOnly": true
    },
    "items": {
      "type": "array",
      "description": "The list of invoices that match the search criteria.",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/invoice"
      }
    },
    "links": {
      "type": "array",
      "description": "An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/link_description"
      }
    }
  }
}