@doist/todoist-sdk 10.2.0 → 10.3.0

package/dist/cjs/authentication.js

@@ -30,6 +30,8 @@ exports.PERMISSIONS = [
     'data:delete',
     'project:delete',
     'backups:read',
+    'billing:read',
+    'billing:read_write',
     'dev:app_console',
 ];
 /** Supported token endpoint authentication methods for dynamic client registration. */

package/dist/cjs/clients/billing-client.js

@@ -0,0 +1,152 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BillingClient = void 0;
+const endpoints_1 = require("../consts/endpoints");
+const http_client_1 = require("../transport/http-client");
+const validators_1 = require("../utils/validators");
+const base_client_1 = require("./base-client");
+/**
+ * Internal sub-client handling all billing-domain endpoints.
+ *
+ * Instantiated by `TodoistApi`; every public billing method on `TodoistApi`
+ * delegates here. See `todoist-api.ts` for the user-facing JSDoc.
+ */
+class BillingClient extends base_client_1.BaseClient {
+    async getSubscriptionInfo() {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_PAYMENTS_SUBSCRIPTION_INFO,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+        });
+        return (0, validators_1.validateSubscriptionInfo)(response.data);
+    }
+    async cancelPlan(args, requestId) {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_PAYMENTS_CANCEL_PLAN,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return response.data;
+    }
+    async reactivatePlan(requestId) {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_PAYMENTS_REACTIVATE_PLAN,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return (0, validators_1.validateSubscriptionInfo)(response.data);
+    }
+    async upgradeToPro(args, requestId) {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_PRO_UPGRADE,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return response.data;
+    }
+    async startProTrial(args, requestId) {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_PRO_TRIAL,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return response.data;
+    }
+    async createProBillingPortalSession(args, requestId) {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_PRO_BILLING_PORTAL,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return response.data;
+    }
+    async getProPlanDetails() {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_PRO_PLAN_DETAILS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+        });
+        return (0, validators_1.validateProPlanDetails)(response.data);
+    }
+    async upgradeWorkspace(args, requestId) {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_WORKSPACE_UPGRADE,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return response.data;
+    }
+    async startWorkspaceTrial(args, requestId) {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_WORKSPACE_TRIAL,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return response.data;
+    }
+    async createWorkspaceBillingPortalSession(args, requestId) {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_WORKSPACE_BILLING_PORTAL,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return response.data;
+    }
+    async getPrices() {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_PRICES,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+        });
+        return (0, validators_1.validatePrices)(response.data);
+    }
+    async getPricing(args) {
+        const response = await (0, http_client_1.request)({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: endpoints_1.ENDPOINT_PRICING,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return (0, validators_1.validatePricing)(response.data);
+    }
+}
+exports.BillingClient = BillingClient;

package/dist/cjs/consts/endpoints.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ENDPOINT_REST_ID_MAPPINGS = exports.ENDPOINT_REST_EMAILS = exports.ENDPOINT_REST_BACKUPS_DOWNLOAD = exports.ENDPOINT_REST_BACKUPS = exports.ENDPOINT_REST_ACCESS_TOKENS_MIGRATE = exports.ENDPOINT_REST_TEMPLATES_IMPORT_FROM_ID = exports.ENDPOINT_REST_TEMPLATES_IMPORT_FROM_FILE = exports.ENDPOINT_REST_TEMPLATES_CREATE_FROM_FILE = exports.ENDPOINT_REST_TEMPLATES_URL = exports.ENDPOINT_REST_TEMPLATES_FILE = exports.ENDPOINT_REST_TASKS_COMPLETED = exports.ENDPOINT_REST_PROJECTS_MOVE_TO_PERSONAL = exports.ENDPOINT_REST_PROJECTS_MOVE_TO_WORKSPACE = exports.SECTION_UNARCHIVE = exports.SECTION_ARCHIVE = exports.ENDPOINT_REST_PROJECT_JOIN = exports.ENDPOINT_REST_PROJECT_FULL = exports.ENDPOINT_REST_PROJECTS_PERMISSIONS = exports.ENDPOINT_REST_PROJECTS_ARCHIVED_COUNT = exports.PROJECT_UNARCHIVE = exports.PROJECT_ARCHIVE = exports.ENDPOINT_REST_UPLOADS = exports.ENDPOINT_REST_ACTIVITIES = exports.ENDPOINT_REST_PRODUCTIVITY = exports.ENDPOINT_REST_USER = exports.ENDPOINT_REST_PROJECT_COLLABORATORS = exports.ENDPOINT_REST_PROJECTS_ARCHIVED = exports.ENDPOINT_REST_PROJECTS_SEARCH = exports.ENDPOINT_REST_PROJECTS = exports.ENDPOINT_REST_TASK_MOVE = exports.ENDPOINT_REST_TASK_REOPEN = exports.ENDPOINT_REST_TASK_CLOSE = exports.ENDPOINT_REST_LOCATION_REMINDERS = exports.ENDPOINT_REST_REMINDERS = exports.ENDPOINT_REST_COMMENTS = exports.ENDPOINT_REST_LABELS_SHARED_REMOVE = exports.ENDPOINT_REST_LABELS_SHARED_RENAME = exports.ENDPOINT_REST_LABELS_SHARED = exports.ENDPOINT_REST_LABELS_SEARCH = exports.ENDPOINT_REST_LABELS = exports.ENDPOINT_REST_SECTIONS_SEARCH = exports.ENDPOINT_REST_SECTIONS = exports.ENDPOINT_REST_TASKS_COMPLETED_SEARCH = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_DUE_DATE = exports.ENDPOINT_REST_TASKS_COMPLETED_BY_COMPLETION_DATE = exports.ENDPOINT_REST_TASKS_FILTER = exports.ENDPOINT_REST_TASKS = exports.API_BASE_URI = exports.API_VERSION = exports.TODOIST_WEB_URI = void 0;
-exports.APP_ICON_SIZES = exports.ENDPOINT_REST_USER_AUTHORIZATIONS_DELETE = exports.ENDPOINT_REST_USER_AUTHORIZATIONS = exports.ENDPOINT_REST_APPS_UI_EXTENSIONS_INSTALLED = exports.ENDPOINT_REST_APPS_UI_EXTENSIONS = exports.ENDPOINT_REST_APPS_INSTALLATIONS = exports.ENDPOINT_REST_APPS = exports.ENDPOINT_WORKSPACE_MEMBERS = exports.ENDPOINT_WORKSPACE_USERS = exports.ENDPOINT_WORKSPACE_PLAN_DETAILS = exports.ENDPOINT_WORKSPACE_LOGO = exports.ENDPOINT_WORKSPACE_JOIN = exports.ENDPOINT_WORKSPACE_INVITATIONS_DELETE = exports.ENDPOINT_WORKSPACE_INVITATIONS_ALL = exports.ENDPOINT_WORKSPACE_INVITATIONS = exports.ENDPOINT_REST_WORKSPACES = exports.GOAL_TASKS = exports.GOAL_UNCOMPLETE = exports.GOAL_COMPLETE = exports.ENDPOINT_REST_GOALS_SEARCH = exports.ENDPOINT_REST_GOALS = exports.ENDPOINT_REST_FOLDERS = exports.ENDPOINT_REGISTER = exports.ENDPOINT_REVOKE = exports.ENDPOINT_GET_TOKEN = exports.ENDPOINT_AUTHORIZATION = exports.ENDPOINT_SYNC = exports.ENDPOINT_SYNC_QUICK_ADD = exports.ENDPOINT_REST_MOVED_IDS = void 0;
+exports.APP_ICON_SIZES = exports.ENDPOINT_REST_USER_AUTHORIZATIONS_DELETE = exports.ENDPOINT_REST_USER_AUTHORIZATIONS = exports.ENDPOINT_REST_APPS_UI_EXTENSIONS_INSTALLED = exports.ENDPOINT_REST_APPS_UI_EXTENSIONS = exports.ENDPOINT_REST_APPS_INSTALLATIONS = exports.ENDPOINT_REST_APPS = exports.ENDPOINT_WORKSPACE_MEMBERS = exports.ENDPOINT_PRICING = exports.ENDPOINT_PRICES = exports.ENDPOINT_WORKSPACE_BILLING_PORTAL = exports.ENDPOINT_WORKSPACE_TRIAL = exports.ENDPOINT_WORKSPACE_UPGRADE = exports.ENDPOINT_PRO_PLAN_DETAILS = exports.ENDPOINT_PRO_BILLING_PORTAL = exports.ENDPOINT_PRO_TRIAL = exports.ENDPOINT_PRO_UPGRADE = exports.ENDPOINT_PAYMENTS_REACTIVATE_PLAN = exports.ENDPOINT_PAYMENTS_CANCEL_PLAN = exports.ENDPOINT_PAYMENTS_SUBSCRIPTION_INFO = exports.ENDPOINT_WORKSPACE_USERS = exports.ENDPOINT_WORKSPACE_PLAN_DETAILS = exports.ENDPOINT_WORKSPACE_LOGO = exports.ENDPOINT_WORKSPACE_JOIN = exports.ENDPOINT_WORKSPACE_INVITATIONS_DELETE = exports.ENDPOINT_WORKSPACE_INVITATIONS_ALL = exports.ENDPOINT_WORKSPACE_INVITATIONS = exports.ENDPOINT_REST_WORKSPACES = exports.GOAL_TASKS = exports.GOAL_UNCOMPLETE = exports.GOAL_COMPLETE = exports.ENDPOINT_REST_GOALS_SEARCH = exports.ENDPOINT_REST_GOALS = exports.ENDPOINT_REST_FOLDERS = exports.ENDPOINT_REGISTER = exports.ENDPOINT_REVOKE = exports.ENDPOINT_GET_TOKEN = exports.ENDPOINT_AUTHORIZATION = exports.ENDPOINT_SYNC = exports.ENDPOINT_SYNC_QUICK_ADD = exports.ENDPOINT_REST_MOVED_IDS = void 0;
 exports.getSyncBaseUri = getSyncBaseUri;
 exports.getApiRootBaseUri = getApiRootBaseUri;
 exports.getAuthBaseUri = getAuthBaseUri;
@@ -118,6 +118,19 @@ exports.ENDPOINT_WORKSPACE_JOIN = 'workspaces/join';
 exports.ENDPOINT_WORKSPACE_LOGO = 'workspaces/logo';
 exports.ENDPOINT_WORKSPACE_PLAN_DETAILS = 'workspaces/plan_details';
 exports.ENDPOINT_WORKSPACE_USERS = 'workspaces/users';
+// Billing endpoints
+exports.ENDPOINT_PAYMENTS_SUBSCRIPTION_INFO = 'payments/get_subscription_info';
+exports.ENDPOINT_PAYMENTS_CANCEL_PLAN = 'payments/cancel_plan_with_redirect_to_stripe';
+exports.ENDPOINT_PAYMENTS_REACTIVATE_PLAN = 'payments/reactivate_plan';
+exports.ENDPOINT_PRO_UPGRADE = 'pro/upgrade';
+exports.ENDPOINT_PRO_TRIAL = 'pro/trial';
+exports.ENDPOINT_PRO_BILLING_PORTAL = 'pro/billing_portal';
+exports.ENDPOINT_PRO_PLAN_DETAILS = 'pro/plan_details';
+exports.ENDPOINT_WORKSPACE_UPGRADE = 'workspaces/upgrade';
+exports.ENDPOINT_WORKSPACE_TRIAL = 'workspaces/trial';
+exports.ENDPOINT_WORKSPACE_BILLING_PORTAL = 'workspaces/billing_portal';
+exports.ENDPOINT_PRICES = 'prices';
+exports.ENDPOINT_PRICING = 'pricing';
 // Workspace invitation actions (require invite_code parameter)
 function getWorkspaceInvitationAcceptEndpoint(inviteCode) {
     return `workspaces/invitations/${inviteCode}/accept`;

package/dist/cjs/todoist-api.js

@@ -4,6 +4,7 @@ exports.TodoistApi = void 0;
 const activity_client_1 = require("./clients/activity-client");
 const app_client_1 = require("./clients/app-client");
 const backup_client_1 = require("./clients/backup-client");
+const billing_client_1 = require("./clients/billing-client");
 const comment_client_1 = require("./clients/comment-client");
 const email_client_1 = require("./clients/email-client");
 const folder_client_1 = require("./clients/folder-client");
@@ -63,6 +64,7 @@ class TodoistApi {
         this.productivityClient = new productivity_client_1.ProductivityClient(clientDeps);
         this.workspaceClient = new workspace_client_1.WorkspaceClient(clientDeps);
         this.goalsClient = new goals_client_1.GoalsClient(clientDeps);
+        this.billingClient = new billing_client_1.BillingClient(clientDeps);
         this.appClient = new app_client_1.AppClient(clientDeps);
         this.uiExtensionClient = new ui_extension_client_1.UiExtensionClient(clientDeps);
     }
@@ -1043,6 +1045,143 @@ class TodoistApi {
     async unlinkTaskFromGoal(args, requestId) {
         return this.goalsClient.unlinkTaskFromGoal(args, requestId);
     }
+    // ── Billing ──
+    /**
+     * Retrieves the current user's subscription state.
+     *
+     * Requires the `billing:read` scope.
+     *
+     * @returns A promise that resolves to the user's subscription info.
+     */
+    async getSubscriptionInfo() {
+        return this.billingClient.getSubscriptionInfo();
+    }
+    /**
+     * Starts a hosted cancellation flow for the current user's plan.
+     *
+     * Requires the `billing:read_write` scope.
+     *
+     * @param args - Optional cancellation reason details and return URL.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the billing portal redirect URL.
+     */
+    async cancelPlan(args, requestId) {
+        return this.billingClient.cancelPlan(args, requestId);
+    }
+    /**
+     * Reactivates a previously canceled subscription.
+     *
+     * Requires the `billing:read_write` scope.
+     *
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the fresh subscription info after reactivation.
+     */
+    async reactivatePlan(requestId) {
+        return this.billingClient.reactivatePlan(requestId);
+    }
+    /**
+     * Creates a Stripe checkout session to upgrade the current user to Pro.
+     *
+     * Requires the `billing:read_write` scope.
+     *
+     * @param args - Currency, billing cycle, redirect URLs, and optional promotion/trial details.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the checkout session URL.
+     */
+    async upgradeToPro(args, requestId) {
+        return this.billingClient.upgradeToPro(args, requestId);
+    }
+    /**
+     * Creates a Stripe checkout session to start a Pro trial.
+     *
+     * Requires the `billing:read_write` scope.
+     *
+     * @param args - Currency, billing cycle, and redirect URLs.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the checkout session URL.
+     */
+    async startProTrial(args, requestId) {
+        return this.billingClient.startProTrial(args, requestId);
+    }
+    /**
+     * Creates a one-time Stripe billing portal session for the current user's Pro plan.
+     *
+     * Requires the `billing:read_write` scope.
+     *
+     * @param args - Return URL and optional flow type / promotion code.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the billing portal URL.
+     */
+    async createProBillingPortalSession(args, requestId) {
+        return this.billingClient.createProBillingPortalSession(args, requestId);
+    }
+    /**
+     * Retrieves the current user's Pro plan and billing details.
+     *
+     * Requires the `billing:read` scope.
+     *
+     * @returns A promise that resolves to the Pro plan details.
+     */
+    async getProPlanDetails() {
+        return this.billingClient.getProPlanDetails();
+    }
+    /**
+     * Creates a Stripe checkout session to upgrade a workspace.
+     *
+     * Requires the `billing:read_write` scope.
+     *
+     * @param args - Workspace ID, currency, billing cycle, redirect URLs, and optional promotion details.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the checkout session URL.
+     */
+    async upgradeWorkspace(args, requestId) {
+        return this.billingClient.upgradeWorkspace(args, requestId);
+    }
+    /**
+     * Creates a Stripe checkout session to start a workspace trial.
+     *
+     * Requires the `billing:read_write` scope.
+     *
+     * @param args - Workspace ID, currency, billing cycle, and redirect URLs.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the checkout session URL.
+     */
+    async startWorkspaceTrial(args, requestId) {
+        return this.billingClient.startWorkspaceTrial(args, requestId);
+    }
+    /**
+     * Creates a one-time Stripe billing portal session for a workspace.
+     *
+     * Requires the `billing:read_write` scope.
+     *
+     * @param args - Workspace ID, return URL, and optional flow type.
+     * @param requestId - Optional custom identifier for the request.
+     * @returns A promise that resolves to the billing portal URL.
+     */
+    async createWorkspaceBillingPortalSession(args, requestId) {
+        return this.billingClient.createWorkspaceBillingPortalSession(args, requestId);
+    }
+    /**
+     * Retrieves available Pro and Teams prices.
+     *
+     * Requires the `billing:read` scope.
+     *
+     * @returns A promise that resolves to the available prices.
+     */
+    async getPrices() {
+        return this.billingClient.getPrices();
+    }
+    /**
+     * Retrieves pricing information.
+     *
+     * Requires the `billing:read` scope.
+     *
+     * @param args - Optional flag to request formatted pricing.
+     * @returns A promise that resolves to current and legacy pricing keyed by version.
+     */
+    async getPricing(args) {
+        return this.billingClient.getPricing(args);
+    }
     // ── Backups ──
     /**
      * Retrieves a list of available backups.

package/dist/cjs/types/billing/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
+__exportStar(require("./requests"), exports);

package/dist/cjs/types/billing/requests.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/billing/types.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PricingResponseSchema = exports.PricingVersionSchema = exports.PricingTermsSchema = exports.PricesResponseSchema = exports.ProPlanDetailsSchema = exports.PriceListingSchema = exports.FormattedPriceSchema = exports.SubscriptionInfoSchema = exports.BillingPlanPriceSchema = exports.TAX_BEHAVIORS = exports.BILLING_CYCLES = exports.BILLING_ACTIVATION_METHODS = exports.BILLING_PLANS = exports.BILLING_SUBSCRIPTION_STATUSES = void 0;
+const zod_1 = require("zod");
+const types_1 = require("../workspaces/types");
+/** Available subscription statuses. */
+exports.BILLING_SUBSCRIPTION_STATUSES = [
+    'none',
+    'autorenew',
+    'canceled',
+    'expired',
+    'trial',
+    'trial_canceled',
+];
+/** Available plan tiers. */
+exports.BILLING_PLANS = ['free', 'pro', 'pro_gifted', 'pro_legacy'];
+/** Ways an active subscription can be purchased. */
+exports.BILLING_ACTIVATION_METHODS = [
+    'stripe',
+    'appstore',
+    'playstore',
+    'teams',
+    'manual',
+];
+/** Available billing cycles. */
+exports.BILLING_CYCLES = ['monthly', 'yearly'];
+/** Available tax behaviors for a price. */
+exports.TAX_BEHAVIORS = ['exclusive', 'inclusive', 'unspecified'];
+exports.BillingPlanPriceSchema = zod_1.z.object({
+    amount: zod_1.z.string(),
+    rawAmount: zod_1.z.number(),
+    currency: zod_1.z.string(),
+    billingCycle: zod_1.z.enum(exports.BILLING_CYCLES).nullable(),
+    taxBehavior: zod_1.z.enum(exports.TAX_BEHAVIORS),
+});
+exports.SubscriptionInfoSchema = zod_1.z.object({
+    status: zod_1.z.enum(exports.BILLING_SUBSCRIPTION_STATUSES),
+    plan: zod_1.z.enum(exports.BILLING_PLANS),
+    expirationDate: zod_1.z.string().nullable(),
+    activationMethod: zod_1.z.enum(exports.BILLING_ACTIVATION_METHODS),
+    planPrice: exports.BillingPlanPriceSchema.nullable(),
+    billingPortalUrl: zod_1.z.string().nullable(),
+    billingPortalSwitchToAnnualUrl: zod_1.z.string().nullable(),
+    hasBillingPortal: zod_1.z.boolean(),
+    hasBillingPortalSwitchToAnnual: zod_1.z.boolean(),
+    invoiceCreditBalance: zod_1.z.record(zod_1.z.string(), zod_1.z.number().int()).nullable(),
+    hasSwitchLegacyToCurrent: zod_1.z.boolean(),
+});
+exports.FormattedPriceSchema = zod_1.z.object({
+    currency: zod_1.z.string(),
+    unitAmount: zod_1.z.number().int(),
+    taxBehavior: zod_1.z.enum(exports.TAX_BEHAVIORS),
+});
+exports.PriceListingSchema = zod_1.z.object({
+    billingCycle: zod_1.z.enum(exports.BILLING_CYCLES),
+    prices: zod_1.z.array(exports.FormattedPriceSchema),
+});
+exports.ProPlanDetailsSchema = zod_1.z.object({
+    currentPlanStatus: zod_1.z.enum(types_1.WORKSPACE_PLAN_STATUSES),
+    downgradeAt: zod_1.z.string().nullable(),
+    priceList: zod_1.z.array(exports.PriceListingSchema),
+});
+exports.PricesResponseSchema = zod_1.z.object({
+    pro: zod_1.z.array(exports.PriceListingSchema),
+    teams: zod_1.z.array(exports.PriceListingSchema),
+});
+/**
+ * Monthly and yearly amounts for a single currency. Each amount is a number in
+ * the currency's smallest unit, or a localized formatted string when the
+ * `pricing` endpoint is called with `formatted: true`.
+ */
+exports.PricingTermsSchema = zod_1.z.object({
+    monthly: zod_1.z.union([zod_1.z.number(), zod_1.z.string()]),
+    yearly: zod_1.z.union([zod_1.z.number(), zod_1.z.string()]),
+});
+/**
+ * A pricing version entry: plan name (`pro` / `biz`) → currency code →
+ * {@link PricingTerms}.
+ */
+exports.PricingVersionSchema = zod_1.z.record(zod_1.z.string(), zod_1.z.record(zod_1.z.string(), exports.PricingTermsSchema));
+/**
+ * Response of the `pricing` endpoint: fixed version-pointer string fields plus
+ * dynamic version keys (`v1`, `v2`, …), each a {@link PricingVersion}.
+ */
+exports.PricingResponseSchema = zod_1.z
+    .object({
+    latestPro: zod_1.z.string(),
+    latestBiz: zod_1.z.string(),
+    sessionPro: zod_1.z.string(),
+    sessionBiz: zod_1.z.string(),
+})
+    .catchall(exports.PricingVersionSchema);

package/dist/cjs/types/index.js

@@ -26,6 +26,7 @@ __exportStar(require("./activity"), exports);
 __exportStar(require("./workspaces"), exports);
 __exportStar(require("./folders"), exports);
 __exportStar(require("./goals"), exports);
+__exportStar(require("./billing"), exports);
 __exportStar(require("./insights"), exports);
 __exportStar(require("./backups"), exports);
 __exportStar(require("./id-mappings"), exports);

package/dist/cjs/utils/validators.js

@@ -2,25 +2,27 @@
 var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateFolder = exports.validateCollaboratorStateArray = exports.validateCollaboratorState = exports.validateCollaboratorArray = exports.validateCollaborator = exports.validateFilterArray = exports.validateFilter = exports.validateMovedIdArray = exports.validateMovedId = exports.validateIdMappingArray = exports.validateIdMapping = exports.validateBackupArray = exports.validateBackup = exports.validateWorkspaceInsights = exports.validateProjectProgress = exports.validateProjectHealthContext = exports.validateProjectHealth = exports.validateProjectActivityStats = exports.validateWorkspaceUserTaskArray = exports.validateWorkspaceUserTask = exports.validateMemberActivityInfoArray = exports.validateMemberActivityInfo = exports.validateWorkspaceArray = exports.validateWorkspace = exports.validateJoinWorkspaceResult = exports.validateWorkspacePlanDetails = exports.validateWorkspaceInvitationArray = exports.validateWorkspaceInvitation = exports.validateWorkspaceUserArray = exports.validateWorkspaceUser = exports.validateAttachment = exports.validateActivityEventArray = exports.validateActivityEvent = exports.validateCurrentUser = exports.validateProductivityStats = exports.validateUserArray = exports.validateUser = exports.validateCommentArray = exports.validateComment = exports.validateLabelArray = exports.validateLabel = exports.validateSectionArray = exports.validateSection = exports.validateWorkspaceProjectArray = exports.validateWorkspaceProject = exports.validateProjectArray = exports.validateProject = exports.validateTaskArray = exports.validateTask = exports.IdSchema = void 0;
-exports.validateUiExtensionArray = exports.validateUiExtension = exports.validateUserAuthorizationArray = exports.validateUserAuthorization = exports.validateAppInstallationArray = exports.validateAppInstallation = exports.validateAppWebhook = exports.validateAppByDistributionToken = exports.validateAppDistributionToken = exports.validateAppTestToken = exports.validateAppVerificationToken = exports.validateAppSecrets = exports.validateAppWithUserCount = exports.validateAppArray = exports.validateApp = exports.validateSuggestionArray = exports.validateSuggestion = exports.validateUserSettings = exports.validateSyncUser = exports.validateSyncWorkspaceArray = exports.validateSyncWorkspace = exports.validateLiveNotificationArray = exports.validateLiveNotification = exports.validateUserPlanLimits = exports.validateProjectViewOptionsDefaultsArray = exports.validateProjectViewOptionsDefaults = exports.validateViewOptionsArray = exports.validateViewOptions = exports.validateCompletedInfoArray = exports.validateCompletedInfo = exports.validateLocationReminderArray = exports.validateLocationReminder = exports.validateReminderArray = exports.validateReminder = exports.validateCalendarAccountArray = exports.validateCalendarAccount = exports.validateCalendarArray = exports.validateCalendar = exports.validateWorkspaceGoalArray = exports.validateWorkspaceGoal = exports.validateWorkspaceFilterArray = exports.validateWorkspaceFilter = exports.validateTooltips = exports.validateNoteArray = exports.validateNote = exports.validateGoalArray = exports.validateGoal = exports.validateFolderArray = void 0;
+exports.validateUserAuthorizationArray = exports.validateUserAuthorization = exports.validateAppInstallationArray = exports.validateAppInstallation = exports.validateAppWebhook = exports.validateAppByDistributionToken = exports.validateAppDistributionToken = exports.validateAppTestToken = exports.validateAppVerificationToken = exports.validateAppSecrets = exports.validateAppWithUserCount = exports.validateAppArray = exports.validateApp = exports.validateSuggestionArray = exports.validateSuggestion = exports.validateUserSettings = exports.validateSyncUser = exports.validateSyncWorkspaceArray = exports.validateSyncWorkspace = exports.validateLiveNotificationArray = exports.validateLiveNotification = exports.validateUserPlanLimits = exports.validateProjectViewOptionsDefaultsArray = exports.validateProjectViewOptionsDefaults = exports.validateViewOptionsArray = exports.validateViewOptions = exports.validateCompletedInfoArray = exports.validateCompletedInfo = exports.validateLocationReminderArray = exports.validateLocationReminder = exports.validateReminderArray = exports.validateReminder = exports.validateCalendarAccountArray = exports.validateCalendarAccount = exports.validateCalendarArray = exports.validateCalendar = exports.validateWorkspaceGoalArray = exports.validateWorkspaceGoal = exports.validateWorkspaceFilterArray = exports.validateWorkspaceFilter = exports.validateTooltips = exports.validateNoteArray = exports.validateNote = exports.validatePricing = exports.validatePrices = exports.validateProPlanDetails = exports.validateSubscriptionInfo = exports.validateGoalArray = exports.validateGoal = exports.validateFolderArray = void 0;
+exports.validateUiExtensionArray = exports.validateUiExtension = void 0;
 exports.parseSyncResponse = parseSyncResponse;
 const zod_1 = require("zod");
 const types_1 = require("../types/activity/types");
 const types_2 = require("../types/apps/types");
 const types_3 = require("../types/backups/types");
-const types_4 = require("../types/comments/types");
-const types_5 = require("../types/goals/types");
-const types_6 = require("../types/id-mappings/types");
-const types_7 = require("../types/insights/types");
-const types_8 = require("../types/labels/types");
-const types_9 = require("../types/productivity/types");
-const types_10 = require("../types/projects/types");
-const types_11 = require("../types/sections/types");
+const types_4 = require("../types/billing/types");
+const types_5 = require("../types/comments/types");
+const types_6 = require("../types/goals/types");
+const types_7 = require("../types/id-mappings/types");
+const types_8 = require("../types/insights/types");
+const types_9 = require("../types/labels/types");
+const types_10 = require("../types/productivity/types");
+const types_11 = require("../types/projects/types");
+const types_12 = require("../types/sections/types");
 const response_1 = require("../types/sync/response");
-const types_12 = require("../types/tasks/types");
-const types_13 = require("../types/ui-extensions/types");
-const types_14 = require("../types/users/types");
-const types_15 = require("../types/workspaces/types");
+const types_13 = require("../types/tasks/types");
+const types_14 = require("../types/ui-extensions/types");
+const types_15 = require("../types/users/types");
+const types_16 = require("../types/workspaces/types");
 const resources_1 = require("../types/sync/resources");
 function createValidator(schema) {
     return {
@@ -34,43 +36,48 @@ exports.IdSchema = zod_1.z
     .min(1)
     .refine((id) => !id.startsWith('tmp-'), { message: TMP_ID_MESSAGE });
 // Entity validators
-_a = createValidator(types_12.TaskSchema), exports.validateTask = _a.validate, exports.validateTaskArray = _a.validateArray;
+_a = createValidator(types_13.TaskSchema), exports.validateTask = _a.validate, exports.validateTaskArray = _a.validateArray;
 /**
  * Validates and parses a project input.
  * @param input The input to validate
  * @returns A validated project (either PersonalProject or WorkspaceProject)
  */
-_b = createValidator(types_10.ProjectSchema), exports.validateProject = _b.validate, exports.validateProjectArray = _b.validateArray;
-_c = createValidator(types_10.WorkspaceProjectSchema), exports.validateWorkspaceProject = _c.validate, exports.validateWorkspaceProjectArray = _c.validateArray;
-_d = createValidator(types_11.SectionSchema), exports.validateSection = _d.validate, exports.validateSectionArray = _d.validateArray;
-_e = createValidator(types_8.LabelSchema), exports.validateLabel = _e.validate, exports.validateLabelArray = _e.validateArray;
-_f = createValidator(types_4.CommentSchema), exports.validateComment = _f.validate, exports.validateCommentArray = _f.validateArray;
-_g = createValidator(types_14.UserSchema), exports.validateUser = _g.validate, exports.validateUserArray = _g.validateArray;
-exports.validateProductivityStats = createValidator(types_9.ProductivityStatsSchema).validate;
-exports.validateCurrentUser = createValidator(types_14.CurrentUserSchema).validate;
+_b = createValidator(types_11.ProjectSchema), exports.validateProject = _b.validate, exports.validateProjectArray = _b.validateArray;
+_c = createValidator(types_11.WorkspaceProjectSchema), exports.validateWorkspaceProject = _c.validate, exports.validateWorkspaceProjectArray = _c.validateArray;
+_d = createValidator(types_12.SectionSchema), exports.validateSection = _d.validate, exports.validateSectionArray = _d.validateArray;
+_e = createValidator(types_9.LabelSchema), exports.validateLabel = _e.validate, exports.validateLabelArray = _e.validateArray;
+_f = createValidator(types_5.CommentSchema), exports.validateComment = _f.validate, exports.validateCommentArray = _f.validateArray;
+_g = createValidator(types_15.UserSchema), exports.validateUser = _g.validate, exports.validateUserArray = _g.validateArray;
+exports.validateProductivityStats = createValidator(types_10.ProductivityStatsSchema).validate;
+exports.validateCurrentUser = createValidator(types_15.CurrentUserSchema).validate;
 _h = createValidator(types_1.ActivityEventSchema), exports.validateActivityEvent = _h.validate, exports.validateActivityEventArray = _h.validateArray;
-exports.validateAttachment = createValidator(types_4.AttachmentSchema).validate;
-_j = createValidator(types_15.WorkspaceUserSchema), exports.validateWorkspaceUser = _j.validate, exports.validateWorkspaceUserArray = _j.validateArray;
-_k = createValidator(types_15.WorkspaceInvitationSchema), exports.validateWorkspaceInvitation = _k.validate, exports.validateWorkspaceInvitationArray = _k.validateArray;
-exports.validateWorkspacePlanDetails = createValidator(types_15.WorkspacePlanDetailsSchema).validate;
-exports.validateJoinWorkspaceResult = createValidator(types_15.JoinWorkspaceResultSchema).validate;
-_l = createValidator(types_15.WorkspaceSchema), exports.validateWorkspace = _l.validate, exports.validateWorkspaceArray = _l.validateArray;
-_m = createValidator(types_15.MemberActivityInfoSchema), exports.validateMemberActivityInfo = _m.validate, exports.validateMemberActivityInfoArray = _m.validateArray;
-_o = createValidator(types_15.WorkspaceUserTaskSchema), exports.validateWorkspaceUserTask = _o.validate, exports.validateWorkspaceUserTaskArray = _o.validateArray;
-exports.validateProjectActivityStats = createValidator(types_7.ProjectActivityStatsSchema).validate;
-exports.validateProjectHealth = createValidator(types_7.ProjectHealthSchema).validate;
-exports.validateProjectHealthContext = createValidator(types_7.ProjectHealthContextSchema).validate;
-exports.validateProjectProgress = createValidator(types_7.ProjectProgressSchema).validate;
-exports.validateWorkspaceInsights = createValidator(types_7.WorkspaceInsightsSchema).validate;
+exports.validateAttachment = createValidator(types_5.AttachmentSchema).validate;
+_j = createValidator(types_16.WorkspaceUserSchema), exports.validateWorkspaceUser = _j.validate, exports.validateWorkspaceUserArray = _j.validateArray;
+_k = createValidator(types_16.WorkspaceInvitationSchema), exports.validateWorkspaceInvitation = _k.validate, exports.validateWorkspaceInvitationArray = _k.validateArray;
+exports.validateWorkspacePlanDetails = createValidator(types_16.WorkspacePlanDetailsSchema).validate;
+exports.validateJoinWorkspaceResult = createValidator(types_16.JoinWorkspaceResultSchema).validate;
+_l = createValidator(types_16.WorkspaceSchema), exports.validateWorkspace = _l.validate, exports.validateWorkspaceArray = _l.validateArray;
+_m = createValidator(types_16.MemberActivityInfoSchema), exports.validateMemberActivityInfo = _m.validate, exports.validateMemberActivityInfoArray = _m.validateArray;
+_o = createValidator(types_16.WorkspaceUserTaskSchema), exports.validateWorkspaceUserTask = _o.validate, exports.validateWorkspaceUserTaskArray = _o.validateArray;
+exports.validateProjectActivityStats = createValidator(types_8.ProjectActivityStatsSchema).validate;
+exports.validateProjectHealth = createValidator(types_8.ProjectHealthSchema).validate;
+exports.validateProjectHealthContext = createValidator(types_8.ProjectHealthContextSchema).validate;
+exports.validateProjectProgress = createValidator(types_8.ProjectProgressSchema).validate;
+exports.validateWorkspaceInsights = createValidator(types_8.WorkspaceInsightsSchema).validate;
 _p = createValidator(types_3.BackupSchema), exports.validateBackup = _p.validate, exports.validateBackupArray = _p.validateArray;
-_q = createValidator(types_6.IdMappingSchema), exports.validateIdMapping = _q.validate, exports.validateIdMappingArray = _q.validateArray;
-_r = createValidator(types_6.MovedIdSchema), exports.validateMovedId = _r.validate, exports.validateMovedIdArray = _r.validateArray;
+_q = createValidator(types_7.IdMappingSchema), exports.validateIdMapping = _q.validate, exports.validateIdMappingArray = _q.validateArray;
+_r = createValidator(types_7.MovedIdSchema), exports.validateMovedId = _r.validate, exports.validateMovedIdArray = _r.validateArray;
 // Sync resource validators
 _s = createValidator(resources_1.FilterSchema), exports.validateFilter = _s.validate, exports.validateFilterArray = _s.validateArray;
 _t = createValidator(resources_1.CollaboratorSchema), exports.validateCollaborator = _t.validate, exports.validateCollaboratorArray = _t.validateArray;
 _u = createValidator(resources_1.CollaboratorStateSchema), exports.validateCollaboratorState = _u.validate, exports.validateCollaboratorStateArray = _u.validateArray;
 _v = createValidator(resources_1.FolderSchema), exports.validateFolder = _v.validate, exports.validateFolderArray = _v.validateArray;
-_w = createValidator(types_5.GoalSchema), exports.validateGoal = _w.validate, exports.validateGoalArray = _w.validateArray;
+_w = createValidator(types_6.GoalSchema), exports.validateGoal = _w.validate, exports.validateGoalArray = _w.validateArray;
+// Billing validators
+exports.validateSubscriptionInfo = createValidator(types_4.SubscriptionInfoSchema).validate;
+exports.validateProPlanDetails = createValidator(types_4.ProPlanDetailsSchema).validate;
+exports.validatePrices = createValidator(types_4.PricesResponseSchema).validate;
+exports.validatePricing = createValidator(types_4.PricingResponseSchema).validate;
 _x = createValidator(resources_1.NoteSchema), exports.validateNote = _x.validate, exports.validateNoteArray = _x.validateArray;
 exports.validateTooltips = createValidator(resources_1.TooltipsSchema).validate;
 _y = createValidator(resources_1.WorkspaceFilterSchema), exports.validateWorkspaceFilter = _y.validate, exports.validateWorkspaceFilterArray = _y.validateArray;
@@ -102,4 +109,4 @@ exports.validateAppByDistributionToken = createValidator(types_2.AppByDistributi
 exports.validateAppWebhook = createValidator(types_2.AppWebhookSchema).validate;
 _11 = createValidator(types_2.AppInstallationSchema), exports.validateAppInstallation = _11.validate, exports.validateAppInstallationArray = _11.validateArray;
 _12 = createValidator(types_2.UserAuthorizationSchema), exports.validateUserAuthorization = _12.validate, exports.validateUserAuthorizationArray = _12.validateArray;
-_13 = createValidator(types_13.UiExtensionSchema), exports.validateUiExtension = _13.validate, exports.validateUiExtensionArray = _13.validateArray;
+_13 = createValidator(types_14.UiExtensionSchema), exports.validateUiExtension = _13.validate, exports.validateUiExtensionArray = _13.validateArray;

package/dist/esm/authentication.js

@@ -21,6 +21,8 @@ export const PERMISSIONS = [
     'data:delete',
     'project:delete',
     'backups:read',
+    'billing:read',
+    'billing:read_write',
     'dev:app_console',
 ];
 /** Supported token endpoint authentication methods for dynamic client registration. */