Anchor to CustomerPaymentMethodRevokePayloadCustomer
payloadCustomer Payment Method Revoke Payload
Return type for mutation.
Anchor to FieldsFields
- revokedCustomerPaymentMethodId (ID)
- userErrors ([UserError!]!)
- Anchor to revokedCustomerPaymentMethodIdrevoked•ID
Customer Payment Method Id The ID of the revoked customer payment method.
- Anchor to userErrorsuser•[User
Errors Error!]! 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
- customerPaymentMethodRevoke (CustomerPaymentMethodRevokePayload)
- •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.
- Anchor to customerPaymentMethodIdcustomer•ID!
Payment Method Id required The ID of the customer payment method to be revoked.
Arguments
Was this section helpful?