Authenticated Account

API

AuthenticatedAccount

• customer

  Provides the customer information of the authenticated customer.

  StatefulRemoteSubscribable<Customer | undefined>

• purchasingCompany

  Provides the company info of the authenticated business customer. If the customer is not authenticated or is not a business customer, this value is `undefined`.

  StatefulRemoteSubscribable<PurchasingCompany | undefined>

export interface AuthenticatedAccount {
  /**
   * Provides the company info of the authenticated business customer.
   * If the customer is not authenticated or is not a business customer, this value is `undefined`.
   */
  purchasingCompany: StatefulRemoteSubscribable<PurchasingCompany | undefined>;
  /**
   * Provides the customer information of the authenticated customer.
   */
  customer: StatefulRemoteSubscribable<Customer | undefined>;
}

Customer

Information about the authenticated customer. {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).

• id

  Customer ID.

  string

export interface Customer {
  /**
   * Customer ID.
   *
   * @example 'gid://shopify/Customer/123'
   */
  id: string;
}

PurchasingCompany

• company

  Include information of the company of the logged in business customer.

  Company

export interface PurchasingCompany {
  /**
   * Include information of the company of the logged in business customer.
   */
  company: Company;
}

Company

• id

  Company ID.

  string

export interface Company {
  /**
   * Company ID.
   */
  id: string;
}