List payment methods

paymentMethods(input: PaymentMethodListInput): PaymentMethodPage!

Requires account.billing.read.

Arguments

ArgumentTypeRequired
inputPaymentMethodListInputNo

Input fields

input

PaymentMethodListInput

FieldTypeRequiredDescription
limitIntNoMaximum number of payment methods to return, 1 to 100. Defaults to 100.
cursorStringNoOpaque cursor pointing at the next page. Omit it to read the first page.

Response

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

FieldType
data[PaymentMethod!]!
pageInfoPageInfo!

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

Example

graphql
query PaymentMethods($input: PaymentMethodListInput) {
  paymentMethods(input: $input) {
    data {
      id
      brand
      expMonth
      expYear
      isDefault
    }
    pageInfo {
      hasNextPage
      endCursor
      hasPreviousPage
      startCursor
    }
  }
}
json
{}