Skip to main content

InvoiceListResponse

List of invoices with pagination.

invoices object[]required
  • Array [
    • idId (string)required
    numberNumber (string)required
    statusStatus (string)required
    amount_dueAmount Due (integer)required
    amount_paidAmount Paid (integer)required
    currencyCurrency (string)required
    period_startPeriod Start (integer)required
    period_endPeriod End (integer)required
    created_atCreated At (integer)required
    invoice_pdf object
    anyOf
    string
    line_items object[]required
  • Array [
    • descriptionDescription (string)required
    quantityQuantity (integer)required
    unit_amountUnit Amount (integer)required
    amountAmount (integer)required
  • ]
  • ]
    • has_moreHas More (boolean)required
    InvoiceListResponse
    {
      "invoices": [
        {
          "id": "string",
          "number": "string",
          "status": "string",
          "amount_due": 0,
          "amount_paid": 0,
          "currency": "string",
          "period_start": 0,
          "period_end": 0,
          "created_at": 0,
          "invoice_pdf": "string",
          "line_items": [
            {
              "description": "string",
              "quantity": 0,
              "unit_amount": 0,
              "amount": 0
            }
          ]
        }
      ],
      "has_more": true
    }