API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

customerPaymentMethodRevoke mutation

Version unstable

Revokes a customer's payment method.

Required access

write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

customerPaymentMethodId ( ID! ) required

The ID of the customer payment method to be revoked.

Return fields

revokedCustomerPaymentMethodId (ID)

The ID of the revoked customer payment method.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2021-01 (Release candidate)

Revokes a customer's payment method.

Required access

write_customers access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

customerPaymentMethodId ( ID! ) required

The ID of the customer payment method to be revoked.

Return fields

revokedCustomerPaymentMethodId (ID)

The ID of the revoked customer payment method.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.