List payments

payments(input: PaymentListInput): PaymentPage!

Requires account.billing.read.

Arguments

ArgumentTypeRequired
inputPaymentListInputNo

Input fields

input

PaymentListInput

FieldTypeRequiredDescription
sortByStringNodate or amount. Pages follow Stripe order, newest first; sorting orders the returned page only.
sortOrderStringNoasc or desc. Defaults to desc.
limitIntNoMaximum number of payments to return, 1 to 100. Defaults to 20.
cursorStringNoOpaque cursor pointing at the next page. Omit it to read the first page.

Response

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

FieldType
data[Payment!]!
pageInfoPageInfo!

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

Example

graphql
query Payments($input: PaymentListInput) {
  payments(input: $input) {
    data {
      id
      status
      createdAt
      amount
      currency
    }
    pageInfo {
      hasNextPage
      endCursor
      hasPreviousPage
      startCursor
    }
  }
}
json
{}