User

A full reference to user type for different Liquid Commerce APIs.

UserType

Attribute	Description
id: string	user's identifier
email: string	user's email address
firstName: string	user's first name
lastName: string	user's last name
phone: string	user's phone number
company: string	user's company
profileImage: string	url to user's profile image
birthDate: string	users's birth date
createdAt: Date	account creation timestamp
updatedAt: Date	last update timestamp
addresses: Array<UserAddress>	user's saved addresses
savedPayments: Array<UserPayment>	user's saved payment methods

UserAddress

Attribute	Description
id: string	user address identifier
placesId: string	google places identifier
one: string	the primary street address or neighborhood
two: string	the secondary address information, such as apt or suit number
city: string	the name of the city
state: string	the name of the state or region
zip: string	the postal code
country: Date	the name of the country
lat: number	the latitude coordinate of the address
long: number	the longitude coordinate of the address
createdAt: Date	account creation timestamp
updatedAt: Date	last update timestamp
isDefault: boolean	whether this is the default address

UserPayment

Attribute	Description
id: string	user payment identifier
type: string	payment method type (e.g., credit card, paypal)
isDefault: boolean	whether this is the default payment method
card: SavedCard [optional]	card details if payment method is a card
createdAt: Date	payment method creation timestamp

SavedCard

Attribute	Description
brand: string	card brand (Visa, Mastercard, etc.)
country: string	card issuing country
expMonth: number	expiration month
expYear: number	expiration year
last4: string	last 4 digits of card number
funding: string	funding type (credit, debit, etc.)

Sample user

User Object

{
        "id": "userId_123abc12_123abc12",
        "email": "[email protected]",
        "firstName": "John",
        "company": "Liquid Commerce",
        "lastName": "Doe",
        "phone": "[phone]",
        "profileImage": "https://example.com/profiles/sarah.jpg",
        "birthDate": "1990-05-15",
        "createdAt": "2024-09-15T10:30:25.123Z",
        "updatedAt": "2024-11-12T16:45:32.891Z",
        "addresses": [
            {
                "id": "8d4e5f6g-7h8i-9j0k-lm12-34567890nopq",
                "type": "shipping",
                "one": "100 Madison Ave",
                "two": "Floor 23",
                "city": "New York",
                "state": "NY",
                "zip": "10166",
                "country": "US",
                "placesId": "ChIJKxDbe7lZwokRVf__________",
                "lat": 40.754542,
                "long": -73.976929,
                "isDefault": true,
                "createdAt": "2024-10-01T09:22:15.432Z",
                "updatedAt": "2024-11-10T11:15:44.789Z"
            }
        ],
        "savedPayments": [
            {
                "id": "pm_paymentId_123abc12",
                "type": "card",
                "isDefault": true,
                "card": {
                    "brand": "visa",
                    "country": "US",
                    "expMonth": 12,
                    "expYear": 20**,
                    "last4": "****",
                    "funding": "credit"
                },
                "createdAt": "2024-10-15T14:30:20.555Z"
            }
        ],
        "session": {
            "key": "pk_test_51AbCdEfGhIjKl_________",
            "secret": "seti_1AbCdEfGhIjKlM_________",
            "createdAt": "2024-11-12T16:45:32.891Z"
        }
    }