Skip to main content
Anchor to CustomerPaymentMethod

CustomerPaymentMethod

object

Requires read_customers access scope. Also: Requires read_customer_payment_methods scope.

A customer's saved payment method. Stores the payment instrument details and billing information for recurring charges.

The payment method supports types included in the CustomerPaymentInstrument union.

•Customer

The customer to whom the payment method belongs.

•ID!
non-null

The ID of this payment method.

•CustomerPaymentInstrument

The instrument for this payment method.

•PaymentMandateResourceConnection!
non-null

The mandates associated with the payment method.

•DateTime

The time that the payment method was revoked.

•CustomerPaymentMethodRevocationReason

The revocation reason for this payment method.

Anchor to subscriptionContractssubscriptionContracts
•SubscriptionContractConnection!
non-null

List Subscription Contracts.


Was this section helpful?

•query

Returns a CustomerPaymentMethod resource by its ID.


Was this section helpful?

•mutation

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.

•mutation

Updates the credit card payment method for a customer.

•mutation

Creates a PayPal billing agreement for a customer.

•mutation

Updates a PayPal billing agreement for a customer.

•mutation

Creates a customer payment method using identifiers from remote payment gateways like Stripe, Authorize.Net, or Braintree. Imports existing payment methods from external gateways and associates them with Customer objects in Shopify.

The operation processes payment methods asynchronously. The returned CustomerPaymentMethod initially has incomplete details while Shopify validates and processes the remote gateway information. Use the customerPaymentMethod query to retrieve the payment method status until all details are available or the payment method is revoked.

Learn more about migrating customer payment methods from remote gateways.


Was this section helpful?

•interface

Was this section helpful?