@commet/node 4.4.1 → 4.6.0

package/dist/index.d.mts

@@ -516,6 +516,43 @@ interface CancelParams {
     reason?: string;
     immediate?: boolean;
 }
+interface UncancelParams {
+    subscriptionId: string;
+}
+interface ChangePlanParams {
+    subscriptionId: string;
+    newPlanId?: string;
+    newBillingInterval?: BillingInterval;
+}
+interface ChangePlanResult {
+    id: string;
+    scheduled: boolean;
+    customerId?: string;
+    previousPlan?: {
+        id: string;
+        name: string;
+    };
+    currentPlan?: {
+        id: string;
+        name: string;
+        price: number;
+    };
+    billingInterval?: string;
+    billing?: {
+        credit: number;
+        creditsApplied: number;
+        charge: number;
+        taxAmount: number;
+        netAmount: number;
+        totalCharged: number;
+        remainingCreditBalance: number;
+    };
+    invoiceId?: string;
+    scheduledFor?: string;
+    changeType?: string;
+    requiresCheckout?: boolean;
+    checkoutUrl?: string;
+}
 /**
  * Subscription resource for managing subscriptions (plan-first model)
  *
@@ -559,6 +596,34 @@ declare class SubscriptionsResource {
      * ```
      */
     cancel(params: CancelParams, options?: RequestOptions): Promise<ApiResponse<Subscription>>;
