chargebee 3.19.0 → 3.21.0

package/types/index.d.ts

@@ -6,7 +6,6 @@
 ///<reference path='./resources/BillingConfiguration.d.ts' />
 ///<reference path='./resources/Brand.d.ts' />
 ///<reference path='./resources/BusinessEntity.d.ts' />
-///<reference path='./resources/BusinessEntityChange.d.ts' />
 ///<reference path='./resources/BusinessEntityTransfer.d.ts' />
 ///<reference path='./resources/Card.d.ts' />
 ///<reference path='./resources/Comment.d.ts' />
@@ -70,7 +69,6 @@
 ///<reference path='./resources/PortalSession.d.ts' />
 ///<reference path='./resources/PriceVariant.d.ts' />
 ///<reference path='./resources/PricingPageSession.d.ts' />
-///<reference path='./resources/Product.d.ts' />
 ///<reference path='./resources/PromotionalCredit.d.ts' />
 ///<reference path='./resources/Purchase.d.ts' />
 ///<reference path='./resources/Quote.d.ts' />
@@ -83,7 +81,6 @@
 ///<reference path='./resources/RecordedPurchase.d.ts' />
 ///<reference path='./resources/ResourceMigration.d.ts' />
 ///<reference path='./resources/Rule.d.ts' />
-///<reference path='./resources/SalesOrder.d.ts' />
 ///<reference path='./resources/SiteMigrationDetail.d.ts' />
 ///<reference path='./resources/Subscription.d.ts' />
 ///<reference path='./resources/SubscriptionEntitlement.d.ts' />
@@ -99,8 +96,6 @@
 ///<reference path='./resources/Usage.d.ts' />
 ///<reference path='./resources/UsageEvent.d.ts' />
 ///<reference path='./resources/UsageFile.d.ts' />
-///<reference path='./resources/UsageReminderInfo.d.ts' />
-///<reference path='./resources/Variant.d.ts' />
 ///<reference path='./resources/VirtualBankAccount.d.ts' />
 ///<reference path='./resources/WebhookEndpoint.d.ts' />
 ///<reference path='./resources/Content.d.ts' />
