List invoices

invoices(input: InvoiceListInput): InvoicePage!

Requires account.billing.read.

Arguments

ArgumentTypeRequired
inputInvoiceListInputNo

Input fields

input

InvoiceListInput

FieldTypeRequiredDescription
kindStringNoissued (default) lists finalized invoices. upcoming lists the preview of each active subscription, then draft invoices.
sortByStringNodate, amount or status. Pages follow Stripe order, newest first; sorting orders the returned page only.
sortOrderStringNoasc or desc. Defaults to desc.
limitIntNoMaximum number of invoices to return, 1 to 100. Defaults to 20.
cursorStringNoOpaque cursor pointing at the next page. Omit it to read the first page.

Response

Returns InvoicePage!. Open the type for its fields and nested types.

FieldType
data[Invoice!]!
pageInfoPageInfo!

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
query Invoices($input: InvoiceListInput) {
  invoices(input: $input) {
    data {
      id
      status
      amountDue
      amountPaid
      amountTotal
    }
    pageInfo {
      hasNextPage
      endCursor
      hasPreviousPage
      startCursor
    }
  }
}
json
{}