customerPaymentMethodRevoke mutation

Revokes a customer’s payment method.

Required access

write_customers access scope.

On this page

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

mutation customerPaymentMethodRevoke($customerPaymentMethodId: ID!) { customerPaymentMethodRevoke(customerPaymentMethodId: $customerPaymentMethodId) { 
  1. <font style="color:#1F61A0;">revokedCustomerPaymentMethodId</font>
  3. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  5.   <font style="color:#1F61A0;">field</font>
  7.   <font style="color:#1F61A0;">message</font>
  9. <font style="color:#555555;">}</font>
} } { “customerPaymentMethodId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=” }

Arguments

Argument Description
customerPaymentMethodId
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The ID of the customer payment method to be revoked.

Return fields

  • revokedCustomerPaymentMethodId ([ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    The ID of the revoked customer payment method.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.