chargebee 3.21.0 → 3.21.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+### v3.21.1 (2026-02-20)
+* * * 
+
+### Core Changes: 
+
+- Added new core utility method. 
+
 ### v3.21.0 (2026-02-11)
 * * * 
 

package/README.md

@@ -20,6 +20,16 @@ If you're upgrading from an older version of [`chargebee-typescript`](https://ww
 
 Node.js 18 or higher.
 
+## Runtime Support
+
+This SDK supports multiple JavaScript runtimes:
+
+- **Node.js** 18+
+- **Deno**
+- **Bun**
+- **Cloudflare Workers**
+- **Edge Runtimes** (e.g., Vercel Edge, Netlify Edge Functions)
+
 ## Installation
 
 Install the library with npm:
@@ -37,6 +47,16 @@ With yarn:
 yarn add chargebee
 ```
 
+With bun:
+```sh
+bun add chargebee
+```
+
+With deno:
+```sh
+deno add npm:chargebee
+```
+
 ## Usage
 
 The package needs to be configured with your site's API key, which is available under Configure Chargebee Section. Refer [here](https://www.chargebee.com/docs/2.0/api_keys.html) for more details.
@@ -63,6 +83,34 @@ const chargebee = new Chargebee({
 });
 ```
 
+### Using Deno:
+
+```typescript
+import Chargebee from "npm:chargebee";
+
+const chargebee = new Chargebee({
+  site: "{{site}}",
+  apiKey: "{{api-key}}",
+});
+
+const response = await chargebee.customer.list();
+console.log(response);
+```
+
+### Using Bun:
+
+```typescript
+import Chargebee from "chargebee";
+
+const chargebee = new Chargebee({
+  site: "{{site}}",
+  apiKey: "{{api-key}}",
+});
+
+const response = await chargebee.customer.list();
+console.log(response);
+```
+
 ### Using Async / Await
 
 ```typescript
@@ -159,6 +207,7 @@ The simplest way to handle webhooks is using the `webhooks` property on your ini
 ```typescript
 import express from 'express';
 import Chargebee, {
+  WebhookEventType,
   AuthenticationError,
   PayloadValidationError,
   PayloadParseError,
@@ -173,7 +222,7 @@ const app = express();
 app.use(express.json());
 
 // ⚠️ Register listeners once at startup, not inside request handlers
-chargebee.webhooks.on('subscription_created', async ({ event, response }) => {
+chargebee.webhooks.on(WebhookEventType.SubscriptionCreated, async ({ event, response }) => {
   console.log(`Subscription created: ${event.id}`);
   const subscription = event.content.subscription;
   console.log(`Customer: ${subscription.customer_id}`);
@@ -217,6 +266,7 @@ For more control or multiple webhook endpoints, use `chargebee.webhooks.createHa
 ```typescript
 import express, { Request, Response } from 'express';
 import Chargebee, {
+  WebhookEventType,
   basicAuthValidator,
   AuthenticationError,
   PayloadValidationError,
@@ -240,7 +290,7 @@ handler.requestValidator = basicAuthValidator((username, password) => {
 });
 
 // ⚠️ Register event listeners once at startup, not inside request handlers
-handler.on('subscription_created', async ({ event, response }) => {
+handler.on(WebhookEventType.SubscriptionCreated, async ({ event, response }) => {
   console.log(`Subscription created: ${event.id}`);
   const subscription = event.content.subscription;
   console.log(`Customer: ${subscription.customer_id}`);
@@ -248,7 +298,7 @@ handler.on('subscription_created', async ({ event, response }) => {
   response?.status(200).send('OK');
 });
 
-handler.on('payment_succeeded', async ({ event, response }) => {
+handler.on(WebhookEventType.PaymentSucceeded, async ({ event, response }) => {
   console.log(`Payment succeeded: ${event.id}`);
   const transaction = event.content.transaction;
   const customer = event.content.customer;
@@ -285,7 +335,7 @@ For more control, you can parse webhook events manually:
 
 ```typescript
 import express from 'express';
-import Chargebee, { type WebhookEvent } from 'chargebee';
+import Chargebee, { type WebhookEvent, WebhookEventType } from 'chargebee';
 
 const app = express();
 app.use(express.json());
@@ -293,23 +343,27 @@ app.use(express.json());
 app.post('/chargebee/webhooks', async (req, res) => {
   try {
     const event = req.body as WebhookEvent;
-    
+
     switch (event.event_type) {
-      case 'subscription_created':
-        // Access event content with proper typing
-        const subscription = event.content.subscription;
+      case WebhookEventType.SubscriptionCreated: {
+        // Cast to specific event type for proper content typing
+        const typedEvent = event as WebhookEvent<WebhookEventType.SubscriptionCreated>;
+        const subscription = typedEvent.content.subscription;
         console.log('Subscription created:', subscription.id);
         break;
-        
-      case 'payment_succeeded':
-        const transaction = event.content.transaction;
+      }
+
+      case WebhookEventType.PaymentSucceeded: {
+        const typedEvent = event as WebhookEvent<WebhookEventType.PaymentSucceeded>;
+        const transaction = typedEvent.content.transaction;
         console.log('Payment succeeded:', transaction.amount);
         break;
-        
+      }
+
       default:
         console.log('Unhandled event type:', event.event_type);
     }
-    
+
     res.status(200).send('OK');
   } catch (err) {
     console.error('Error processing webhook:', err);
@@ -327,7 +381,7 @@ app.listen(8080);
 **Respond with 200** to acknowledge receipt:
 
 ```typescript
-handler.on('subscription_created', async ({ event, response }) => {
+handler.on(WebhookEventType.SubscriptionCreated, async ({ event, response }) => {
   await provisionAccess(event.content.subscription);
   response?.status(200).json({ received: true });
 });
@@ -336,7 +390,7 @@ handler.on('subscription_created', async ({ event, response }) => {
 **Respond with 5xx** so Chargebee retries on failure:
 
 ```typescript
-handler.on('payment_succeeded', async ({ event, response }) => {
+handler.on(WebhookEventType.PaymentSucceeded, async ({ event, response }) => {
   try {
     await recordPayment(event.content.transaction);
     response?.status(200).send('OK');
@@ -349,7 +403,7 @@ handler.on('payment_succeeded', async ({ event, response }) => {
 **Access request context** (headers, middleware data):
 
 ```typescript
-handler.on('customer_created', async ({ event, request, response }) => {
+handler.on(WebhookEventType.CustomerCreated, async ({ event, request, response }) => {
   const tenantId = (request as any)?.tenant?.id;
   await createCustomerForTenant(tenantId, event.content.customer);
   response?.status(200).send('OK');

package/cjs/createChargebee.js

@@ -18,6 +18,9 @@ const CreateChargebee = (httpClient) => {
         this._endpoints = api_endpoints_js_1.Endpoints;
         // Initialize webhooks handler with auto-configured Basic Auth (if env vars are set)
         const handler = (0, handler_js_1.createDefaultHandler)();
+        this.__clientIdentifier = (serviceName) => {
+            (0, util_js_1.extend)(true, this._env, { userAgentSuffix: serviceName });
+        };
         // Create webhooks namespace with handler methods + createHandler factory
         this.webhooks = Object.assign(handler, {
             createHandler(options) {

package/cjs/environment.js

@@ -11,7 +11,7 @@ exports.Environment = {
     hostSuffix: '.chargebee.com',
     apiPath: '/api/v2',
     timeout: DEFAULT_TIME_OUT,
-    clientVersion: 'v3.21.0',
+    clientVersion: 'v3.21.1',
     port: DEFAULT_PORT,
     timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
     exportWaitInMillis: DEFAULT_EXPORT_WAIT,

package/esm/createChargebee.js

@@ -15,6 +15,9 @@ export const CreateChargebee = (httpClient) => {
         this._endpoints = Endpoints;
         // Initialize webhooks handler with auto-configured Basic Auth (if env vars are set)
         const handler = createDefaultHandler();
+        this.__clientIdentifier = (serviceName) => {
+            extend(true, this._env, { userAgentSuffix: serviceName });
+        };
         // Create webhooks namespace with handler methods + createHandler factory
         this.webhooks = Object.assign(handler, {
             createHandler(options) {

package/esm/environment.js

@@ -8,7 +8,7 @@ export const Environment = {
     hostSuffix: '.chargebee.com',
     apiPath: '/api/v2',
     timeout: DEFAULT_TIME_OUT,
-    clientVersion: 'v3.21.0',
+    clientVersion: 'v3.21.1',
     port: DEFAULT_PORT,
     timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
     exportWaitInMillis: DEFAULT_EXPORT_WAIT,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chargebee",
-  "version": "3.21.0",
+  "version": "3.21.1",
   "description": "A library for integrating with Chargebee.",
   "scripts": {
     "prepack": "npm install && npm run build",