CustomerPaymentMethod object

A customer’s payment method.

Required access

read_customers access scope.


On this page


Connections

  • subscriptionContracts ([SubscriptionContractConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptioncontract))
    List Subscription Contracts.
Argument Description
after
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)
Returns the elements that come after the specified cursor.
before
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)
Returns the elements that come before the specified cursor.
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)
Returns up to the first n elements from the list.
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)
Returns up to the last n elements from the list.
reverse
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)
Reverse the order of the underlying list.
Default value: false


Fields

  • customer ([Customer](https://shopify.dev/docs/admin-api/graphql/reference/customers/customer))
    The customer to whom the payment method belongs.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    The ID of this payment method.
  • instrument ([CustomerPaymentInstrument](https://shopify.dev/docs/admin-api/graphql/reference/customers/customerpaymentinstrument))
    The instrument for this payment method.
  • revokedAt ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    The time that the payment method was revoked.


Types that return CustomerPaymentMethod

  • [Customer.paymentMethods](https://shopify.dev/docs/admin-api/graphql/reference/customers/customer#paymentmethods-2021-01)
  • [QueryRoot.customerPaymentMethod](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#customerpaymentmethod-2021-01)
  • [SubscriptionContract.customerPaymentMethod](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptioncontract#customerpaymentmethod-2021-01)
  • [SubscriptionDraft.customerPaymentMethod](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondraft#customerpaymentmethod-2021-01)


Mutations for CustomerPaymentMethod


Implements

  • [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)

An auto-generated type for paginating through multiple CustomerPaymentMethods.


On this page


Fields

  • edges ([[CustomerPaymentMethodEdge!]!](https://shopify.dev/docs/admin-api/graphql/reference/customers/customerpaymentmethod))
    A list of edges.
  • pageInfo ([PageInfo!](https://shopify.dev/docs/admin-api/graphql/reference/pageinfo))
    Information to aid in pagination.

An auto-generated type which holds one CustomerPaymentMethod and a cursor during pagination.


On this page


Fields

  • cursor ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A cursor for use in pagination.
  • node ([CustomerPaymentMethod!](https://shopify.dev/docs/admin-api/graphql/reference/customers/customerpaymentmethod))
    The item at the end of CustomerPaymentMethodEdge.


Types that return CustomerPaymentMethodEdge

  • [CustomerPaymentMethodConnection.edges](https://shopify.dev/docs/admin-api/graphql/reference/customers/customerpaymentmethod#edges-2021-01)