Skip to main content
Removes a saved payment method, detaching it permanently. Find the right payment_method_id with list_payment_methods; to add a replacement later, use setup_payment_method.

​
Parameters

ParameterTypeRequiredDescription
payment_method_idstringYesThe payment method ID to remove, like pm_xxx.

​
Returns

A confirmation that the payment method was removed, echoing the paymentMethodId with status: "removed". Removal is permanent, so the card would need to be saved again with setup_payment_method if the user wants it back.

​
Example

{ "name": "remove_payment_method", "arguments": { "payment_method_id": "pm_1AbCdEfGhIjKlMnO" } }