chargebee 3.13.0 → 3.15.0

package/CHANGELOG.md

@@ -1,3 +1,91 @@
+### v3.15.0 (2025-10-28)
+* * * 
+
+### New Attributes: 
+* reference_transactions has been added to Invoice.
+* payment_attempts[] has been added to PaymentIntent.
+* checkout_details has been added to PaymentIntent#PaymentAttempt.
+* line_item_id has been added to CreditNoteEstimate#Discount.
+* line_item_id has been added to CreditNote#Discount.
+* line_item_id has been added to InvoiceEstimate#Discount.
+* line_item_id has been added to Invoice#Discount.
+* line_item_id has been added to InvoiceEstimate#Discount.
+* line_item_id has been added to Quote#Discount.
+* line_item_id has been added to QuoteLineGroup#Discount.
+
+### Modified Attributes: 
+* omnichannel_subscription_item_offers has been made optional attribute from required attribute.
+
+### New Input Parameters: 
+* discount[line_item_id] has been added to CreditNote#ImportCreditNoteRequest.
+* discount[line_item_id] has been added to CreditNote#ImportInvoiceRequest.
+
+### New Enums: 
+* OMNICHANNEL_TRANSACTION_CREATED has been added to EventTypeEnum.
+* DEUTSCHE_BANK has been added to Gateway.
+
+### Enhancements
+* Added support for injectable **custom HTTP clients**.
+* Added example implementation using **Axios**.
+* Added example implementation using **ky**.
+* Removed support for `http` and `https` based HttpClient as the minimum supported Node.js version for this package is >= 18.
+
+### v3.14.0 (2025-09-23)
+* * * 
+
+### New Resources: 
+* PersonalizedOffer has been added.
+* OfferFulfillment has been added. 
+* OfferEvent has been added. 
+* OmnichannelSubscriptionItemOffer has been added.
+
+### New Attributes: 
+* business_entity_id has been added to Customer#Balance.
+* processor_advice_code has been added to GatewayErrorDetail.
+* processor_advice_code has been added to Transaction#GatewayErrorDetail.
+* omnichannel_subscription_item_offers has been added to OmnichannelSubscriptionItem.
+* linked_omnichannel_subscriptions has been added to OmnichannelTransaction.
+* linked_omnichannel_one_time_orders has been added to OmnichannelTransaction.
+* contract_term has been added to Ramp.
+* charge_once has been added to Ramp#ItemsToAdd.
+* charge_on_option has been added to Ramp#ItemsToAdd.
+* charge_on_event has been added to Ramp#ItemsToAdd.
+* charge_once has been added to Ramp#ItemsToUpdate.
+* charge_on_option has been added to Ramp#ItemsToUpdate.
+* charge_on_event has been added to Ramp#ItemsToUpdate.
+* error_file_path has been added to UsageFile.
+* error_file_url has been added to UsageFile.
+
+### New Endpoint: 
+* move has been added to OmnichannelSubscription.
+
+### New Parameters: 
+* offline_payment_method has been added to Estimate#CreateSubItemEstimateRequest.
+* offline_payment_method has been added to Estimate#CreateSubItemForCustomerEstimateRequest.
+* offline_payment_method has been added to HostedPage#CheckoutNewForItemsRequest.
+* offline_payment_method has been added to Quote#SubscriptionCreateSubItemsForCustomerQuoteRequest.
+* offline_payment_method has been added to Quote#SubscriptionEditCreateSubCustomerQuoteForItemsRequest.
+* contract_term has been added to Ramp#CreateForSubscriptionRequest.
+* items_to_add has been added to Ramp#CreateForSubscriptionRequest.
+* items_to_update has been added to Ramp#CreateForSubscriptionRequest.
+* contract_term has been added to Ramp#UpdateRequest.
+* items_to_add has been added to Ramp#UpdateRequest.
+* items_to_update has been added to Ramp#UpdateRequest.
+
+### New Enums: 
+* DUNNING_UPDATED has been added EventType.
+* OMNICHANNEL_SUBSCRIPTION_MOVED_IN has been added to EventType.
+
+
+### Bug Fixes: 
+* currency list action has been marked as ListRequest. 
+* index has been removed from CreditNote#ShippingAddress.
+* index has been removed from Invoice#ShippingAddress
+* index has been removed from Order#ShippingAddress.
+* index has been removed from Quote#ShippingAddress.
+* index has been removed from SubscriptionEstimate#ShippingAddress.
+* index has been removed from Subscription#ShippingAddress.
+
 ### v3.13.0 (2025-09-15)
 * * * 
 

