Description
The Account object contains information about a customer account record for the Store.
ℹ️ Note
This object supports custom data via the data attribute.
Attributes
| Attribute | Type | Description |
|---|---|---|
account_credits |
List[AccountCredit] | Returns a list of the Account's Account Credits |
account_points |
AccountPoints | Returns the AccountPoints object for this Account |
active? |
Boolean | Indicates whether this Account is active |
billing_address_lines |
List[String] | Returns a list of all the address lines in the Billing Street |
billing_city |
String | Returns the value of the City attribute of the Billing Address |
billing_country |
String | Returns the value of the Country attribute of the Billing Address |
billing_postal_code |
String | Returns the value of the Postal Code attribute of the Billing Address |
billing_state |
String | Returns the value of the State attribute of the Billing Address |
billing_street |
String | Returns the value of the Street attribute of the Billing Address |
brand? |
Boolean | Indicates whether this Account is a brand |
credit_hold? |
Boolean | Indicates whether this Account is on credit hold |
id |
String | Returns the unique id for this Account |
location? |
Boolean | Indicates whether this Account has a location |
logo |
Image | Returns the logo Image for this Account |
membership |
Membership | Returns the associated Membership for this Account |
name |
String | Returns the value of the Name attribute |
orders |
List[Order] | Returns a list of Orders for this Account |
pay_by_account? |
Boolean | Indicates whether the Account is allowed to make purchases using Pay by Account |
phone |
String | Returns the value of the Phone attribute |
pricebook |
Pricebook | Returns the Pricebook object for this Account |
product_approvals |
List[ProductApproval] | Returns a list of ProductApprovals for this Account |
shipping_address_lines |
List[String] | Returns a list of all the address lines in the Shipping Street |
shipping_city |
String | Returns the value of the City attribute of the Shipping Address |
shipping_country |
String | Returns the value of the Country attribute of the Shipping Address |
shipping_postal_code |
String | Returns the value of the Postal Code attribute of the Shipping Address |
shipping_state |
String | Returns the value of the State attribute of the Shipping Address |
shipping_street |
String | Returns the value of the Street attribute of the Shipping Address |
subdomain |
String | Returns the subdomain for this Account |
supplier_notes |
String | Returns the supplier notes for this Supplier Account |
supplier? |
Boolean | Indicates whether this Account is a Supplier |
tax_entity_code |
String | Returns the tax entity code for this Account |