@@ -229,7 +224,6 @@ declare module 'chargebee' {
     portalSession: PortalSession.PortalSessionResource;
     priceVariant: PriceVariant.PriceVariantResource;
     pricingPageSession: PricingPageSession.PricingPageSessionResource;
-    product: Product.ProductResource;
     promotionalCredit: PromotionalCredit.PromotionalCreditResource;
     purchase: Purchase.PurchaseResource;
     quote: Quote.QuoteResource;
@@ -246,8 +240,197 @@ declare module 'chargebee' {
     usage: Usage.UsageResource;
     usageEvent: UsageEvent.UsageEventResource;
     usageFile: UsageFile.UsageFileResource;
-    variant: Variant.VariantResource;
     virtualBankAccount: VirtualBankAccount.VirtualBankAccountResource;
     webhookEndpoint: WebhookEndpoint.WebhookEndpointResource;
+
+    /** Webhook handler instance with auto-configured Basic Auth (if env vars are set) */
+    webhooks: WebhookHandler & {
+      /** Create a new typed webhook handler instance */
+      createHandler<ReqT = unknown, ResT = unknown>(
+        options?: WebhookHandlerOptions,
+      ): WebhookHandler<ReqT, ResT>;
+    };
+  }
+
+  // Webhook Handler Types
+  export type WebhookEventName = EventTypeEnum | 'unhandled_event';
+  export type WebhookEventTypeValue = `${WebhookEventType}`;
+  /**
+   * @deprecated Renamed to `WebhookEventTypeValue` for clarity. Use `WebhookEventTypeValue` instead.
+   * This alias will be removed in the next major version.
+   */
+  export type WebhookContentTypeValue = WebhookEventTypeValue;
+
+  /**
+   * Context object passed to webhook event listeners.
+   * Wraps the event data with optional framework-specific request/response objects.
+   */
+  export interface WebhookContext<ReqT = unknown, ResT = unknown> {
+    /** The parsed webhook event from Chargebee */
+    event: WebhookEvent;
+    /** Framework-specific request object (Express, Fastify, etc.) */
+    request?: ReqT;
+    /** Framework-specific response object (Express, Fastify, etc.) */
+    response?: ResT;
+  }
+
+  /**
+   * Context object passed to webhook error listeners.
+   * Contains the request/response objects so errors can be handled appropriately.
+   */
+  export interface WebhookErrorContext<ReqT = unknown, ResT = unknown> {
+    /** Framework-specific request object (Express, Fastify, etc.) */
+    request?: ReqT;
+    /** Framework-specific response object (Express, Fastify, etc.) */
+    response?: ResT;
+  }
+
+  /**
+   * Validator function type for authenticating webhook requests.
+   * Can be synchronous or asynchronous.
+   */
+  export type RequestValidator = (
+    headers: Record<string, string | string[] | undefined>,
+  ) => void | Promise<void>;
+
+  /**
+   * Configuration options for WebhookHandler.
+   */
+  export interface WebhookHandlerOptions {
+    /**
+     * Optional validator function to authenticate incoming webhook requests.
+     * Typically used for Basic Auth validation.
+     * Can be sync or async - throw an error to reject the request.
+     */
+    requestValidator?: RequestValidator;
+  }
+
+  /**
+   * Options for the handle() method.
+   */
+  export interface HandleOptions<ReqT = unknown, ResT = unknown> {
+    /** The raw request body (string) or pre-parsed object */
+    body: string | object;
+    /** Optional HTTP headers for validation */
+    headers?: Record<string, string | string[] | undefined>;
+    /** Optional framework-specific request object (Express, Fastify, etc.) */
+    request?: ReqT;
+    /** Optional framework-specific response object (Express, Fastify, etc.) */
+    response?: ResT;
+  }
+
+  export type WebhookEventListener<
+    ReqT = unknown,
+    ResT = unknown,
+    T extends WebhookEventType = WebhookEventType,
+  > = (
+    context: WebhookContext<ReqT, ResT> & { event: WebhookEvent<T> },
+  ) => Promise<void> | void;
+  export type WebhookErrorListener<ReqT = unknown, ResT = unknown> = (
+    error: Error,
+    context: WebhookErrorContext<ReqT, ResT>,
+  ) => Promise<void> | void;
+
+  // Helper type to map string literal to enum member
+  type StringToWebhookEventType<S extends WebhookEventTypeValue> = {
+    [K in WebhookEventType]: `${K}` extends S ? K : never;
+  }[WebhookEventType];
+
+  export interface WebhookHandler<ReqT = unknown, ResT = unknown> {
+    on<T extends WebhookEventType>(
+      eventName: T,
+      listener: WebhookEventListener<ReqT, ResT, T>,
+    ): this;
+    on<S extends WebhookEventTypeValue>(
+      eventName: S,
+      listener: WebhookEventListener<ReqT, ResT, StringToWebhookEventType<S>>,
+    ): this;
+    on(
+      eventName: 'unhandled_event',
+      listener: WebhookEventListener<ReqT, ResT>,
+    ): this;
+    on(eventName: 'error', listener: WebhookErrorListener<ReqT, ResT>): this;
+    once<T extends WebhookEventType>(
+      eventName: T,
+      listener: WebhookEventListener<ReqT, ResT, T>,
+    ): this;
+    once<S extends WebhookEventTypeValue>(
+      eventName: S,
+      listener: WebhookEventListener<ReqT, ResT, StringToWebhookEventType<S>>,
+    ): this;
+    once(
+      eventName: 'unhandled_event',
+      listener: WebhookEventListener<ReqT, ResT>,
+    ): this;
+    once(eventName: 'error', listener: WebhookErrorListener<ReqT, ResT>): this;
+    off<T extends WebhookEventType>(
+      eventName: T,
+      listener: WebhookEventListener<ReqT, ResT, T>,
+    ): this;
+    off<S extends WebhookEventTypeValue>(
+      eventName: S,
+      listener: WebhookEventListener<ReqT, ResT, StringToWebhookEventType<S>>,
+    ): this;
+    off(
+      eventName: 'unhandled_event',
+      listener: WebhookEventListener<ReqT, ResT>,
+    ): this;
+    off(eventName: 'error', listener: WebhookErrorListener<ReqT, ResT>): this;
+    handle(options: HandleOptions<ReqT, ResT>): Promise<void>;
+    requestValidator: RequestValidator | undefined;
+  }
+
+  // Webhook Auth
+  /**
+   * Credential validator function type.
+   * Can be synchronous or asynchronous (e.g., for database lookups).
+   */
+  export type CredentialValidator = (
+    username: string,
+    password: string,
+  ) => boolean | Promise<boolean>;
+
+  /**
+   * Creates a Basic Auth validator for webhook requests.
+   */
+  export function basicAuthValidator(
+    validateCredentials: CredentialValidator,
+  ): (headers: Record<string, string | string[] | undefined>) => Promise<void>;
+
+  // Webhook Error Classes
+  /**
+   * Base class for all webhook-related errors.
+   */
+  export class WebhookError extends Error {
+    constructor(message: string);
+    name: string;
+  }
+
+  /**
+   * Authentication error thrown when webhook request authentication fails.
+   * Typically maps to HTTP 401 Unauthorized.
+   */
+  export class WebhookAuthenticationError extends WebhookError {
+    constructor(message: string);
+    name: string;
+  }
+
+  /**
+   * Payload validation error thrown when the webhook payload structure is invalid.
+   * Typically maps to HTTP 400 Bad Request.
+   */
+  export class WebhookPayloadValidationError extends WebhookError {
+    constructor(message: string);
+    name: string;
+  }
+
+  /**
+   * JSON parsing error thrown when the webhook body cannot be parsed as JSON.
+   * Typically maps to HTTP 400 Bad Request.
+   */
+  export class WebhookPayloadParseError extends WebhookError {
+    constructor(message: string, rawBody?: string);
+    name: string;
+    readonly rawBody?: string;
   }
 }

