customerPaymentMethodRevoke
mutation

Choose a version:

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?

Code examples for MUTATION: customerPaymentMethodRevoke

Query Reference for MUTATION: customerPaymentMethodRevoke

"mutation customerPaymentMethodRevoke($customerPaymentMethodId: ID!) {\n  customerPaymentMethodRevoke(customerPaymentMethodId: $customerPaymentMethodId) {\n    revokedCustomerPaymentMethodId\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: customerPaymentMethodRevoke

"{\n  \"customerPaymentMethodId\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: customerPaymentMethodRevoke

""

Display Examples for MUTATION: customerPaymentMethodRevoke

[]

customerPaymentMethodRevokemutation

Arguments

CustomerPaymentMethodRevokePayload returns

customerPaymentMethodRevoke
mutation