+    /**
+     * Revert a scheduled cancellation
+     *
+     * Only works on subscriptions with a pending cancellation (canceledAt is set
+     * but status is not yet "canceled"). Cannot revert already-canceled subscriptions.
+     *
+     * @example
+     * ```typescript
+     * await commet.subscriptions.uncancel({
+     *   subscriptionId: 'sub_xxx',
+     * });
+     * ```
+     */
+    uncancel(params: UncancelParams, options?: RequestOptions): Promise<ApiResponse<Subscription>>;
+    /**
+     * Change the plan of a subscription (upgrade/downgrade)
+     *
+     * Upgrades execute immediately. Downgrades are scheduled for end of period.
+     *
+     * @example
+     * ```typescript
+     * await commet.subscriptions.changePlan({
+     *   subscriptionId: 'sub_xxx',
+     *   newPlanId: 'pln_xxx',
+     * });
+     * ```
+     */
+    changePlan(params: ChangePlanParams, options?: RequestOptions): Promise<ApiResponse<ChangePlanResult>>;
 }
 
 interface UsageEvent {
@@ -598,10 +663,55 @@ interface TrackModelTokensParams extends TrackBaseParams {
     value?: never;
 }
 type TrackParams = TrackUsageParams | TrackModelTokensParams;
+interface CheckUsageParams {
+    customerId: CustomerID;
+    featureCode: string;
+    quantity: number;
+}
+interface UsageCheckResult {
+    allowed: boolean;
+    consumptionModel: string;
+    feature: string;
+    quantity: number;
+    current?: number;
+    remaining?: number;
+    unlimited?: boolean;
+    included?: number;
+    overageEnabled?: boolean;
+    overageUnitPrice?: number | null;
+    creditsPerUnit?: number;
+    estimatedCredits?: number;
+    planCredits?: number;
+    purchasedCredits?: number;
+    totalCredits?: number;
+    unitPrice?: number;
+    estimatedAmount?: number;
+    currentBalance?: number;
+    blockOnExhaustion?: boolean;
+    currency?: string;
+    reason?: string;
+    message?: string;
+}
 declare class UsageResource {
     private httpClient;
     constructor(httpClient: CommetHTTPClient);
     track(params: TrackParams, options?: RequestOptions): Promise<ApiResponse<UsageEvent>>;
+    /**
+     * Check if a usage event would be allowed before tracking it
+     *
+     * @example
+     * ```typescript
+     * const { data } = await commet.usage.check({
+     *   customerId: 'cus_xxx',
+     *   featureCode: 'api_calls',
+     *   quantity: 1,
+     * });
+     * if (data.allowed) {
+     *   // proceed with the operation
+     * }
+     * ```
+     */
+    check(params: CheckUsageParams, options?: RequestOptions): Promise<ApiResponse<UsageCheckResult>>;
 }
 
 declare class CustomerContext<TConfig = unknown> {
@@ -641,6 +751,35 @@ declare class CustomerContext<TConfig = unknown> {
     };
 }
 
+interface ActiveAddon {
+    slug: string;
+    name: string;
+    basePrice: number;
+    featureCode: string;
+    featureName: string;
+    featureType: string;
+    consumptionModel: string | null;
+    activatedAt: string;
+}
+interface GetActiveAddonsParams {
+    customerId: CustomerID;
+}
+declare class AddonsResource {
+    private httpClient;
+    constructor(httpClient: CommetHTTPClient);
+    /**
+     * Get active addons for a customer's subscription
+     *
+     * @example
+     * ```typescript
+     * const { data } = await commet.addons.getActive({
+     *   customerId: 'cus_xxx',
+     * });
+     * ```
+     */
+    getActive(params: GetActiveAddonsParams, options?: RequestOptions): Promise<ApiResponse<ActiveAddon[]>>;
+}
+
 interface CreditPack {
     id: string;
     name: string;
@@ -874,6 +1013,7 @@ declare class Webhooks {
  */
 declare class Commet<TConfig = unknown> {
     private httpClient;
+    readonly addons: AddonsResource;
     readonly customers: CustomersResource;
     readonly creditPacks: CreditPacksResource;
     readonly plans: PlansResource;
@@ -910,4 +1050,4 @@ declare const SDK_VERSION: string;
  * Commet SDK - Billing and usage tracking for SaaS
  */
 
-export { API_VERSION, type ActiveSubscription, type AddParams as AddSeatsParams, type ApiResponse, type BillingConfig, type BillingInterval, type CanUseFeatureParams, type CanUseResult, type CancelParams, type CancellationSummary, type CheckFeatureParams, type CheckResult, Commet, CommetAPIError, type CommetClientOptions, type CommetConfig, CommetError, CommetValidationError, type CreateParams as CreateCustomerParams, type CreateSubscriptionParams, type CreatedSubscription, type CreditPack, type Currency, type Customer, type CustomerAddress, CustomerContext, type CustomerID, type BatchResult as CustomersBatchResult, type DiscountSummary, type EventID, type FeatureAccess, type FeatureDef, type FeatureSummary, type FeatureType, type GetAllBalancesParams, type GetBalanceParams, type GetFeatureParams, type GetUrlParams, type InferFeatureCodes, type InferPlanCodes, type InferSeatCodes, type InferUsageCodes, type ListCustomersParams, type ListPlansParams, type PaginatedList, type PaginatedResponse, type Plan, type PlanDef, type PlanDetail, type PlanFeature, type PlanFeatureValue, type PlanID, type PlanPrice, type PortalAccess, type PriceDef, type RemoveParams as RemoveSeatsParams, type RequestOptions, type ResolvedFeatureCode, type ResolvedPlanCode, type ResolvedSeatCode, type ResolvedUsageCode, SDK_VERSION, type SeatBalance, type SeatEvent, type SetAllParams as SetAllSeatsParams, type SetParams as SetSeatsParams, type Subscription, type SubscriptionStatus, type TrackModelTokensParams, type TrackParams, type TrackUsageParams, type UpdateParams as UpdateCustomerParams, type UsageEvent, type UsageEventProperty, type WebhookData, type WebhookEvent, type WebhookPayload, Webhooks, createCommet, Commet as default, defineConfig, registerIntegration };
+export { API_VERSION, type ActiveAddon, type ActiveSubscription, type AddParams as AddSeatsParams, type ApiResponse, type BillingConfig, type BillingInterval, type CanUseFeatureParams, type CanUseResult, type CancelParams, type CancellationSummary, type ChangePlanParams, type ChangePlanResult, type CheckFeatureParams, type CheckResult, type CheckUsageParams, Commet, CommetAPIError, type CommetClientOptions, type CommetConfig, CommetError, CommetValidationError, type CreateParams as CreateCustomerParams, type CreateSubscriptionParams, type CreatedSubscription, type CreditPack, type Currency, type Customer, type CustomerAddress, CustomerContext, type CustomerID, type BatchResult as CustomersBatchResult, type DiscountSummary, type EventID, type FeatureAccess, type FeatureDef, type FeatureSummary, type FeatureType, type GetActiveAddonsParams, type GetAllBalancesParams, type GetBalanceParams, type GetFeatureParams, type GetUrlParams, type InferFeatureCodes, type InferPlanCodes, type InferSeatCodes, type InferUsageCodes, type ListCustomersParams, type ListPlansParams, type PaginatedList, type PaginatedResponse, type Plan, type PlanDef, type PlanDetail, type PlanFeature, type PlanFeatureValue, type PlanID, type PlanPrice, type PortalAccess, type PriceDef, type RemoveParams as RemoveSeatsParams, type RequestOptions, type ResolvedFeatureCode, type ResolvedPlanCode, type ResolvedSeatCode, type ResolvedUsageCode, SDK_VERSION, type SeatBalance, type SeatEvent, type SetAllParams as SetAllSeatsParams, type SetParams as SetSeatsParams, type Subscription, type SubscriptionStatus, type TrackModelTokensParams, type TrackParams, type TrackUsageParams, type UncancelParams, type UpdateParams as UpdateCustomerParams, type UsageCheckResult, type UsageEvent, type UsageEventProperty, type WebhookData, type WebhookEvent, type WebhookPayload, Webhooks, createCommet, Commet as default, defineConfig, registerIntegration };

package/dist/index.d.ts

@@ -516,6 +516,43 @@ interface CancelParams {
     reason?: string;
     immediate?: boolean;
 }
+interface UncancelParams {
+    subscriptionId: string;
+}
+interface ChangePlanParams {
+    subscriptionId: string;
+    newPlanId?: string;
+    newBillingInterval?: BillingInterval;
+}
+interface ChangePlanResult {
+    id: string;
+    scheduled: boolean;
+    customerId?: string;
+    previousPlan?: {
+        id: string;
+        name: string;
+    };
+    currentPlan?: {
+        id: string;
+        name: string;
+        price: number;
+    };
+    billingInterval?: string;
+    billing?: {
+        credit: number;
+        creditsApplied: number;
+        charge: number;
+        taxAmount: number;
+        netAmount: number;
+        totalCharged: number;
+        remainingCreditBalance: number;
+    };
+    invoiceId?: string;
+    scheduledFor?: string;
+    changeType?: string;
+    requiresCheckout?: boolean;
+    checkoutUrl?: string;
+}
 /**
  * Subscription resource for managing subscriptions (plan-first model)
  *
@@ -559,6 +596,34 @@ declare class SubscriptionsResource {
      * ```
      */
     cancel(params: CancelParams, options?: RequestOptions): Promise<ApiResponse<Subscription>>;
+    /**
+     * Revert a scheduled cancellation
+     *
+     * Only works on subscriptions with a pending cancellation (canceledAt is set
+     * but status is not yet "canceled"). Cannot revert already-canceled subscriptions.
+     *
+     * @example
+     * ```typescript
+     * await commet.subscriptions.uncancel({
+     *   subscriptionId: 'sub_xxx',
+     * });
+     * ```
+     */
+    uncancel(params: UncancelParams, options?: RequestOptions): Promise<ApiResponse<Subscription>>;
+    /**
+     * Change the plan of a subscription (upgrade/downgrade)
+     *
+     * Upgrades execute immediately. Downgrades are scheduled for end of period.
+     *
+     * @example
+     * ```typescript
+     * await commet.subscriptions.changePlan({
+     *   subscriptionId: 'sub_xxx',
+     *   newPlanId: 'pln_xxx',
+     * });
+     * ```
+     */
+    changePlan(params: ChangePlanParams, options?: RequestOptions): Promise<ApiResponse<ChangePlanResult>>;
 }
 
 interface UsageEvent {
@@ -598,10 +663,55 @@ interface TrackModelTokensParams extends TrackBaseParams {
     value?: never;
 }
 type TrackParams = TrackUsageParams | TrackModelTokensParams;
+interface CheckUsageParams {
+    customerId: CustomerID;
+    featureCode: string;
+    quantity: number;
+}
+interface UsageCheckResult {
+    allowed: boolean;
+    consumptionModel: string;
+    feature: string;
+    quantity: number;
+    current?: number;
+    remaining?: number;
+    unlimited?: boolean;
+    included?: number;
+    overageEnabled?: boolean;
+    overageUnitPrice?: number | null;
+    creditsPerUnit?: number;
+    estimatedCredits?: number;
+    planCredits?: number;
+    purchasedCredits?: number;
+    totalCredits?: number;
+    unitPrice?: number;
+    estimatedAmount?: number;
+    currentBalance?: number;
+    blockOnExhaustion?: boolean;
+    currency?: string;
+    reason?: string;
+    message?: string;
+}
 declare class UsageResource {
     private httpClient;
     constructor(httpClient: CommetHTTPClient);
     track(params: TrackParams, options?: RequestOptions): Promise<ApiResponse<UsageEvent>>;
+    /**
+     * Check if a usage event would be allowed before tracking it
+     *
+     * @example
+     * ```typescript
+     * const { data } = await commet.usage.check({
+     *   customerId: 'cus_xxx',
+     *   featureCode: 'api_calls',
+     *   quantity: 1,
+     * });
+     * if (data.allowed) {
+     *   // proceed with the operation
+     * }
+     * ```
+     */
+    check(params: CheckUsageParams, options?: RequestOptions): Promise<ApiResponse<UsageCheckResult>>;
 }
 
 declare class CustomerContext<TConfig = unknown> {
@@ -641,6 +751,35 @@ declare class CustomerContext<TConfig = unknown> {
     };
 }
 
+interface ActiveAddon {
+    slug: string;
+    name: string;
+    basePrice: number;
+    featureCode: string;
+    featureName: string;
+    featureType: string;
+    consumptionModel: string | null;
+    activatedAt: string;
+}
+interface GetActiveAddonsParams {
+    customerId: CustomerID;
+}
+declare class AddonsResource {
+    private httpClient;
+    constructor(httpClient: CommetHTTPClient);
+    /**
+     * Get active addons for a customer's subscription
+     *
+     * @example
+     * ```typescript
+     * const { data } = await commet.addons.getActive({
+     *   customerId: 'cus_xxx',
+     * });
+     * ```
+     */
+    getActive(params: GetActiveAddonsParams, options?: RequestOptions): Promise<ApiResponse<ActiveAddon[]>>;
+}
+
 interface CreditPack {
     id: string;
     name: string;
@@ -874,6 +1013,7 @@ declare class Webhooks {
  */
 declare class Commet<TConfig = unknown> {
     private httpClient;
+    readonly addons: AddonsResource;
     readonly customers: CustomersResource;
     readonly creditPacks: CreditPacksResource;
     readonly plans: PlansResource;
@@ -910,4 +1050,4 @@ declare const SDK_VERSION: string;
  * Commet SDK - Billing and usage tracking for SaaS
  */
 
-export { API_VERSION, type ActiveSubscription, type AddParams as AddSeatsParams, type ApiResponse, type BillingConfig, type BillingInterval, type CanUseFeatureParams, type CanUseResult, type CancelParams, type CancellationSummary, type CheckFeatureParams, type CheckResult, Commet, CommetAPIError, type CommetClientOptions, type CommetConfig, CommetError, CommetValidationError, type CreateParams as CreateCustomerParams, type CreateSubscriptionParams, type CreatedSubscription, type CreditPack, type Currency, type Customer, type CustomerAddress, CustomerContext, type CustomerID, type BatchResult as CustomersBatchResult, type DiscountSummary, type EventID, type FeatureAccess, type FeatureDef, type FeatureSummary, type FeatureType, type GetAllBalancesParams, type GetBalanceParams, type GetFeatureParams, type GetUrlParams, type InferFeatureCodes, type InferPlanCodes, type InferSeatCodes, type InferUsageCodes, type ListCustomersParams, type ListPlansParams, type PaginatedList, type PaginatedResponse, type Plan, type PlanDef, type PlanDetail, type PlanFeature, type PlanFeatureValue, type PlanID, type PlanPrice, type PortalAccess, type PriceDef, type RemoveParams as RemoveSeatsParams, type RequestOptions, type ResolvedFeatureCode, type ResolvedPlanCode, type ResolvedSeatCode, type ResolvedUsageCode, SDK_VERSION, type SeatBalance, type SeatEvent, type SetAllParams as SetAllSeatsParams, type SetParams as SetSeatsParams, type Subscription, type SubscriptionStatus, type TrackModelTokensParams, type TrackParams, type TrackUsageParams, type UpdateParams as UpdateCustomerParams, type UsageEvent, type UsageEventProperty, type WebhookData, type WebhookEvent, type WebhookPayload, Webhooks, createCommet, Commet as default, defineConfig, registerIntegration };
+export { API_VERSION, type ActiveAddon, type ActiveSubscription, type AddParams as AddSeatsParams, type ApiResponse, type BillingConfig, type BillingInterval, type CanUseFeatureParams, type CanUseResult, type CancelParams, type CancellationSummary, type ChangePlanParams, type ChangePlanResult, type CheckFeatureParams, type CheckResult, type CheckUsageParams, Commet, CommetAPIError, type CommetClientOptions, type CommetConfig, CommetError, CommetValidationError, type CreateParams as CreateCustomerParams, type CreateSubscriptionParams, type CreatedSubscription, type CreditPack, type Currency, type Customer, type CustomerAddress, CustomerContext, type CustomerID, type BatchResult as CustomersBatchResult, type DiscountSummary, type EventID, type FeatureAccess, type FeatureDef, type FeatureSummary, type FeatureType, type GetActiveAddonsParams, type GetAllBalancesParams, type GetBalanceParams, type GetFeatureParams, type GetUrlParams, type InferFeatureCodes, type InferPlanCodes, type InferSeatCodes, type InferUsageCodes, type ListCustomersParams, type ListPlansParams, type PaginatedList, type PaginatedResponse, type Plan, type PlanDef, type PlanDetail, type PlanFeature, type PlanFeatureValue, type PlanID, type PlanPrice, type PortalAccess, type PriceDef, type RemoveParams as RemoveSeatsParams, type RequestOptions, type ResolvedFeatureCode, type ResolvedPlanCode, type ResolvedSeatCode, type ResolvedUsageCode, SDK_VERSION, type SeatBalance, type SeatEvent, type SetAllParams as SetAllSeatsParams, type SetParams as SetSeatsParams, type Subscription, type SubscriptionStatus, type TrackModelTokensParams, type TrackParams, type TrackUsageParams, type UncancelParams, type UpdateParams as UpdateCustomerParams, type UsageCheckResult, type UsageEvent, type UsageEventProperty, type WebhookData, type WebhookEvent, type WebhookPayload, Webhooks, createCommet, Commet as default, defineConfig, registerIntegration };

package/dist/index.js

@@ -99,6 +99,30 @@ var CustomerContext = class {
   }
 };
 
+// src/resources/addons.ts
+var AddonsResource = class {
+  constructor(httpClient) {
+    this.httpClient = httpClient;
+  }
+  /**
+   * Get active addons for a customer's subscription
+   *
+   * @example
+   * ```typescript
+   * const { data } = await commet.addons.getActive({
+   *   customerId: 'cus_xxx',
+   * });
+   * ```
+   */
+  async getActive(params, options) {
+    return this.httpClient.get(
+      "/addons/active",
+      { customerId: params.customerId },
+      options
+    );
+  }
+};
+
 // src/resources/credit-packs.ts
 var CreditPacksResource = class {
   constructor(httpClient) {
@@ -387,6 +411,47 @@ var SubscriptionsResource = class {
       options
     );
   }
+  /**
+   * Revert a scheduled cancellation
+   *
+   * Only works on subscriptions with a pending cancellation (canceledAt is set
+   * but status is not yet "canceled"). Cannot revert already-canceled subscriptions.
+   *
+   * @example
+   * ```typescript
+   * await commet.subscriptions.uncancel({
+   *   subscriptionId: 'sub_xxx',
+   * });
+   * ```
+   */
+  async uncancel(params, options) {
+    return this.httpClient.post(
+      `/subscriptions/${params.subscriptionId}/uncancel`,
+      {},
+      options
+    );
+  }
+  /**
+   * Change the plan of a subscription (upgrade/downgrade)
+   *
+   * Upgrades execute immediately. Downgrades are scheduled for end of period.
+   *
+   * @example
+   * ```typescript
+   * await commet.subscriptions.changePlan({
+   *   subscriptionId: 'sub_xxx',
+   *   newPlanId: 'pln_xxx',
+   * });
+   * ```
+   */
+  async changePlan(params, options) {
+    const { subscriptionId, ...body } = params;
+    return this.httpClient.post(
+      `/subscriptions/${subscriptionId}/change-plan`,
+      body,
+      options
+    );
+  }
 };
 
 // src/resources/usage.ts
@@ -420,6 +485,24 @@ var UsageResource = class {
     }
     return this.httpClient.post("/usage/events", eventData, options);
   }
+  /**
+   * Check if a usage event would be allowed before tracking it
+   *
+   * @example
+   * ```typescript
+   * const { data } = await commet.usage.check({
+   *   customerId: 'cus_xxx',
+   *   featureCode: 'api_calls',
+   *   quantity: 1,
+   * });
+   * if (data.allowed) {
+   *   // proceed with the operation
+   * }
+   * ```
+   */
+  async check(params, options) {
+    return this.httpClient.post("/usage/check", params, options);
+  }
 };
 
 // src/resources/webhooks.ts
@@ -544,7 +627,7 @@ var CommetValidationError = class extends CommetError {
 
 // src/version.ts
 var API_VERSION = "2026-05-18";
-var SDK_VERSION = "4.4.1";
+var SDK_VERSION = "4.6.0";
 
 // src/utils/telemetry.ts
 var registeredIntegrations = /* @__PURE__ */ new Set();
@@ -833,6 +916,7 @@ var Commet = class {
       );
     }
     this.httpClient = new CommetHTTPClient(config);
+    this.addons = new AddonsResource(this.httpClient);
     this.customers = new CustomersResource(this.httpClient);
     this.creditPacks = new CreditPacksResource(this.httpClient);
     this.plans = new PlansResource(this.httpClient);