Anchor to section titled 'undefined'

customerPaymentMethodRevoke
mutation

Requires write_customers access scope. Also: Requires write_customer_payment_methods scope.

Revokes a customer's payment method.

Anchor to section titled 'Arguments'

Arguments

Anchor to customerPaymentMethodId
customerPaymentMethodId
ID!
required

The ID of the customer payment method to be revoked.

Was this section helpful?
Anchor to section titled 'CustomerPaymentMethodRevokePayload returns'

CustomerPaymentMethodRevokePayload returns

Anchor to CustomerPaymentMethodRevokePayload.revokedCustomerPaymentMethodId
revokedCustomerPaymentMethodId
ID

The ID of the revoked customer payment method.

Anchor to CustomerPaymentMethodRevokePayload.userErrors
userErrors
[UserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation customerPaymentMethodRevoke($customerPaymentMethodId: ID!) {
  customerPaymentMethodRevoke(customerPaymentMethodId: $customerPaymentMethodId) {
    revokedCustomerPaymentMethodId
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "customerPaymentMethodId": "gid://shopify/<objectName>/10079785100"
}