--- title: CustomerPaymentMethod - GraphQL Admin description: |- 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`](https://shopify.dev/docs/api/admin-graphql/latest/unions/CustomerPaymentInstrument) union. api_version: 2025-01 api_name: admin type: object api_type: graphql source_url: html: https://shopify.dev/docs/api/admin-graphql/2025-01/objects/customerpaymentmethod md: https://shopify.dev/docs/api/admin-graphql/2025-01/objects/customerpaymentmethod.md --- # Customer​Payment​Method 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`](https://shopify.dev/docs/api/admin-graphql/latest/unions/CustomerPaymentInstrument) union. ## Fields * customer [Customer](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Customer) The customer to whom the payment method belongs. * id [ID!](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/ID) non-null The ID of this payment method. * instrument [Customer​Payment​Instrument](https://shopify.dev/docs/api/admin-graphql/2025-01/unions/CustomerPaymentInstrument) The instrument for this payment method. * revoked​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/2025-01/scalars/DateTime) The time that the payment method was revoked. * revoked​Reason [Customer​Payment​Method​Revocation​Reason](https://shopify.dev/docs/api/admin-graphql/2025-01/enums/CustomerPaymentMethodRevocationReason) The revocation reason for this payment method. * subscription​Contracts [Subscription​Contract​Connection!](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/SubscriptionContractConnection) non-null List Subscription Contracts. *** ## Map ### Fields and connections with this object * {}[Customer.paymentMethods](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/Customer#field-Customer.fields.paymentMethods) * <->[CustomerPaymentMethodConnection.nodes](https://shopify.dev/docs/api/admin-graphql/2025-01/connections/CustomerPaymentMethodConnection#returns-nodes) * {}[CustomerPaymentMethodEdge.node](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/CustomerPaymentMethodEdge#field-CustomerPaymentMethodEdge.fields.node) * {}[SubscriptionBillingCycleEditedContract.customerPaymentMethod](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/SubscriptionBillingCycleEditedContract#field-SubscriptionBillingCycleEditedContract.fields.customerPaymentMethod) * {}[SubscriptionContract.customerPaymentMethod](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/SubscriptionContract#field-SubscriptionContract.fields.customerPaymentMethod) * ||-[SubscriptionContractBase.customerPaymentMethod](https://shopify.dev/docs/api/admin-graphql/2025-01/interfaces/SubscriptionContractBase#fields-customerPaymentMethod) * {}[SubscriptionDraft.customerPaymentMethod](https://shopify.dev/docs/api/admin-graphql/2025-01/objects/SubscriptionDraft#field-SubscriptionDraft.fields.customerPaymentMethod) *** ## Queries * [customer​Payment​Method](https://shopify.dev/docs/api/admin-graphql/2025-01/queries/customerPaymentMethod) query Returns a CustomerPaymentMethod resource by its ID. *** ## \CustomerPaymentMethod Queries ### Queried by * \[customer​Payment​Method](https://shopify.dev/docs/api/admin-graphql/2025-01/queries/customerPaymentMethod) *** ## Mutations * [customer​Payment​Method​Credit​Card​Create](https://shopify.dev/docs/api/admin-graphql/2025-01/mutations/customerPaymentMethodCreditCardCreate) 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. * [customer​Payment​Method​Credit​Card​Update](https://shopify.dev/docs/api/admin-graphql/2025-01/mutations/customerPaymentMethodCreditCardUpdate) mutation Updates the credit card payment method for a customer. * [customer​Payment​Method​Paypal​Billing​Agreement​Create](https://shopify.dev/docs/api/admin-graphql/2025-01/mutations/customerPaymentMethodPaypalBillingAgreementCreate) mutation Creates a PayPal billing agreement for a customer. * [customer​Payment​Method​Paypal​Billing​Agreement​Update](https://shopify.dev/docs/api/admin-graphql/2025-01/mutations/customerPaymentMethodPaypalBillingAgreementUpdate) mutation Updates a PayPal billing agreement for a customer. * [customer​Payment​Method​Remote​Create](https://shopify.dev/docs/api/admin-graphql/2025-01/mutations/customerPaymentMethodRemoteCreate) 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`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) objects in Shopify. The operation processes payment methods asynchronously. The returned [`CustomerPaymentMethod`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerPaymentMethod) initially has incomplete details while Shopify validates and processes the remote gateway information. Use the [`customerPaymentMethod`](https://shopify.dev/docs/api/admin-graphql/latest/queries/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](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/migrate-to-subscriptions-api/migrate-customer-information#step-2-import-payment-methods-for-customers). *** ## <\~> CustomerPaymentMethod Mutations ### Mutated by * <\~>[customer​Payment​Method​Credit​Card​Create](https://shopify.dev/docs/api/admin-graphql/2025-01/mutations/customerPaymentMethodCreditCardCreate) * <\~>[customer​Payment​Method​Credit​Card​Update](https://shopify.dev/docs/api/admin-graphql/2025-01/mutations/customerPaymentMethodCreditCardUpdate) * <\~>[customer​Payment​Method​Paypal​Billing​Agreement​Create](https://shopify.dev/docs/api/admin-graphql/2025-01/mutations/customerPaymentMethodPaypalBillingAgreementCreate) * <\~>[customer​Payment​Method​Paypal​Billing​Agreement​Update](https://shopify.dev/docs/api/admin-graphql/2025-01/mutations/customerPaymentMethodPaypalBillingAgreementUpdate) * <\~>[customer​Payment​Method​Remote​Create](https://shopify.dev/docs/api/admin-graphql/2025-01/mutations/customerPaymentMethodRemoteCreate) *** ## Interfaces * [Node](https://shopify.dev/docs/api/admin-graphql/2025-01/interfaces/Node) interface *** ## ||-CustomerPaymentMethod Implements ### Implements * ||-[Node](https://shopify.dev/docs/api/admin-graphql/2025-01/interfaces/Node)