package/README.md

@@ -237,6 +237,30 @@ const subscription = subscripitonActivatedEvent.content.subscription;
 * Use the `WebhookContentType` to specify the exact event type (e.g., `SubscriptionCreated`, `InvoiceGenerated`, etc.).
 * This approach ensures you get proper IntelliSense and compile-time checks when accessing event fields.
 
+### Custom HTTP Client
+
+The SDK supports injecting a **custom HTTP client**, giving you full flexibility to control how API requests are made and handled. This feature is useful if you want to integrate your own networking stack, add custom logging, implement telemetry, or handle retries in a specific way.
+
+With this enhancement, you can replace the default HTTP client with your own implementation by passing a custom client that adheres to the `HttpClientInterface` contract when initializing the Chargebee instance.
+
+```js
+const chargebee = new Chargebee({
+    site: "{site}",
+    apiKey: "{key}",
+    httpClient: new CustomHttpClient(),
+});
+```
+
+#### Notes
+* Your custom client must implement the `HttpClientInterface` provided by the SDK.
+* This feature is especially useful in environments with strict networking policies or where advanced observability is required.
+* Example implementations are available under:
+
+  * [`/examples/customHttpClient/axiosHttpClient.ts`](./examples/customHttpClient/axiosHttpClient.ts)
+  * [`/examples/customHttpClient/kyHttpClient.ts`](./examples/customHttpClient/kyHttpClient.ts)
+* You may need to implement custom conversion logic when integrating third-party HTTP libraries, as their request and response formats might not directly align with the `HttpClientInterface` expected by the SDK.
+
+These examples demonstrate how to implement and inject custom clients using `axios` and `ky`, respectively.
 
 ## Feedback
 

package/cjs/RequestWrapper.js

