Customer Address Preferences Object

The customer address preferences object acts as a link between a customer resource and their billing and (optionally) shipping addresses. The preferences resource returns both billing and shipping addresses if they exist along with other address related information like which address should be used for shipping or the optional fields for the contact name and shipping instructions.

Customer Address Preferences Fields

PropertyTypeDescription
contactNameStringThis is an optional field for storing the contact name of the recipient, if different from the name included in the address itself.
shippingInstructionsStringThis free text field allows you to add shipping instructions.
useBillingAddressAsShippingAddressBoolean

This determines if this resource will have both a shipping and billing address.

If true, the shipping Address (Address object with addressType of shipping) is hidden in the Admin UI. The shipping address will still be returned in a call to Read Address Preferences. For functionality such ask tax calculations, the Billing address will be used instead.

If false, the shipping address is also displayed in the UI and, if the account level settings are set to show the shipping address, both addresses will appear on all invoices. Note that shipping instructions will appear in the notes section of all invoices.

billingAddressObject. Defined in Shipping/Billing Address ObjectThe billing address
shippingAddressObject. Defined in Shipping/Billing Address ObjectThe shipping address
idIntegerThe Fusebill generated ID of the customer
uriStringFull path to the customer address preference object.