@doist/todoist-sdk 10.2.0 → 10.3.0

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

@@ -0,0 +1,148 @@
+import { ENDPOINT_PAYMENTS_CANCEL_PLAN, ENDPOINT_PAYMENTS_REACTIVATE_PLAN, ENDPOINT_PAYMENTS_SUBSCRIPTION_INFO, ENDPOINT_PRICES, ENDPOINT_PRICING, ENDPOINT_PRO_BILLING_PORTAL, ENDPOINT_PRO_PLAN_DETAILS, ENDPOINT_PRO_TRIAL, ENDPOINT_PRO_UPGRADE, ENDPOINT_WORKSPACE_BILLING_PORTAL, ENDPOINT_WORKSPACE_TRIAL, ENDPOINT_WORKSPACE_UPGRADE, } from '../consts/endpoints.js';
+import { request } from '../transport/http-client.js';
+import { validatePricing, validatePrices, validateProPlanDetails, validateSubscriptionInfo, } from '../utils/validators.js';
+import { BaseClient } from './base-client.js';
+/**
+ * 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.
+ */
+export class BillingClient extends BaseClient {
+    async getSubscriptionInfo() {
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_PAYMENTS_SUBSCRIPTION_INFO,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+        });
+        return validateSubscriptionInfo(response.data);
+    }
+    async cancelPlan(args, requestId) {
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_PAYMENTS_CANCEL_PLAN,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return response.data;
+    }
+    async reactivatePlan(requestId) {
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_PAYMENTS_REACTIVATE_PLAN,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            requestId: requestId,
+        });
+        return validateSubscriptionInfo(response.data);
+    }
+    async upgradeToPro(args, requestId) {
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_PRO_UPGRADE,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return response.data;
+    }
+    async startProTrial(args, requestId) {
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_PRO_TRIAL,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return response.data;
+    }
+    async createProBillingPortalSession(args, requestId) {
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_PRO_BILLING_PORTAL,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return response.data;
+    }
+    async getProPlanDetails() {
+        const response = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_PRO_PLAN_DETAILS,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+        });
+        return validateProPlanDetails(response.data);
+    }
+    async upgradeWorkspace(args, requestId) {
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_WORKSPACE_UPGRADE,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return response.data;
+    }
+    async startWorkspaceTrial(args, requestId) {
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_WORKSPACE_TRIAL,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return response.data;
+    }
+    async createWorkspaceBillingPortalSession(args, requestId) {
+        const response = await request({
+            httpMethod: 'POST',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_WORKSPACE_BILLING_PORTAL,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+            requestId: requestId,
+        });
+        return response.data;
+    }
+    async getPrices() {
+        const response = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_PRICES,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+        });
+        return validatePrices(response.data);
+    }
+    async getPricing(args) {
+        const response = await request({
+            httpMethod: 'GET',
+            baseUri: this.syncApiBase,
+            relativePath: ENDPOINT_PRICING,
+            apiToken: this.authToken,
+            customFetch: this.customFetch,
+            payload: args,
+        });
+        return validatePricing(response.data);
+    }
+}

package/dist/esm/consts/endpoints.js

@@ -84,6 +84,19 @@ export const ENDPOINT_WORKSPACE_JOIN = 'workspaces/join';
 export const ENDPOINT_WORKSPACE_LOGO = 'workspaces/logo';
 export const ENDPOINT_WORKSPACE_PLAN_DETAILS = 'workspaces/plan_details';
 export const ENDPOINT_WORKSPACE_USERS = 'workspaces/users';
