PaymentMethod

A customer payment method.

type PaymentMethod {
  id: GlobalID!
  activePaymentInstrument: PaymentInstrument!
  channel: Channel!
  createdAt: ISO8601DateTime!
  customer: Customer!
  externalId: String
  futureUsage: PaymentMethodFutureUsage
  metadata: Metadata
  paymentInstruments: [PaymentInstrument!]
  paymentIntents(
    after: String
    before: String
    first: Int
    last: Int
  ): PaymentIntentConnection
  revokedAt: ISO8601DateTime
  revokedReason: String
  status: PaymentMethodStatus
  updatedAt: ISO8601DateTime
}

Fields

PaymentMethod.id ● GlobalID! non-null scalar types

The payment method's ID.

PaymentMethod.activePaymentInstrument ● PaymentInstrument! non-null object types

The payment instrument the payment method currently uses.

PaymentMethod.channel ● Channel! non-null object types

The channel the payment method belongs to.

PaymentMethod.createdAt ● ISO8601DateTime! non-null scalar types

The date and time when the payment method was created.

PaymentMethod.customer ● Customer! non-null object types

The customer the payment method belongs to.

PaymentMethod.externalId ● String scalar types

The payment method's ID in the payment processor.

PaymentMethod.futureUsage ● PaymentMethodFutureUsage enum types

How the payment method will be used for future payments.

PaymentMethod.metadata ● Metadata scalar types

Key/value pairs for storing extra information about the payment method.

PaymentMethod.paymentInstruments ● [PaymentInstrument!] list object types

The payment method's payment instruments, including inactive ones.

PaymentMethod.paymentIntents ● PaymentIntentConnection object types

The payment intents paid with the payment method.

PaymentMethod.paymentIntents.after ● String scalar types

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

PaymentMethod.paymentIntents.before ● String scalar types

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

PaymentMethod.paymentIntents.first ● Int scalar types

Returns the first _n_ elements from the list.

PaymentMethod.paymentIntents.last ● Int scalar types

Returns the last _n_ elements from the list.

PaymentMethod.revokedAt ● ISO8601DateTime scalar types

The date and time when the payment method was revoked.

PaymentMethod.revokedReason ● String scalar types

The reason the payment method was revoked.

PaymentMethod.status ● PaymentMethodStatus enum types

The payment method's status.

PaymentMethod.updatedAt ● ISO8601DateTime scalar types

The date and time when the payment method was last updated.

Returned By

paymentMethod query

Member Of

CampaignOrder object ● CampaignOrderGroup object ● PaymentInstrument object ● PaymentIntent object ● PaymentMethodCancelPayload object ● PaymentMethodConnection object ● PaymentMethodEdge object ● Subscription object ● SubscriptionOrder object