Skip to content

Latest commit

 

History

History
50 lines (44 loc) · 12.6 KB

customer.md

File metadata and controls

50 lines (44 loc) · 12.6 KB

Customer

A customer in an organization.

Example Usage

import { Customer } from "@polar-sh/sdk/models/components/customer.js";

let value: Customer = {
  id: "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
  createdAt: new Date("2025-11-13T07:16:15.727Z"),
  modifiedAt: new Date("2023-12-13T22:32:12.208Z"),
  metadata: {
    "key": false,
  },
  externalId: "usr_1337",
  email: "[email protected]",
  emailVerified: true,
  name: "John Doe",
  billingAddress: {
    country: "US",
  },
  taxId: [
    "FR61954506077",
    "eu_vat",
  ],
  organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  deletedAt: new Date("2025-04-03T03:09:12.985Z"),
  avatarUrl: "https://www.gravatar.com/avatar/xxx?d=blank",
};

Fields

Field Type Required Description Example
id string ✔️ The ID of the customer. 992fae2a-2a17-4b7a-8d9e-e287cf90131b
createdAt Date ✔️ Creation timestamp of the object.
modifiedAt Date ✔️ Last modification timestamp of the object.
metadata Record<string, components.CustomerMetadata1> ✔️ N/A
externalId string ✔️ The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated. usr_1337
email string ✔️ The email address of the customer. This must be unique within the organization. [email protected]
emailVerified boolean ✔️ Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address. true
name string ✔️ The name of the customer. John Doe
billingAddress components.Address ✔️ N/A
taxId components.CustomerTaxId[] ✔️ N/A [
"911144442",
"us_ein"
]
organizationId string ✔️ The ID of the organization owning the customer. 1dbfc517-0bbf-4301-9ba8-555ca42b9737
deletedAt Date ✔️ Timestamp for when the customer was soft deleted.
avatarUrl string ✔️ N/A https://www.gravatar.com/avatar/xxx?d=blank