+// Billing endpoints
+export const ENDPOINT_PAYMENTS_SUBSCRIPTION_INFO = 'payments/get_subscription_info';
+export const ENDPOINT_PAYMENTS_CANCEL_PLAN = 'payments/cancel_plan_with_redirect_to_stripe';
+export const ENDPOINT_PAYMENTS_REACTIVATE_PLAN = 'payments/reactivate_plan';
+export const ENDPOINT_PRO_UPGRADE = 'pro/upgrade';
+export const ENDPOINT_PRO_TRIAL = 'pro/trial';
+export const ENDPOINT_PRO_BILLING_PORTAL = 'pro/billing_portal';
+export const ENDPOINT_PRO_PLAN_DETAILS = 'pro/plan_details';
+export const ENDPOINT_WORKSPACE_UPGRADE = 'workspaces/upgrade';
+export const ENDPOINT_WORKSPACE_TRIAL = 'workspaces/trial';
+export const ENDPOINT_WORKSPACE_BILLING_PORTAL = 'workspaces/billing_portal';
+export const ENDPOINT_PRICES = 'prices';
+export const ENDPOINT_PRICING = 'pricing';
 // Workspace invitation actions (require invite_code parameter)
 export function getWorkspaceInvitationAcceptEndpoint(inviteCode) {
     return `workspaces/invitations/${inviteCode}/accept`;

package/dist/esm/todoist-api.js

@@ -1,6 +1,7 @@
 import { ActivityClient } from './clients/activity-client.js';
 import { AppClient } from './clients/app-client.js';
 import { BackupClient } from './clients/backup-client.js';
+import { BillingClient } from './clients/billing-client.js';
 import { CommentClient } from './clients/comment-client.js';
 import { EmailClient } from './clients/email-client.js';
 import { FolderClient } from './clients/folder-client.js';
@@ -60,6 +61,7 @@ export class TodoistApi {
         this.productivityClient = new ProductivityClient(clientDeps);
         this.workspaceClient = new WorkspaceClient(clientDeps);
         this.goalsClient = new GoalsClient(clientDeps);
+        this.billingClient = new BillingClient(clientDeps);
         this.appClient = new AppClient(clientDeps);
         this.uiExtensionClient = new UiExtensionClient(clientDeps);
     }
@@ -1040,6 +1042,143 @@ export 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/esm/types/billing/index.js

@@ -0,0 +1,2 @@
+export * from './types.js';
+export * from './requests.js';

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

@@ -0,0 +1 @@
+export {};

package/dist/esm/types/billing/types.js

@@ -0,0 +1,89 @@
+import { z } from 'zod';
+import { WORKSPACE_PLAN_STATUSES } from '../workspaces/types.js';
+/** Available subscription statuses. */
+export const BILLING_SUBSCRIPTION_STATUSES = [
+    'none',
+    'autorenew',
+    'canceled',
+    'expired',
+    'trial',
+    'trial_canceled',
+];
+/** Available plan tiers. */
+export const BILLING_PLANS = ['free', 'pro', 'pro_gifted', 'pro_legacy'];
+/** Ways an active subscription can be purchased. */
+export const BILLING_ACTIVATION_METHODS = [
+    'stripe',
+    'appstore',
+    'playstore',
+    'teams',
+    'manual',
+];
+/** Available billing cycles. */
+export const BILLING_CYCLES = ['monthly', 'yearly'];
+/** Available tax behaviors for a price. */
+export const TAX_BEHAVIORS = ['exclusive', 'inclusive', 'unspecified'];
+export const BillingPlanPriceSchema = z.object({
+    amount: z.string(),
+    rawAmount: z.number(),
+    currency: z.string(),
+    billingCycle: z.enum(BILLING_CYCLES).nullable(),
+    taxBehavior: z.enum(TAX_BEHAVIORS),
+});
+export const SubscriptionInfoSchema = z.object({
+    status: z.enum(BILLING_SUBSCRIPTION_STATUSES),
+    plan: z.enum(BILLING_PLANS),
+    expirationDate: z.string().nullable(),
+    activationMethod: z.enum(BILLING_ACTIVATION_METHODS),
+    planPrice: BillingPlanPriceSchema.nullable(),
+    billingPortalUrl: z.string().nullable(),
+    billingPortalSwitchToAnnualUrl: z.string().nullable(),
+    hasBillingPortal: z.boolean(),
+    hasBillingPortalSwitchToAnnual: z.boolean(),
+    invoiceCreditBalance: z.record(z.string(), z.number().int()).nullable(),
+    hasSwitchLegacyToCurrent: z.boolean(),
+});
+export const FormattedPriceSchema = z.object({
+    currency: z.string(),
+    unitAmount: z.number().int(),
+    taxBehavior: z.enum(TAX_BEHAVIORS),
+});
+export const PriceListingSchema = z.object({
+    billingCycle: z.enum(BILLING_CYCLES),
+    prices: z.array(FormattedPriceSchema),
+});
+export const ProPlanDetailsSchema = z.object({
+    currentPlanStatus: z.enum(WORKSPACE_PLAN_STATUSES),
+    downgradeAt: z.string().nullable(),
+    priceList: z.array(PriceListingSchema),
+});
+export const PricesResponseSchema = z.object({
+    pro: z.array(PriceListingSchema),
+    teams: z.array(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`.
+ */
+export const PricingTermsSchema = z.object({
+    monthly: z.union([z.number(), z.string()]),
+    yearly: z.union([z.number(), z.string()]),
+});
+/**
+ * A pricing version entry: plan name (`pro` / `biz`) → currency code →
+ * {@link PricingTerms}.
+ */
+export const PricingVersionSchema = z.record(z.string(), z.record(z.string(), PricingTermsSchema));
+/**
+ * Response of the `pricing` endpoint: fixed version-pointer string fields plus
+ * dynamic version keys (`v1`, `v2`, …), each a {@link PricingVersion}.
+ */
+export const PricingResponseSchema = z
+    .object({
+    latestPro: z.string(),
+    latestBiz: z.string(),
+    sessionPro: z.string(),
+    sessionBiz: z.string(),
+})
+    .catchall(PricingVersionSchema);

package/dist/esm/types/index.js

@@ -10,6 +10,7 @@ export * from './activity/index.js';
 export * from './workspaces/index.js';
 export * from './folders/index.js';
 export * from './goals/index.js';
+export * from './billing/index.js';
 export * from './insights/index.js';
 export * from './backups/index.js';
 export * from './id-mappings/index.js';

package/dist/esm/utils/validators.js

@@ -2,6 +2,7 @@ import { z } from 'zod';
 import { ActivityEventSchema } from '../types/activity/types.js';
 import { AppSchema, AppWithUserCountSchema, AppSecretsSchema, AppVerificationTokenSchema, AppTestTokenSchema, AppDistributionTokenSchema, AppByDistributionTokenSchema, AppWebhookSchema, AppInstallationSchema, UserAuthorizationSchema, } from '../types/apps/types.js';
 import { BackupSchema } from '../types/backups/types.js';
+import { SubscriptionInfoSchema, ProPlanDetailsSchema, PricesResponseSchema, PricingResponseSchema, } from '../types/billing/types.js';
 import { AttachmentSchema, CommentSchema } from '../types/comments/types.js';
 import { GoalSchema } from '../types/goals/types.js';
 import { IdMappingSchema, MovedIdSchema } from '../types/id-mappings/types.js';
@@ -65,6 +66,11 @@ export const { validate: validateCollaborator, validateArray: validateCollaborat
 export const { validate: validateCollaboratorState, validateArray: validateCollaboratorStateArray, } = createValidator(CollaboratorStateSchema);
 export const { validate: validateFolder, validateArray: validateFolderArray } = createValidator(FolderSchema);
 export const { validate: validateGoal, validateArray: validateGoalArray } = createValidator(GoalSchema);
+// Billing validators
+export const { validate: validateSubscriptionInfo } = createValidator(SubscriptionInfoSchema);
+export const { validate: validateProPlanDetails } = createValidator(ProPlanDetailsSchema);
+export const { validate: validatePrices } = createValidator(PricesResponseSchema);
+export const { validate: validatePricing } = createValidator(PricingResponseSchema);
 export const { validate: validateNote, validateArray: validateNoteArray } = createValidator(NoteSchema);
 export const { validate: validateTooltips } = createValidator(TooltipsSchema);
 export const { validate: validateWorkspaceFilter, validateArray: validateWorkspaceFilterArray } = createValidator(WorkspaceFilterSchema);

package/dist/types/authentication.d.ts

@@ -7,7 +7,7 @@ export type AuthOptions = {
     customFetch?: CustomFetch;
 };
 /** Available OAuth2 permission scopes. */
-export declare const PERMISSIONS: readonly ["task:add", "data:read", "data:read_write", "data:delete", "project:delete", "backups:read", "dev:app_console"];
+export declare const PERMISSIONS: readonly ["task:add", "data:read", "data:read_write", "data:delete", "project:delete", "backups:read", "billing:read", "billing:read_write", "dev:app_console"];
 /**
  * Permission scope that can be requested during OAuth2 authorization.
  * @see {@link https://developer.todoist.com/api/v1/#tag/Authorization}

package/dist/types/clients/billing-client.d.ts

@@ -0,0 +1,22 @@
+import type { BillingPortalUrlResponse, CancelPlanArgs, CheckoutSessionResponse, GetPricingArgs, PricesResponse, PricingResponse, ProBillingPortalArgs, ProPlanDetails, StartProTrialArgs, StartWorkspaceTrialArgs, SubscriptionInfo, UpgradeToProArgs, UpgradeWorkspaceArgs, WorkspaceBillingPortalArgs } from '../types/billing/index.js';
+import { BaseClient } from './base-client.js';
+/**
+ * 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.
+ */
+export declare class BillingClient extends BaseClient {
+    getSubscriptionInfo(): Promise<SubscriptionInfo>;
+    cancelPlan(args?: CancelPlanArgs, requestId?: string): Promise<BillingPortalUrlResponse>;
+    reactivatePlan(requestId?: string): Promise<SubscriptionInfo>;
+    upgradeToPro(args: UpgradeToProArgs, requestId?: string): Promise<CheckoutSessionResponse>;
+    startProTrial(args: StartProTrialArgs, requestId?: string): Promise<CheckoutSessionResponse>;
+    createProBillingPortalSession(args: ProBillingPortalArgs, requestId?: string): Promise<BillingPortalUrlResponse>;
+    getProPlanDetails(): Promise<ProPlanDetails>;
+    upgradeWorkspace(args: UpgradeWorkspaceArgs, requestId?: string): Promise<CheckoutSessionResponse>;
+    startWorkspaceTrial(args: StartWorkspaceTrialArgs, requestId?: string): Promise<CheckoutSessionResponse>;
+    createWorkspaceBillingPortalSession(args: WorkspaceBillingPortalArgs, requestId?: string): Promise<BillingPortalUrlResponse>;
+    getPrices(): Promise<PricesResponse>;
+    getPricing(args?: GetPricingArgs): Promise<PricingResponse>;
+}

package/dist/types/consts/endpoints.d.ts

@@ -72,6 +72,18 @@ export declare const ENDPOINT_WORKSPACE_JOIN = "workspaces/join";
 export declare const ENDPOINT_WORKSPACE_LOGO = "workspaces/logo";
 export declare const ENDPOINT_WORKSPACE_PLAN_DETAILS = "workspaces/plan_details";
 export declare const ENDPOINT_WORKSPACE_USERS = "workspaces/users";
+export declare const ENDPOINT_PAYMENTS_SUBSCRIPTION_INFO = "payments/get_subscription_info";
+export declare const ENDPOINT_PAYMENTS_CANCEL_PLAN = "payments/cancel_plan_with_redirect_to_stripe";
+export declare const ENDPOINT_PAYMENTS_REACTIVATE_PLAN = "payments/reactivate_plan";
+export declare const ENDPOINT_PRO_UPGRADE = "pro/upgrade";
+export declare const ENDPOINT_PRO_TRIAL = "pro/trial";
+export declare const ENDPOINT_PRO_BILLING_PORTAL = "pro/billing_portal";
+export declare const ENDPOINT_PRO_PLAN_DETAILS = "pro/plan_details";
+export declare const ENDPOINT_WORKSPACE_UPGRADE = "workspaces/upgrade";
+export declare const ENDPOINT_WORKSPACE_TRIAL = "workspaces/trial";
+export declare const ENDPOINT_WORKSPACE_BILLING_PORTAL = "workspaces/billing_portal";
+export declare const ENDPOINT_PRICES = "prices";
+export declare const ENDPOINT_PRICING = "pricing";
 export declare function getWorkspaceInvitationAcceptEndpoint(inviteCode: string): string;
 export declare function getWorkspaceInvitationRejectEndpoint(inviteCode: string): string;
 export declare function getProjectInsightsActivityStatsEndpoint(projectId: string): string;

package/dist/types/todoist-api.d.ts

@@ -2,6 +2,7 @@ import type { Reminder } from './types/index.js';
 import { GetActivityLogsArgs, GetActivityLogsResponse } from './types/activity/index.js';
 import type { AddAppArgs, App, AppByDistributionToken, AppDistributionToken, AppInstallation, AppSecrets, AppTestToken, AppVerificationToken, AppWebhook, AppWithUserCount, InstallAppArgs, RevokeUserAuthorizationArgs, UpdateAppArgs, UpdateAppInstallationArgs, UpdateAppWebhookArgs, UploadAppIconArgs, UserAuthorization } from './types/apps/index.js';
 import { Backup, GetBackupsArgs, DownloadBackupArgs } from './types/backups/index.js';
+import type { BillingPortalUrlResponse, CancelPlanArgs, CheckoutSessionResponse, GetPricingArgs, PricesResponse, PricingResponse, ProBillingPortalArgs, ProPlanDetails, StartProTrialArgs, StartWorkspaceTrialArgs, SubscriptionInfo, UpgradeToProArgs, UpgradeWorkspaceArgs, WorkspaceBillingPortalArgs } from './types/billing/index.js';
 import { Attachment, Comment, AddCommentArgs, UpdateCommentArgs, GetProjectCommentsArgs, GetTaskCommentsArgs, GetCommentsResponse } from './types/comments/index.js';
 import { GetOrCreateEmailArgs, GetOrCreateEmailResponse, DisableEmailArgs } from './types/emails/index.js';
 import { GetFoldersArgs, GetFoldersResponse, AddFolderArgs, UpdateFolderArgs } from './types/folders/index.js';
@@ -77,6 +78,7 @@ export declare class TodoistApi {
     private readonly productivityClient;
     private readonly workspaceClient;
     private readonly goalsClient;
+    private readonly billingClient;
     private readonly appClient;
     private readonly uiExtensionClient;
     constructor(
@@ -867,6 +869,118 @@ export declare class TodoistApi {
      * @returns A promise that resolves to `true` if successful.
      */
     unlinkTaskFromGoal(args: TaskLinkingArgs, requestId?: string): Promise<boolean>;
+    /**
+     * Retrieves the current user's subscription state.
+     *
+     * Requires the `billing:read` scope.
+     *
+     * @returns A promise that resolves to the user's subscription info.
+     */
+    getSubscriptionInfo(): Promise<SubscriptionInfo>;
+    /**
+     * 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.
+     */
+    cancelPlan(args?: CancelPlanArgs, requestId?: string): Promise<BillingPortalUrlResponse>;
+    /**
+     * 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.
+     */
+    reactivatePlan(requestId?: string): Promise<SubscriptionInfo>;
+    /**
+     * 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.
+     */
+    upgradeToPro(args: UpgradeToProArgs, requestId?: string): Promise<CheckoutSessionResponse>;
+    /**
+     * 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.
+     */
+    startProTrial(args: StartProTrialArgs, requestId?: string): Promise<CheckoutSessionResponse>;
+    /**
+     * 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.
+     */
+    createProBillingPortalSession(args: ProBillingPortalArgs, requestId?: string): Promise<BillingPortalUrlResponse>;
+    /**
+     * 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.
+     */
+    getProPlanDetails(): Promise<ProPlanDetails>;
+    /**
+     * 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.
+     */
+    upgradeWorkspace(args: UpgradeWorkspaceArgs, requestId?: string): Promise<CheckoutSessionResponse>;
+    /**
+     * 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.
+     */
+    startWorkspaceTrial(args: StartWorkspaceTrialArgs, requestId?: string): Promise<CheckoutSessionResponse>;
+    /**
+     * 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.
+     */
+    createWorkspaceBillingPortalSession(args: WorkspaceBillingPortalArgs, requestId?: string): Promise<BillingPortalUrlResponse>;
+    /**
+     * Retrieves available Pro and Teams prices.
+     *
+     * Requires the `billing:read` scope.
+     *
+     * @returns A promise that resolves to the available prices.
+     */
+    getPrices(): Promise<PricesResponse>;
+    /**
+     * 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.
+     */
+    getPricing(args?: GetPricingArgs): Promise<PricingResponse>;
     /**
      * Retrieves a list of available backups.
      *

package/dist/types/types/billing/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types.js';
+export * from './requests.js';