Choose a version:

customerPaymentMethodRevoke

mutation

Requires write_customers access scope. Also: Requires write_customer_payment_methods scope.

Revokes a customer's vaulted payment method, preventing it from being used for future charges such as subscriptions, draft orders, or other payments. Revocation will fail if the payment method has active subscription contracts. Use this when a customer requests removal of their stored payment information or when a payment method is no longer valid.

Anchor to Arguments

Arguments

Anchor to customerPaymentMethodIdcustomerPaymentMethodId •ID! required: The ID of the customer payment method to be revoked.

Was this section helpful?

Anchor to CustomerPaymentMethodRevokePayload returnsCustomerPaymentMethodRevokePayload returns

Anchor to revokedCustomerPaymentMethodIdrevokedCustomerPaymentMethodId •ID: The ID of the revoked customer payment method.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

customerPaymentMethodRevoke reference

Mutation Reference

mutation customerPaymentMethodRevoke($customerPaymentMethodId: ID!) {

customerPaymentMethodRevoke(customerPaymentMethodId: $customerPaymentMethodId) {

revokedCustomerPaymentMethodId

userErrors {

field

message

}

Input

{

"customerPaymentMethodId": "gid://shopify/<objectName>/10079785100"

}