Skip to content

customerseat.md

Latest commit

 

History

History
58 lines (53 loc) · 10.6 KB

customerseat.md

File metadata and controls

58 lines (53 loc) · 10.6 KB
Raw

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",
  subscriptionId: "4cf58282-69d1-44c6-b6f9-4b33e2c4fc9b",
  orderId: "24f0b043-6aa6-4dcd-bcac-9017b0f9a669",
  status: "pending",
  customerId: "9ad66dec-1f70-4dd6-aff8-f89b917042f6",
  memberId: "259caad7-8ef4-4589-b00f-1f29959a711e",
  member: {
    id: "<value>",
    createdAt: new Date("2024-08-29T23:41:53.521Z"),
    modifiedAt: new Date("2024-05-20T19:39:16.494Z"),
    customerId: "<value>",
    email: "member@example.com",
    name: "Jane Doe",
    externalId: "usr_1337",
    role: "billing_manager",
  },
  email: "Damian_Shields0@hotmail.com",
  customerEmail: null,
  invitationTokenExpiresAt: new Date("2025-05-28T14:09:32.270Z"),
  claimedAt: new Date("2024-03-09T23:06:05.390Z"),
  revokedAt: null,
  seatMetadata: {
    "key": "<value>",
    "key1": "<value>",
    "key2": "<value>",
  },
};

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