Address

Address: Delete

Addresses are uniquely identified by a customer id and an address id, so you need both of these fields to delete an address.

Python

result = gateway.address.delete("the_customer_id", 'the_address_id')

result.is_success
# True

Note

When an address is deleted from a customer, it is also removed from any Vault payment methods that reference the address for billing or shipping.

If the address or customer can't be found, it will throw a NotFoundError exception.

address_idrequired, str

The two-letter value for an address associated with a specific customer ID. The maximum number of addresses per customer is 50.

customer_idrequired, str

A string value representing an existing customer in your Vault.

payment_instrument_linked_billing_addressbool

When True, the address will not be deleted if it is the billing address for a payment instrument.