CustomerPaymentMethod - admin-graphql - OBJECT

Version: 2024-10

Description:

A customer's payment method.

Access Scopes

`read_customers` access scope. Also: Requires `read_customer_payment_methods` scope.

Fields

• customer: Customer - The customer to whom the payment method belongs.
• id: ID! - The ID of this payment method.
• instrument: CustomerPaymentInstrument - The instrument for this payment method.
• revokedAt: DateTime - The time that the payment method was revoked.
• revokedReason: CustomerPaymentMethodRevocationReason - The revocation reason for this payment method.

Connections

• subscriptionContracts: SubscriptionContractConnection!

Related queries

• customerPaymentMethod Returns a CustomerPaymentMethod resource by its ID.

Related mutations

• customerPaymentMethodCreditCardCreate Creates a credit card payment method for a customer using a session id. These values are only obtained through card imports happening from a PCI compliant environment. Please use customerPaymentMethodRemoteCreate if you are not managing credit cards directly.
• customerPaymentMethodCreditCardUpdate Updates the credit card payment method for a customer.
• customerPaymentMethodPaypalBillingAgreementCreate Creates a PayPal billing agreement for a customer.
• customerPaymentMethodPaypalBillingAgreementUpdate Updates a PayPal billing agreement for a customer.
• customerPaymentMethodRemoteCreate Create a payment method from remote gateway identifiers.
• customerPaymentMethodRemoteCreditCardCreate Create a payment method from a credit card stored by Stripe.

Related Unions

Examples