Skip to content

Latest commit

 

History

History
85 lines (80 loc) · 17.2 KB

workspaceschema.md

File metadata and controls

85 lines (80 loc) · 17.2 KB

WorkspaceSchema

Example Usage

import { WorkspaceSchema } from "dub/models/components";

let value: WorkspaceSchema = {
  id: "<id>",
  name: "<value>",
  slug: "<value>",
  inviteCode: "<value>",
  plan: "business extra",
  stripeId: "<id>",
  billingCycleStart: 3842.73,
  paymentFailedAt: "<value>",
  stripeConnectId: "<id>",
  usage: 7034.07,
  usageLimit: 3530.75,
  linksUsage: 1544.25,
  linksLimit: 3126.9,
  salesUsage: 8843.25,
  salesLimit: 9585.33,
  domainsLimit: 2075.12,
  tagsLimit: 7884.69,
  usersLimit: 2733.49,
  aiUsage: 8871.32,
  aiLimit: 1655.45,
  conversionEnabled: false,
  dotLinkClaimed: false,
  partnersEnabled: false,
  createdAt: "1728353764045",
  users: [
    {
      role: "owner",
    },
  ],
  domains: [
    {
      slug: "acme.com",
    },
  ],
  store: {
    "key": "<value>",
  },
  allowedHostnames: [
    "dub.sh",
  ],
};

Fields

Field Type Required Description Example
id string ✔️ The unique ID of the workspace.
name string ✔️ The name of the workspace.
slug string ✔️ The slug of the workspace.
logo string ➖ The logo of the workspace.
inviteCode string ✔️ The invite code of the workspace.
plan components.Plan ✔️ The plan of the workspace.
stripeId string ✔️ The Stripe ID of the workspace.
billingCycleStart number ✔️ The date and time when the billing cycle starts for the workspace.
paymentFailedAt string ✔️ The date and time when the payment failed for the workspace.
stripeConnectId string ✔️ The Stripe Connect ID of the workspace.
usage number ✔️ The usage of the workspace.
usageLimit number ✔️ The usage limit of the workspace.
linksUsage number ✔️ The links usage of the workspace.
linksLimit number ✔️ The links limit of the workspace.
salesUsage number ✔️ The dollar amount of tracked revenue in the current billing cycle (in cents).
salesLimit number ✔️ The limit of tracked revenue in the current billing cycle (in cents).
domainsLimit number ✔️ The domains limit of the workspace.
tagsLimit number ✔️ The tags limit of the workspace.
usersLimit number ✔️ The users limit of the workspace.
aiUsage number ✔️ The AI usage of the workspace.
aiLimit number ✔️ The AI limit of the workspace.
conversionEnabled boolean ✔️ Whether the workspace has conversion tracking enabled automatically for new links (d.to/conversions).
dotLinkClaimed boolean ✔️ Whether the workspace has claimed a free .link domain. (dub.link/free)
partnersEnabled boolean ✔️ Whether the workspace has Dub Partners enabled.
createdAt string ✔️ The date and time when the workspace was created.
users components.Users[] ✔️ The role of the authenticated user in the workspace.
domains components.Domains[] ✔️ The domains of the workspace.
flags Record<string, boolean> ➖ The feature flags of the workspace, indicating which features are enabled.
store Record<string, any> ✔️ The miscellaneous key-value store of the workspace.
allowedHostnames string[] ✔️ Specifies hostnames permitted for client-side click tracking. [
"dub.sh"
]