@@ -86,16 +86,13 @@ class RequestWrapper {
             if (attempt > 0) {
                 requestHeaders['X-CB-Retry-Attempt'] = attempt.toString();
             }
-            const resp = await this.envArg.httpClient.makeApiRequest({
-                host: (0, util_js_1.getHost)(env, this.apiCall.subDomain),
-                port: env.port,
-                path,
+            const url = new URL(path, `${env.protocol}://${(0, util_js_1.getHost)(env, this.apiCall.subDomain)}${env.port ? `:${env.port}` : ''}`);
+            const request = new Request(url, {
                 method: this.apiCall.httpMethod,
-                protocol: env.protocol,
-                headers: requestHeaders,
-                data,
-                timeout: env.timeout,
+                body: data !== null && data !== void 0 ? data : undefined,
+                headers: this._createHeaders(requestHeaders),
             });
+            const resp = await this.envArg.httpClient.makeApiRequest(request, env.timeout);
             return new Promise((resolve, reject) => {
                 (0, coreCommon_js_1.handleResponse)((err, response) => {
                     if (err)
@@ -155,5 +152,12 @@ class RequestWrapper {
         const promise = withRetry(0, Date.now());
         return (0, util_js_1.callbackifyPromise)(promise);
     }
+    _createHeaders(httpHeaders) {
+        const headers = new Headers();
+        Object.entries(httpHeaders).forEach(([key, value]) => {
+            headers.append(key, String(value));
+        });
+        return headers;
+    }
 }
 exports.RequestWrapper = RequestWrapper;

package/cjs/chargebee.cjs.js

@@ -1,12 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const createChargebee_js_1 = require("./createChargebee.js");
-const NodeClient_js_1 = require("./net/NodeClient.js");
 const FetchClient_js_1 = require("./net/FetchClient.js");
-//@ts-ignore
-const httpClient = !globalThis.fetch
-    ? new NodeClient_js_1.NodeHttpClient()
-    : new FetchClient_js_1.FetchHttpClient();
+const httpClient = new FetchClient_js_1.FetchHttpClient();
 const Chargebee = (0, createChargebee_js_1.CreateChargebee)(httpClient);
 module.exports = Chargebee;
 module.exports.Chargebee = Chargebee;

package/cjs/coreCommon.js

@@ -21,9 +21,9 @@ function throwError(callBack, rawError, headers) {
 }
 const handleResponse = async (callback, response) => {
     try {
-        const res = await response.toJson();
-        const status = response.getStatusCode();
-        const headers = response.getHeaders();
+        const status = response.status;
+        const headers = Object.fromEntries(response.headers.entries());
+        const res = status === 204 ? {} : await response.json();
         if (status && (status < 200 || status > 299)) {
             res.http_status_code = status;
             res.headers = headers;
@@ -40,8 +40,8 @@ const handleResponse = async (callback, response) => {
         }
     }
     catch (error) {
-        const status = response.getStatusCode();
-        const headers = response.getHeaders();
+        const status = response.status;
+        const headers = Object.fromEntries(response.headers.entries());
         switch (status) {
             case 503:
                 return throwError(callback, {

package/cjs/createChargebee.js

@@ -11,7 +11,8 @@ const CreateChargebee = (httpClient) => {
         this._env = Object.assign({}, environment_js_1.Environment);
         (0, util_js_1.extend)(true, this._env, conf);
         // @ts-ignore
-        this._env.httpClient = httpClient;
+        this._env.httpClient =
+            conf.httpClient != null ? conf.httpClient : httpClient;
         this._buildResources();
         this._endpoints = api_endpoints_js_1.Endpoints;
     };

package/cjs/environment.js

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

package/cjs/net/ClientInterface.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpClientResponse = exports.HttpClient = void 0;
+exports.HttpClient = void 0;
 const chargebeeError_js_1 = require("../chargebeeError.js");
 class HttpClient {
-    async makeApiRequest(props) {
+    async makeApiRequest(props, timeout) {
         throw new Error('makeApiRequest is not implemented');
     }
     static timeOutError() {
@@ -19,22 +19,3 @@ class HttpClient {
     }
 }
 exports.HttpClient = HttpClient;
-class HttpClientResponse {
-    constructor(statusCode, headers) {
-        this._statusCode = statusCode;
-        this._headers = headers;
-    }
-    getStatusCode() {
-        return this._statusCode;
-    }
-    getHeaders() {
-        return this._headers;
-    }
-    getRawResponse() {
-        throw new Error('getRawResponse not implemented.');
-    }
-    toJson() {
-        throw new Error('toJSON not implemented.');
-    }
-}
-exports.HttpClientResponse = HttpClientResponse;

package/cjs/net/FetchClient.js

@@ -1,21 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FetchHttpClientResponse = exports.FetchHttpClient = void 0;
+exports.FetchHttpClient = void 0;
 const ClientInterface_js_1 = require("./ClientInterface.js");
 class FetchHttpClient extends ClientInterface_js_1.HttpClient {
-    async makeApiRequest(props) {
-        const headers = this._createHeaders(props.headers);
-        let url = `${props.protocol}://${props.host}:${props.port}${props.path}`;
-        let fetchOptions = {
-            method: props.method,
-            headers: headers,
-            body: props.data ? props.data : undefined,
-        };
+    async makeApiRequest(request, timeout) {
         try {
             const response = globalThis.AbortController
-                ? await this.fetchWithAbortTimeout(url, fetchOptions, props.timeout)
-                : await this.fetchWithTimeout(url, fetchOptions, props.timeout);
-            return new FetchHttpClientResponse(response);
+                ? await this.fetchWithAbortTimeout(request, timeout)
+                : await this.fetchWithTimeout(request, timeout);
+            return response;
         }
         catch (err) {
             return Promise.reject(err);
@@ -28,7 +21,7 @@ class FetchHttpClient extends ClientInterface_js_1.HttpClient {
         });
         return headers;
     }
-    async fetchWithTimeout(url, fetchOptions, timeout) {
+    async fetchWithTimeout(request, timeout) {
         let pendingTimeoutId;
         const timeoutPromise = new Promise((_, reject) => {
             pendingTimeoutId = setTimeout(() => {
@@ -36,21 +29,21 @@ class FetchHttpClient extends ClientInterface_js_1.HttpClient {
                 reject(ClientInterface_js_1.HttpClient.timeOutError());
             }, timeout);
         });
-        const fetchPromise = fetch(url, fetchOptions);
+        const fetchPromise = fetch(request);
         return Promise.race([fetchPromise, timeoutPromise]).finally(() => {
             if (pendingTimeoutId) {
                 clearTimeout(pendingTimeoutId);
             }
         });
     }
-    async fetchWithAbortTimeout(url, fetchOptions, timeout) {
+    async fetchWithAbortTimeout(request, timeout) {
         const abort = new AbortController();
         let timeoutId = setTimeout(() => {
             timeoutId = null;
             abort.abort(ClientInterface_js_1.HttpClient.timeOutError());
         }, timeout);
         try {
-            return await fetch(url, Object.assign(Object.assign({}, fetchOptions), { signal: abort.signal }));
+            return await fetch(new Request(request, { signal: abort.signal }));
         }
         catch (err) {
             if (err.name === 'AbortError') {
@@ -68,26 +61,3 @@ class FetchHttpClient extends ClientInterface_js_1.HttpClient {
     }
 }
 exports.FetchHttpClient = FetchHttpClient;
-class FetchHttpClientResponse extends ClientInterface_js_1.HttpClientResponse {
-    constructor(response) {
-        super(response.status, FetchHttpClientResponse._transformHeadersToObject(response.headers));
-        this._res = response;
-    }
-    getRawResponse() {
-        return this._res;
-    }
-    toJson() {
-        return this._res.json();
-    }
-    static _transformHeadersToObject(headers) {
-        const headersObj = {};
-        for (const entry of headers) {
-            if (!Array.isArray(entry) || entry.length != 2) {
-                throw new Error('Headers should be an iterable object.');
-            }
-            headersObj[entry[0]] = entry[1];
-        }
-        return headersObj;
-    }
-}
-exports.FetchHttpClientResponse = FetchHttpClientResponse;

package/cjs/resources/api_endpoints.js

@@ -4645,6 +4645,19 @@ exports.Endpoints = {
             {},
             {},
         ],
+        [
+            'move',
+            'POST',
+            '/omnichannel_subscriptions',
+            '/move',
+            true,
+            null,
+            false,
+            {},
+            {
+                isIdempotent: true,
+            },
+        ],
     ],
     omnichannelTransaction: [],
     omnichannelSubscriptionItem: [
@@ -4755,7 +4768,60 @@ exports.Endpoints = {
             {},
         ],
     ],
+    personalizedOffer: [
+        [
+            'personalizedOffers',
+            'POST',
+            '/personalized_offers',
+            null,
+            false,
+            'grow',
+            true,
+            {
+                custom: 0,
+            },
+            {},
+        ],
+    ],
     brand: [],
+    offerFulfillment: [
+        [
+            'offerFulfillments',
+            'POST',
+            '/offer_fulfillments',
+            null,
+            false,
+            'grow',
+            true,
+            {},
+            {},
+        ],
+        [
+            'offerFulfillmentsGet',
+            'GET',
+            '/offer_fulfillments',
+            null,
+            true,
+            'grow',
+            true,
+            {},
+            {},
+        ],
+        [
+            'offerFulfillmentsUpdate',
+            'POST',
+            '/offer_fulfillments',
+            null,
+            true,
+            'grow',
+            true,
+            {},
+            {},
+        ],
+    ],
+    offerEvent: [
+        ['offerEvents', 'POST', '/offer_events', null, false, 'grow', true, {}, {}],
+    ],
     webhookEndpoint: [
         [
             'create',

package/esm/RequestWrapper.js

@@ -83,16 +83,13 @@ export class RequestWrapper {
             if (attempt > 0) {
                 requestHeaders['X-CB-Retry-Attempt'] = attempt.toString();
             }
-            const resp = await this.envArg.httpClient.makeApiRequest({
-                host: getHost(env, this.apiCall.subDomain),
-                port: env.port,
-                path,
+            const url = new URL(path, `${env.protocol}://${getHost(env, this.apiCall.subDomain)}${env.port ? `:${env.port}` : ''}`);
+            const request = new Request(url, {
                 method: this.apiCall.httpMethod,
-                protocol: env.protocol,
-                headers: requestHeaders,
-                data,
-                timeout: env.timeout,
+                body: data !== null && data !== void 0 ? data : undefined,
+                headers: this._createHeaders(requestHeaders),
             });
+            const resp = await this.envArg.httpClient.makeApiRequest(request, env.timeout);
             return new Promise((resolve, reject) => {
                 handleResponse((err, response) => {
                     if (err)
@@ -152,4 +149,11 @@ export class RequestWrapper {
         const promise = withRetry(0, Date.now());
         return callbackifyPromise(promise);
     }
+    _createHeaders(httpHeaders) {
+        const headers = new Headers();
+        Object.entries(httpHeaders).forEach(([key, value]) => {
+            headers.append(key, String(value));
+        });
+        return headers;
+    }
 }

package/esm/chargebee.esm.js

@@ -1,9 +1,5 @@
 import { CreateChargebee } from './createChargebee.js';
-import { NodeHttpClient } from './net/NodeClient.js';
 import { FetchHttpClient } from './net/FetchClient.js';
-//@ts-ignore
-const httpClient = !globalThis.fetch
-    ? new NodeHttpClient()
-    : new FetchHttpClient();
+const httpClient = new FetchHttpClient();
 const Chargebee = CreateChargebee(httpClient);
 export default Chargebee;

package/esm/coreCommon.js

@@ -17,9 +17,9 @@ export function throwError(callBack, rawError, headers) {
 }
 export const handleResponse = async (callback, response) => {
     try {
-        const res = await response.toJson();
-        const status = response.getStatusCode();
-        const headers = response.getHeaders();
+        const status = response.status;
+        const headers = Object.fromEntries(response.headers.entries());
+        const res = status === 204 ? {} : await response.json();
         if (status && (status < 200 || status > 299)) {
             res.http_status_code = status;
             res.headers = headers;
@@ -36,8 +36,8 @@ export const handleResponse = async (callback, response) => {
         }
     }
     catch (error) {
-        const status = response.getStatusCode();
-        const headers = response.getHeaders();
+        const status = response.status;
+        const headers = Object.fromEntries(response.headers.entries());
         switch (status) {
             case 503:
                 return throwError(callback, {

package/esm/createChargebee.js

@@ -8,7 +8,8 @@ export const CreateChargebee = (httpClient) => {
         this._env = Object.assign({}, Environment);
         extend(true, this._env, conf);
         // @ts-ignore
-        this._env.httpClient = httpClient;
+        this._env.httpClient =
+            conf.httpClient != null ? conf.httpClient : httpClient;
         this._buildResources();
         this._endpoints = Endpoints;
     };

package/esm/environment.js

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

package/esm/net/ClientInterface.js

@@ -1,6 +1,6 @@
 import { ChargebeeError } from '../chargebeeError.js';
 export class HttpClient {
-    async makeApiRequest(props) {
+    async makeApiRequest(props, timeout) {
         throw new Error('makeApiRequest is not implemented');
     }
     static timeOutError() {
@@ -15,21 +15,3 @@ export class HttpClient {
         return error;
     }
 }
-export class HttpClientResponse {
-    constructor(statusCode, headers) {
-        this._statusCode = statusCode;
-        this._headers = headers;
-    }
-    getStatusCode() {
-        return this._statusCode;
-    }
-    getHeaders() {
-        return this._headers;
-    }
-    getRawResponse() {
-        throw new Error('getRawResponse not implemented.');
-    }
-    toJson() {
-        throw new Error('toJSON not implemented.');
-    }
-}

package/esm/net/FetchClient.js

@@ -1,18 +1,11 @@
-import { HttpClient, HttpClientResponse, } from './ClientInterface.js';
+import { HttpClient } from './ClientInterface.js';
 export class FetchHttpClient extends HttpClient {
-    async makeApiRequest(props) {
-        const headers = this._createHeaders(props.headers);
-        let url = `${props.protocol}://${props.host}:${props.port}${props.path}`;
-        let fetchOptions = {
-            method: props.method,
-            headers: headers,
-            body: props.data ? props.data : undefined,
-        };
+    async makeApiRequest(request, timeout) {
         try {
             const response = globalThis.AbortController
-                ? await this.fetchWithAbortTimeout(url, fetchOptions, props.timeout)
-                : await this.fetchWithTimeout(url, fetchOptions, props.timeout);
-            return new FetchHttpClientResponse(response);
+                ? await this.fetchWithAbortTimeout(request, timeout)
+                : await this.fetchWithTimeout(request, timeout);
+            return response;
         }
         catch (err) {
             return Promise.reject(err);
@@ -25,7 +18,7 @@ export class FetchHttpClient extends HttpClient {
         });
         return headers;
     }
-    async fetchWithTimeout(url, fetchOptions, timeout) {
+    async fetchWithTimeout(request, timeout) {
         let pendingTimeoutId;
         const timeoutPromise = new Promise((_, reject) => {
             pendingTimeoutId = setTimeout(() => {
@@ -33,21 +26,21 @@ export class FetchHttpClient extends HttpClient {
                 reject(HttpClient.timeOutError());
             }, timeout);
         });
-        const fetchPromise = fetch(url, fetchOptions);
+        const fetchPromise = fetch(request);
         return Promise.race([fetchPromise, timeoutPromise]).finally(() => {
             if (pendingTimeoutId) {
                 clearTimeout(pendingTimeoutId);
             }
         });
     }
-    async fetchWithAbortTimeout(url, fetchOptions, timeout) {
+    async fetchWithAbortTimeout(request, timeout) {
         const abort = new AbortController();
         let timeoutId = setTimeout(() => {
             timeoutId = null;
             abort.abort(HttpClient.timeOutError());
         }, timeout);
         try {
-            return await fetch(url, Object.assign(Object.assign({}, fetchOptions), { signal: abort.signal }));
+            return await fetch(new Request(request, { signal: abort.signal }));
         }
         catch (err) {
             if (err.name === 'AbortError') {
@@ -64,25 +57,3 @@ export class FetchHttpClient extends HttpClient {
         }
     }
 }
-export class FetchHttpClientResponse extends HttpClientResponse {
-    constructor(response) {
-        super(response.status, FetchHttpClientResponse._transformHeadersToObject(response.headers));
-        this._res = response;
-    }
-    getRawResponse() {
-        return this._res;
-    }
-    toJson() {
-        return this._res.json();
-    }
-    static _transformHeadersToObject(headers) {
-        const headersObj = {};
-        for (const entry of headers) {
-            if (!Array.isArray(entry) || entry.length != 2) {
-                throw new Error('Headers should be an iterable object.');
-            }
-            headersObj[entry[0]] = entry[1];
-        }
-        return headersObj;
-    }
-}