customerPaymentMethodRevoke mutation

Version unstable

Revokes a customer's payment method.

Required access

write_customers access scope. Also: Requires write_customer_payment_methods 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

Argument Description
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 from executing the mutation.

Version 2021-10 (Release candidate)

Revokes a customer's payment method.

Required access

write_customers access scope. Also: Requires write_customer_payment_methods 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

Argument Description
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 from executing the mutation.

Version 2021-07 (Latest)

Revokes a customer's payment method.

Required access

write_customers access scope. Also: Requires write_customer_payment_methods 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