Skip to main content

paymentMethods

Returns a list of payment methods. Filter by customer, future use, payment instrument type or status.

paymentMethods(
  after: String
  before: String
  customerId: GlobalID
  first: Int
  futureUsage: [PaymentMethodFutureUsage!]
  last: Int
  paymentInstrumentType: [PaymentInstrumentType!]
  status: [PaymentMethodStatus!]
): PaymentMethodConnection

Arguments​

paymentMethods.after ● String scalar types​

Returns the elements in the list that come after the specified cursor.

paymentMethods.before ● String scalar types​

Returns the elements in the list that come before the specified cursor.

paymentMethods.customerId ● GlobalID scalar types​

The ID of the customer to return payment methods for.

paymentMethods.first ● Int scalar types​

Returns the first _n_ elements from the list.

paymentMethods.futureUsage ● [PaymentMethodFutureUsage!] list enum types​

The future uses to filter payment methods by.

paymentMethods.last ● Int scalar types​

Returns the last _n_ elements from the list.

paymentMethods.paymentInstrumentType ● [PaymentInstrumentType!] list enum types​

The payment instrument types to filter payment methods by. Matches any of a payment method's instruments, including inactive ones.

paymentMethods.status ● [PaymentMethodStatus!] list enum types​

The statuses to filter payment methods by.

Type​

PaymentMethodConnection object types​

The connection type for PaymentMethod.