Skip to main content
Anchor to CustomerPaymentMethodRevokePayload

CustomerPaymentMethodRevokePayload

payload

Return type for customerPaymentMethodRevoke mutation.

Anchor to FieldsFields

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?

Anchor to Mutations with this payloadMutations with this payload

Anchor to customerPaymentMethodRevokecustomerPaymentMethodRevoke
•mutation

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.

Arguments

Anchor to customerPaymentMethodIdcustomerPaymentMethodId
•ID!
required

The ID of the customer payment method to be revoked.

Was this section helpful?