---
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: 2026-01
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 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
* id
* instrument
* mandates
* revokedAt
* revokedReason
* subscriptionContracts

***

## 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

* customerPaymentMethod

***

## CustomerPaymentMethod Queries

### Queried by

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

***

## Mutations

* customerPaymentMethodCreditCardCreate
* customerPaymentMethodCreditCardUpdate
* customerPaymentMethodPaypalBillingAgreementCreate
* customerPaymentMethodPaypalBillingAgreementUpdate
* customerPaymentMethodRemoteCreate

***

## 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

***

## CustomerPaymentMethod Implements

### Implements

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