The customer address object

A comprehensive list of the customer address resource's attributes and relationships

A customer address object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/customer_addresses endpoint.

Fields

Field	Type	Description
type	string	customer_addresses
id	string	The customer address unique identifier
links.self	string	The customer address endpoint URL
attributes.name	string	Returns the associated address' name.
attributes.customer_email	string	The email of the customer associated to the address.
attributes.created_at	datetime	Time at which the resource was created.
attributes.updated_at	datetime	Time at which the resource was last updated.
attributes.reference	string	A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin	string	Any identifier of the third party system that defines the reference code.
attributes.metadata	object	Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
relationships.customer	object	The associated customer.
relationships.address	object	The associated address.
relationships.events	array	The associated events.
relationships.versions	array	The associated changes.
relationships.event_stores	array	The associated event stores.
meta.mode	string	The resource environment (can be one of test or live)