Skip to content

Latest commit

 

History

History
36 lines (33 loc) · 9.78 KB

workspaceschema.md

File metadata and controls

36 lines (33 loc) · 9.78 KB

WorkspaceSchema

Fields

Field Type Required Description
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 float64 ✔️ 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 ✔️ [BETA]: The Stripe Connect ID of the workspace.
Usage float64 ✔️ The usage of the workspace.
UsageLimit float64 ✔️ The usage limit of the workspace.
LinksUsage float64 ✔️ The links usage of the workspace.
LinksLimit float64 ✔️ The links limit of the workspace.
SalesUsage float64 ✔️ The dollar amount of tracked revenue in the current billing cycle (in cents).
SalesLimit float64 ✔️ The limit of tracked revenue in the current billing cycle (in cents).
DomainsLimit float64 ✔️ The domains limit of the workspace.
TagsLimit float64 ✔️ The tags limit of the workspace.
UsersLimit float64 ✔️ The users limit of the workspace.
AiUsage float64 ✔️ The AI usage of the workspace.
AiLimit float64 ✔️ The AI limit of the workspace.
ReferralLinkID string ✔️ The ID of the referral link of the workspace.
ConversionEnabled bool ✔️ Whether the workspace has conversion tracking enabled (d.to/conversions).
DotLinkClaimed bool ✔️ Whether the workspace has claimed a free .link domain. (dub.link/free)
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 map[string]bool The feature flags of the workspace, indicating which features are enabled.
PublishableKey string ✔️ The publishable key of the workspace.