Skip to content

customerseat.md

Latest commit

 

History

History
44 lines (39 loc) · 10.1 KB

customerseat.md

File metadata and controls

44 lines (39 loc) · 10.1 KB

CustomerSeat

Example Usage

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

let value: CustomerSeat = {
  createdAt: new Date("2025-02-10T15:22:33.873Z"),
  modifiedAt: new Date("2026-10-09T03:50:35.674Z"),
  id: "1f465dbd-351b-4777-90e1-11283ba41d87",
  status: "claimed",
  member: {
    id: "<value>",
    createdAt: new Date("2026-04-15T16:04:23.824Z"),
    modifiedAt: new Date("2025-04-16T17:12:33.507Z"),
    customerId: "<value>",
    email: "member@example.com",
    name: "Jane Doe",
    externalId: "usr_1337",
    role: "member",
  },
};

Fields

Field Type Required Description
createdAt Date ✔️ Creation timestamp of the object.
modifiedAt Date ✔️ Last modification timestamp of the object.
id string ✔️ The seat ID
subscriptionId string ➖ The subscription ID (for recurring seats)
orderId string ➖ The order ID (for one-time purchase seats)
status components.SeatStatus ✔️ N/A
customerId string ➖ The customer ID. When member_model_enabled is true, this is the billing customer (purchaser). When false, this is the seat member customer.
memberId string ➖ The member ID of the seat occupant
member components.Member ➖ The member associated with this seat
email string ➖ Email of the seat member (set when member_model_enabled is true)
customerEmail string ➖ The assigned customer email
invitationTokenExpiresAt Date ➖ When the invitation token expires
claimedAt Date ➖ When the seat was claimed
revokedAt Date ➖ When the seat was revoked
seatMetadata Record<string, any> ➖ Additional metadata for the seat