Customer

A Customer represents an end customer within your Liftoff account.

Properties

Name

Type

Description

Id

int

The ID of the customer.

AccountId

int

The ID of the account that the customer belongs to. (Note: This account ID will always correspond to the account code you use in your authentication credentials.)

Account (via $expand)

Account

The account that the customer belongs to.

Email

string

The email of the customer. The customer's email also serves as the customer's username for login purposes.

Password

string

The password for the customer. Note: This is a write-only value supported only by the Add customer and Update customer methods. Passwords are stored using one-way encryption and cannot be decrypted. Therefore, passwords are never included in any responses.

Name

string

The full name of the customer.

CreateDate

datetimeoffset

The date the customer was created.

LastModifiedDate

datetimeoffset

The date the customer was most recently modified.

LastLoginDate

datetimeoffset

The date the customer most recently logged in.

IsActive

boolean

Flag that indicates whether the customer is active.

IsGuest

boolean

Flag that indicates whether the customer is a guest.

CurrencyCode

string

The 3-character currency code (e.g., USD) assigned to the customer.

CustomerId

string

Internal identifier for the customer (e.g., to map the customer to a record in an ERP system).

TaxExempt

boolean

Flag that indicates whether the customer is tax exempt.

OpenAccount

boolean

Flag that indicates whether the customer may submit orders without payment up front.

EnableCreditCards

boolean

Flag that indicates whether the customer may pay via credit card.

EnableBudgets

boolean

Flag that indicates whether the customer may pay via gift card or budget.

EnableDiscounts

boolean

Flag that indicates whether the customer may apply discount codes to orders.

ForcePasswordReset

boolean

Flag that indicates whether the customer is required to reset their password at their next login attempt.

AllowBillingAddressManagement

boolean

Flag that indicates whether the customer may add, edit, and delete billing addresses.

AllowShippingAddressManagement

boolean

Flag that indicates whether the customer may add, edit, and delete shipping addresses.

BillingAddresses (via $expand)

CustomerBillingAddress array

The collection of billing addresses for the customer.

ShippingAddresses (via $expand)

CustomerShippingAddress array

The collection of shipping addresses for the customer.