Skip to main content

WorkspacePlanDetails

type WorkspacePlanDetails = {
cancelAtPeriodEnd: boolean;
currentActiveProjects: number;
currentMemberCount: number;
currentPlan: "Business" | "Starter";
currentPlanStatus: "Active" | "Downgraded" | "Cancelled" | "NeverSubscribed";
downgradeAt: string | null;
hasBillingPortal: boolean;
hasBillingPortalSwitchToAnnual: boolean;
hasTrialed: boolean;
isTrialing: boolean;
maximumActiveProjects: number;
planPrice: | {
amount: string | number;
currency: string;
interval?: string;
}
| null;
priceList: {
amount?: number;
currency?: string;
formatted?: string;
interval?: string;
}[];
trialEndsAt: string | null;
workspaceId: string;
};

Represents workspace plan and billing details.

Type Declaration

NameTypeDefault value
cancelAtPeriodEndboolean-
currentActiveProjectsnumber-
currentMemberCountnumber-
currentPlan"Business" | "Starter"-
currentPlanStatus"Active" | "Downgraded" | "Cancelled" | "NeverSubscribed"-
downgradeAtstring | null-
hasBillingPortalboolean-
hasBillingPortalSwitchToAnnualboolean-
hasTrialedboolean-
isTrialingboolean-
maximumActiveProjectsnumber-
planPrice| { amount: string | number; currency: string; interval?: string; } | null-
priceList{ amount?: number; currency?: string; formatted?: string; interval?: string; }[]-
trialEndsAtstring | null-
workspaceIdstringStringOrNumberSchema