Skip to main content
Anchor to customerPaymentMethodRevoke

customerPaymentMethodRevoke

mutation

Requires write_customers access scope. Also: Requires write_customer_payment_methods scope.

Revokes a customer's payment method.

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?