package/types/resources/Content.d.ts

@@ -11,7 +11,6 @@ declare module 'chargebee' {
     billing_configuration: BillingConfiguration;
     brand: Brand;
     business_entity: BusinessEntity;
-    business_entity_change: BusinessEntityChange;
     business_entity_transfer: BusinessEntityTransfer;
     card: Card;
     comment: Comment;
@@ -75,7 +74,6 @@ declare module 'chargebee' {
     portal_session: PortalSession;
     price_variant: PriceVariant;
     pricing_page_session: PricingPageSession;
-    product: Product;
     promotional_credit: PromotionalCredit;
     purchase: Purchase;
     quote: Quote;
@@ -88,7 +86,6 @@ declare module 'chargebee' {
     recorded_purchase: RecordedPurchase;
     resource_migration: ResourceMigration;
     rule: Rule;
-    sales_order: SalesOrder;
     site_migration_detail: SiteMigrationDetail;
     subscription: Subscription;
     subscription_entitlement: SubscriptionEntitlement;
@@ -104,8 +101,6 @@ declare module 'chargebee' {
     usage: Usage;
     usage_event: UsageEvent;
     usage_file: UsageFile;
-    usage_reminder_info: UsageReminderInfo;
-    variant: Variant;
     virtual_bank_account: VirtualBankAccount;
     webhook_endpoint: WebhookEndpoint;
   }

package/types/resources/CreditNote.d.ts

@@ -428,7 +428,14 @@ declare module 'chargebee' {
         | 'in_progress'
         | 'success'
         | 'failed'
-        | 'registered';
+        | 'registered'
+        | 'accepted'
+        | 'rejected'
+        | 'message_acknowledgement'
+        | 'in_process'
+        | 'under_query'
+        | 'conditionally_accepted'
+        | 'paid';
       message?: string;
     }
     export interface SiteDetailsAtCreation {

package/types/resources/Customer.d.ts

@@ -755,7 +755,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -933,7 +939,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       /**
        * @deprecated Please refer API docs to use other attributes
        */

package/types/resources/Einvoice.d.ts

@@ -11,7 +11,14 @@ declare module 'chargebee' {
       | 'in_progress'
       | 'success'
       | 'failed'
-      | 'registered';
+      | 'registered'
+      | 'accepted'
+      | 'rejected'
+      | 'message_acknowledgement'
+      | 'in_process'
+      | 'under_query'
+      | 'conditionally_accepted'
+      | 'paid';
     message?: string;
   }
 }

package/types/resources/EntitlementOverride.d.ts

@@ -4,6 +4,7 @@
 declare module 'chargebee' {
   export interface EntitlementOverride {
     id: string;
+    subscription_id?: string;
     entity_id?: string;
     entity_type?: string;
     feature_id?: string;
@@ -12,6 +13,7 @@ declare module 'chargebee' {
     name?: string;
     expires_at?: number;
     effective_from?: number;
+    is_enabled: boolean;
     schedule_status?: 'activated' | 'scheduled' | 'failed';
   }
 
@@ -68,9 +70,12 @@ declare module 'chargebee' {
     }
     export interface EntitlementOverridesAddEntitlementOverrideForSubscriptionInputParam {
       feature_id: string;
+      entity_id?: string;
+      entity_type?: EntityTypeEnum;
       value?: string;
       expires_at?: number;
       effective_from?: number;
+      is_enabled?: boolean;
     }
   }
 }

package/types/resources/Estimate.d.ts

@@ -1047,7 +1047,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1130,7 +1136,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/Event.d.ts

@@ -122,6 +122,7 @@ declare module 'chargebee' {
       CardUpdatedContent &
       CustomerCreatedContent &
       SubscriptionRenewalReminderContent &
+      PaymentDueReminderContent &
       OrderDeliveredContent &
       OmnichannelSubscriptionItemCancellationScheduledContent &
       OmnichannelSubscriptionItemGracePeriodExpiredContent &

package/types/resources/Gift.d.ts

@@ -208,7 +208,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -285,7 +291,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/HostedPage.d.ts

@@ -414,6 +414,7 @@ declare module 'chargebee' {
     export interface CollectNowInputParam {
       redirect_url?: string;
       currency_code?: string;
+      payment_method_save_policy?: PaymentMethodSavePolicyEnum;
       customer?: CustomerCollectNowInputParam;
       card?: CardCollectNowInputParam;
     }

package/types/resources/Invoice.d.ts

@@ -844,7 +844,14 @@ declare module 'chargebee' {
         | 'in_progress'
         | 'success'
         | 'failed'
-        | 'registered';
+        | 'registered'
+        | 'accepted'
+        | 'rejected'
+        | 'message_acknowledgement'
+        | 'in_process'
+        | 'under_query'
+        | 'conditionally_accepted'
+        | 'paid';
       message?: string;
     }
     export interface SiteDetailsAtCreation {
@@ -1265,7 +1272,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes
@@ -1417,7 +1430,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/OmnichannelSubscription.d.ts

@@ -65,6 +65,7 @@ declare module 'chargebee' {
     export interface ListInputParam {
       limit?: number;
       offset?: string;
+      omnichannel_subscription_item?: OmnichannelSubscriptionItemOmnichannelSubscriptionListInputParam;
       source?: filter.Enum;
       customer_id?: filter.String;
     }
@@ -75,5 +76,9 @@ declare module 'chargebee' {
     export interface MoveInputParam {
       to_customer_id: string;
     }
+    export interface OmnichannelSubscriptionItemOmnichannelSubscriptionListInputParam {
+      status?: filter.Enum;
+      item_id_at_source?: filter.String;
+    }
   }
 }

package/types/resources/PaymentIntent.d.ts

@@ -36,7 +36,13 @@ declare module 'chargebee' {
       | 'kbc_payment_button'
       | 'pay_by_bank'
       | 'trustly'
-      | 'stablecoin';
+      | 'stablecoin'
+      | 'kakao_pay'
+      | 'naver_pay'
+      | 'revolut_pay'
+      | 'cash_app_pay'
+      | 'wechat_pay'
+      | 'alipay';
     success_url?: string;
     failure_url?: string;
     created_at: number;
@@ -117,7 +123,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       id_at_gateway?: string;
       error_code?: string;
       error_text?: string;
@@ -162,7 +174,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       id_at_gateway?: string;
       error_code?: string;
       error_text?: string;
@@ -207,7 +225,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       success_url?: string;
       failure_url?: string;
     }
@@ -241,7 +265,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       success_url?: string;
       failure_url?: string;
     }

package/types/resources/PaymentSource.d.ts

@@ -458,7 +458,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes

package/types/resources/PricingPageSession.d.ts

@@ -113,7 +113,7 @@ declare module 'chargebee' {
       label?: string;
     }
     export interface PricingPageCreateForExistingSubscriptionInputParam {
-      id: string;
+      id?: string;
     }
     export interface SubscriptionCreateForExistingSubscriptionInputParam {
       id: string;

package/types/resources/Purchase.d.ts

@@ -103,7 +103,13 @@ declare module 'chargebee' {
         | 'kbc_payment_button'
         | 'pay_by_bank'
         | 'trustly'
-        | 'stablecoin';
+        | 'stablecoin'
+        | 'kakao_pay'
+        | 'naver_pay'
+        | 'revolut_pay'
+        | 'cash_app_pay'
+        | 'wechat_pay'
+        | 'alipay';
       reference_id?: string;
       /**
        * @deprecated Please refer API docs to use other attributes