Skip to main content

CustomerPaymentMethod

Card and account numbers are never returned. paymentMethod carries only the display details, such as the brand and the last four digits.

type CustomerPaymentMethod {
  id: ID!
  type: String!
  paymentMethod: PaymentMethod
  expireAt: AWSTimestamp
  createdAt: AWSDateTime
  sequence: Boolean!
}

Fields​

CustomerPaymentMethod.id ● ID! non-null scalar​

Payment method ID. Pass to deleteCustomerPaymentMethod, or set as the customer's default.

CustomerPaymentMethod.type ● String! non-null scalar​

Type of the saved payment method.

CustomerPaymentMethod.paymentMethod ● PaymentMethod object​

Payment method details.

CustomerPaymentMethod.expireAt ● AWSTimestamp scalar​

Expiry (unix seconds). null when the method does not expire.

CustomerPaymentMethod.createdAt ● AWSDateTime scalar​

When the payment method was saved.

CustomerPaymentMethod.sequence ● Boolean! non-null scalar​

Whether this is a sequence payment method, saved for merchant-initiated charges such as subscription renewals, rather than one the buyer picks at checkout.

Returned By​

customerPaymentMethods query