Skip to content

member.md

Latest commit

 

History

History
33 lines (27 loc) · 5.12 KB

member.md

File metadata and controls

33 lines (27 loc) · 5.12 KB

Member

A member of a customer.

Example Usage

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

let value: Member = {
  id: "<value>",
  createdAt: new Date("2026-07-16T23:20:52.758Z"),
  modifiedAt: new Date("2025-10-27T19:33:03.848Z"),
  customerId: "<value>",
  email: "member@example.com",
  name: "Jane Doe",
  externalId: "usr_1337",
  role: "billing_manager",
};

Fields

Field Type Required Description Example
id string ✔️ The ID of the member.
createdAt Date ✔️ Creation timestamp of the object.
modifiedAt Date ✔️ Last modification timestamp of the object.
customerId string ✔️ The ID of the customer this member belongs to.
email string ✔️ The email address of the member. member@example.com
name string ✔️ The name of the member. Jane Doe
externalId string ✔️ The ID of the member in your system. This must be unique within the customer. usr_1337
role components.MemberRole ✔️ N/A