---
title: CustomerPaymentMethod - GraphQL Admin
description: A customer's payment method.
api_version: 2025-10
api_name: admin
type: object
api_type: graphql
source_url:
  html: https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerPaymentMethod
  md: https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerPaymentMethod.md
---

# Customer​Payment​Method

object

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

A customer's payment method.

## Fields

* customer

  [Customer](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer)

  The customer to whom the payment method belongs.

* id

  [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID)

  non-null

  The ID of this payment method.

* instrument

  [Customer​Payment​Instrument](https://shopify.dev/docs/api/admin-graphql/latest/unions/CustomerPaymentInstrument)

  The instrument for this payment method.

* mandates

  [Payment​Mandate​Resource​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/PaymentMandateResourceConnection)

  non-null

  The mandates associated with the payment method.

* revoked​At

  [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)

  The time that the payment method was revoked.

* revoked​Reason

  [Customer​Payment​Method​Revocation​Reason](https://shopify.dev/docs/api/admin-graphql/latest/enums/CustomerPaymentMethodRevocationReason)

  The revocation reason for this payment method.

* subscription​Contracts

  [Subscription​Contract​Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/SubscriptionContractConnection)

  non-null

  List Subscription Contracts.

***

## Map

### Fields and connections with this object

* {}[Customer.paymentMethods](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer#field-Customer.fields.paymentMethods)
* <->[CustomerPaymentMethodConnection.nodes](https://shopify.dev/docs/api/admin-graphql/latest/connections/CustomerPaymentMethodConnection#returns-nodes)
* {}[CustomerPaymentMethodEdge.node](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerPaymentMethodEdge#field-CustomerPaymentMethodEdge.fields.node)
* {}[SubscriptionBillingCycleEditedContract.customerPaymentMethod](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionBillingCycleEditedContract#field-SubscriptionBillingCycleEditedContract.fields.customerPaymentMethod)
* {}[SubscriptionContract.customerPaymentMethod](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionContract#field-SubscriptionContract.fields.customerPaymentMethod)
* ||-[SubscriptionContractBase.customerPaymentMethod](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/SubscriptionContractBase#fields-customerPaymentMethod)
* {}[SubscriptionDraft.customerPaymentMethod](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionDraft#field-SubscriptionDraft.fields.customerPaymentMethod)

***

## Queries

* [customer​Payment​Method](https://shopify.dev/docs/api/admin-graphql/latest/queries/customerPaymentMethod)

  query

  Returns a CustomerPaymentMethod resource by its ID.

***

## \<?>CustomerPaymentMethod Queries

### Queried by

* \<?>[customer​Payment​Method](https://shopify.dev/docs/api/admin-graphql/latest/queries/CustomerPaymentMethod)

***

## Mutations

* [customer​Payment​Method​Credit​Card​Create](https://shopify.dev/docs/api/admin-graphql/latest/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/latest/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/latest/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/latest/mutations/customerPaymentMethodPaypalBillingAgreementUpdate)

  mutation

  Updates a PayPal billing agreement for a customer.

* [customer​Payment​Method​Remote​Create](https://shopify.dev/docs/api/admin-graphql/latest/mutations/customerPaymentMethodRemoteCreate)

  mutation

  Create a payment method from remote gateway identifiers. NOTE: This operation processes payment methods asynchronously. The returned payment method will initially have incomplete details. Developers must poll this payment method using customerPaymentMethod query until all payment method details are available, or the payment method is revoked (usually within seconds).

***

## <\~> CustomerPaymentMethod Mutations

### Mutated by

* <\~>[customer​Payment​Method​Credit​Card​Create](https://shopify.dev/docs/api/admin-graphql/latest/mutations/customerPaymentMethodCreditCardCreate)
* <\~>[customer​Payment​Method​Credit​Card​Update](https://shopify.dev/docs/api/admin-graphql/latest/mutations/customerPaymentMethodCreditCardUpdate)
* <\~>[customer​Payment​Method​Paypal​Billing​Agreement​Create](https://shopify.dev/docs/api/admin-graphql/latest/mutations/customerPaymentMethodPaypalBillingAgreementCreate)
* <\~>[customer​Payment​Method​Paypal​Billing​Agreement​Update](https://shopify.dev/docs/api/admin-graphql/latest/mutations/customerPaymentMethodPaypalBillingAgreementUpdate)
* <\~>[customer​Payment​Method​Remote​Create](https://shopify.dev/docs/api/admin-graphql/latest/mutations/customerPaymentMethodRemoteCreate)

***

## Interfaces

* [Node](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Node)

  interface

***

## ||-CustomerPaymentMethod Implements

### Implements

* ||-[Node](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Node)