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.

  1. PHP
$result = $gateway->address()->delete('theCustomerId', 'theAddressId');

$result->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, you'll receive a Braintree\Exception\NotFound exception.

Arguments
addressIdrequired, string
The two-letter value for an address associated with a specific customer ID. The maximum number of addresses per customer is 50.
customerIdrequired, string
A string value representing an existing customer in your Vault.
paymentInstrumentLinkedBillingAddress, bool

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

Additional Parameters
'phoneNumber'string
The phone number that belongs to the address. Phone number must be 10-14 characters and can only contain numbers, hyphens and parentheses.