chargebee 3.15.0 → 3.16.0

package/CHANGELOG.md

@@ -1,3 +1,49 @@
+### v3.16.0 (2025-12-01)
+* * * 
+
+### New Resources: 
+* Einvoice has been added.
+* QuotedDeltaRamp has been added. 
+
+### New Attributes: 
+* line_items_next_offset has been added to CreditNote.
+* line_items_next_offset has been added to Invoice.
+* credit_lines has been added to SalesOrder.
+* billable_unit_price has been added to SalesOrder#LineItem.
+* billable_quantity has been added to SalesOrder#LineItem.
+* billable_amount has been added to SalesOrder#LineItem.
+
+### New Endpoint: 
+* move action has been added to ItemPrice.
+
+### New Parameters: 
+* line_items_limit has been added to CreditNote#RetrieveRequest.
+* line_items_offset has been added to CreditNote#RetrieveRequest.
+* line_items_limit has been added to Invoice#RetrieveRequest.
+* line_items_offset has been added to Invoice#RetrieveRequest.
+* item_tiers has been added to Estimate#GiftSubscriptionForItemsRequest.
+* unit_price has been added to Estimate#SubscriptionItems#GiftSubscriptionForItemsRequest.
+* unit_price_in_decimal has been added to Estimate#SubscriptionItems#GiftSubscriptionForItemsRequest.
+* item_tiers has been added to Gift#CreateForItemsRequest.
+* meta_data has been added to Gift#CreateForItemsRequest.
+* unit_price has been added to Gift#SubscriptionItems#CreateForItemsRequest.
+* unit_price_in_decimal has been added to Gift#SubscriptionItems#CreateForItemsRequest.
+* item_tiers has been added to HostedPage#CheckoutGiftForItemsRequest.
+* unit_price has been added to HostedPage#SubscriptionItems#CheckoutGiftForItemsRequest.
+* unit_price_in_decimal has been added to HostedPage#SubscriptionItems#CheckoutGiftForItemsRequest.
+* auto_select_local_currency has been added to PricingPageSession#CreateForNewSubscriptionRequest.
+
+### New Enums: 
+* EZIDEBIT has been added to GatewayEnum.
+* BUSINESS_RULE has been added to EntityTypeEnum.
+* RULESET has been added to EntityTypeEnum.
+
+### v3.15.1 (2025-10-29)
+* * * 
+
+### Bug Fixes:
+* Resolves(#88): an issue where requests made with the GET methods incorrectly included a request body, causing the Request interface to throw an error. 
+
 ### v3.15.0 (2025-10-28)
 * * * 
 

package/cjs/RequestWrapper.js

@@ -38,7 +38,7 @@ class RequestWrapper {
         const env = _env;
         const retryConfig = Object.assign({ enabled: false, maxRetries: 3, delayMs: 200, retryOn: [500, 502, 503, 504] }, env.retryConfig);
         const urlIdParam = this.apiCall.hasIdInUrl ? this.args[0] : null;
-        let params = this.apiCall.hasIdInUrl
+        const params = this.apiCall.hasIdInUrl
             ? this.args[1]
             : this.args[0];
         let headers = this.apiCall.hasIdInUrl ? this.args[2] : this.args[1];
@@ -52,20 +52,21 @@ class RequestWrapper {
         }
         const makeRequest = async (attempt = 0) => {
             let path = (0, util_js_1.getApiURL)(env, this.apiCall.urlPrefix, this.apiCall.urlSuffix, urlIdParam);
-            if (typeof params === 'undefined' || params === null) {
-                params = {};
+            let requestParams = params;
+            if (typeof requestParams === 'undefined' || requestParams === null) {
+                requestParams = {};
             }
             if (this.apiCall.httpMethod === 'GET') {
                 const queryParam = this.apiCall.isListReq
-                    ? (0, util_js_1.encodeListParams)((0, util_js_1.serialize)(params))
-                    : (0, util_js_1.encodeParams)((0, util_js_1.serialize)(params));
+                    ? (0, util_js_1.encodeListParams)((0, util_js_1.serialize)(requestParams))
+                    : (0, util_js_1.encodeParams)((0, util_js_1.serialize)(requestParams));
                 path += '?' + queryParam;
-                params = {};
+                requestParams = {};
             }
             const jsonKeys = this.apiCall.jsonKeys;
             const data = this.apiCall.isJsonRequest
-                ? JSON.stringify(params)
-                : (0, util_js_1.encodeParams)(params, undefined, undefined, undefined, jsonKeys);
+                ? JSON.stringify(requestParams)
+                : (0, util_js_1.encodeParams)(requestParams, undefined, undefined, undefined, jsonKeys);
             const requestHeaders = Object.assign({}, this.httpHeaders);
             if (data.length) {
                 (0, util_js_1.extend)(true, requestHeaders, {
@@ -89,7 +90,7 @@ class RequestWrapper {
             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,
-                body: data !== null && data !== void 0 ? data : undefined,
+                body: data ? data : undefined,
                 headers: this._createHeaders(requestHeaders),
             });
             const resp = await this.envArg.httpClient.makeApiRequest(request, env.timeout);

package/cjs/environment.js

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

package/cjs/resources/api_endpoints.js

@@ -1671,6 +1671,7 @@ exports.Endpoints = {
     ],
     paymentReferenceNumber: [],
     paymentSchedule: [],
+    einvoice: [],
     taxWithheld: [],
     creditNote: [
         [
@@ -2051,6 +2052,7 @@ exports.Endpoints = {
             null,
             false,
             {
+                meta_data: 0,
                 additional_information: 1,
             },
             {
@@ -2951,6 +2953,7 @@ exports.Endpoints = {
     quotedSubscription: [],
     quotedCharge: [],
     quotedRamp: [],
+    quotedDeltaRamp: [],
     billingConfiguration: [],
     quoteLineGroup: [],
     plan: [
@@ -3960,6 +3963,19 @@ exports.Endpoints = {
             {},
             {},
         ],
+        [
+            'moveItemPrice',
+            'POST',
+            '/item_prices',
+            '/move',
+            true,
+            null,
+            false,
+            {},
+            {
+                isIdempotent: true,
+            },
+        ],
     ],
     attachedItem: [
         [

package/esm/RequestWrapper.js

@@ -35,7 +35,7 @@ export class RequestWrapper {
         const env = _env;
         const retryConfig = Object.assign({ enabled: false, maxRetries: 3, delayMs: 200, retryOn: [500, 502, 503, 504] }, env.retryConfig);
         const urlIdParam = this.apiCall.hasIdInUrl ? this.args[0] : null;
-        let params = this.apiCall.hasIdInUrl
+        const params = this.apiCall.hasIdInUrl
             ? this.args[1]
             : this.args[0];
         let headers = this.apiCall.hasIdInUrl ? this.args[2] : this.args[1];
@@ -49,20 +49,21 @@ export class RequestWrapper {
         }
         const makeRequest = async (attempt = 0) => {
             let path = getApiURL(env, this.apiCall.urlPrefix, this.apiCall.urlSuffix, urlIdParam);
-            if (typeof params === 'undefined' || params === null) {
-                params = {};
+            let requestParams = params;
+            if (typeof requestParams === 'undefined' || requestParams === null) {
+                requestParams = {};
             }
             if (this.apiCall.httpMethod === 'GET') {
                 const queryParam = this.apiCall.isListReq
-                    ? encodeListParams(serialize(params))
-                    : encodeParams(serialize(params));
+                    ? encodeListParams(serialize(requestParams))
+                    : encodeParams(serialize(requestParams));
                 path += '?' + queryParam;
-                params = {};
+                requestParams = {};
             }
             const jsonKeys = this.apiCall.jsonKeys;
             const data = this.apiCall.isJsonRequest
-                ? JSON.stringify(params)
-                : encodeParams(params, undefined, undefined, undefined, jsonKeys);
+                ? JSON.stringify(requestParams)
+                : encodeParams(requestParams, undefined, undefined, undefined, jsonKeys);
             const requestHeaders = Object.assign({}, this.httpHeaders);
             if (data.length) {
                 extend(true, requestHeaders, {
@@ -86,7 +87,7 @@ export class RequestWrapper {
             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,
-                body: data !== null && data !== void 0 ? data : undefined,
+                body: data ? data : undefined,
                 headers: this._createHeaders(requestHeaders),
             });
             const resp = await this.envArg.httpClient.makeApiRequest(request, env.timeout);

package/esm/environment.js

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

package/esm/resources/api_endpoints.js

@@ -1668,6 +1668,7 @@ export const Endpoints = {
     ],
     paymentReferenceNumber: [],
     paymentSchedule: [],
+    einvoice: [],
     taxWithheld: [],
     creditNote: [
         [
@@ -2048,6 +2049,7 @@ export const Endpoints = {
             null,
             false,
             {
+                meta_data: 0,
                 additional_information: 1,
             },
             {
@@ -2948,6 +2950,7 @@ export const Endpoints = {
     quotedSubscription: [],
     quotedCharge: [],
     quotedRamp: [],
+    quotedDeltaRamp: [],
     billingConfiguration: [],
     quoteLineGroup: [],
     plan: [
@@ -3957,6 +3960,19 @@ export const Endpoints = {
             {},
             {},
         ],
+        [
+            'moveItemPrice',
+            'POST',
+            '/item_prices',
+            '/move',
+            true,
+            null,
+            false,
+            {},
+            {
+                isIdempotent: true,
+            },
+        ],
     ],
     attachedItem: [
         [

package/package.json

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

package/types/core.d.ts

@@ -149,7 +149,9 @@ declare module 'chargebee' {
     | 'sales_order'
     | 'omnichannel_one_time_order'
     | 'omnichannel_one_time_order_item'
-    | 'usage_file';
+    | 'usage_file'
+    | 'business_rule'
+    | 'ruleset';
   type EventNameEnum = 'cancellation_page_loaded';
   type EventTypeEnum =
     | 'coupon_created'
@@ -425,6 +427,7 @@ declare module 'chargebee' {
     | 'paystack'
     | 'jp_morgan'
     | 'deutsche_bank'
+    | 'ezidebit'
     | 'gocardless'
     | 'not_applicable';
   type HierarchyOperationTypeEnum =

package/types/index.d.ts

@@ -24,6 +24,7 @@
 ///<reference path='./resources/DifferentialPrice.d.ts' />
 ///<reference path='./resources/Discount.d.ts' />
 ///<reference path='./resources/Download.d.ts' />
+///<reference path='./resources/Einvoice.d.ts' />
 ///<reference path='./resources/Entitlement.d.ts' />
 ///<reference path='./resources/EntitlementOverride.d.ts' />
 ///<reference path='./resources/Estimate.d.ts' />
@@ -75,6 +76,7 @@
 ///<reference path='./resources/Quote.d.ts' />
 ///<reference path='./resources/QuoteLineGroup.d.ts' />
 ///<reference path='./resources/QuotedCharge.d.ts' />
+///<reference path='./resources/QuotedDeltaRamp.d.ts' />
 ///<reference path='./resources/QuotedRamp.d.ts' />
 ///<reference path='./resources/QuotedSubscription.d.ts' />
 ///<reference path='./resources/Ramp.d.ts' />

package/types/resources/Content.d.ts

@@ -29,6 +29,7 @@ declare module 'chargebee' {
     differential_price: DifferentialPrice;
     discount: Discount;
     download: Download;
+    einvoice: Einvoice;
     entitlement: Entitlement;
     entitlement_override: EntitlementOverride;
     estimate: Estimate;
@@ -80,6 +81,7 @@ declare module 'chargebee' {
     quote: Quote;
     quote_line_group: QuoteLineGroup;
     quoted_charge: QuotedCharge;
+    quoted_delta_ramp: QuotedDeltaRamp;
     quoted_ramp: QuotedRamp;
     quoted_subscription: QuotedSubscription;
     ramp: Ramp;

package/types/resources/CreditNote.d.ts

@@ -37,6 +37,7 @@ declare module 'chargebee' {
     resource_version?: number;
     updated_at?: number;
     channel?: ChannelEnum;
+    line_items_next_offset?: string;
     sub_total: number;
     sub_total_in_local_currency?: number;
     total_in_local_currency?: number;
@@ -454,6 +455,8 @@ declare module 'chargebee' {
       [key: `cf_${string}`]: unknown;
     }
     export interface RetrieveInputParam {
+      line_items_limit?: number;
+      line_items_offset?: string;
       line_item?: LineItemRetrieveInputParam;
     }
     export interface PdfInputParam {

package/types/resources/Einvoice.d.ts

@@ -0,0 +1,17 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface Einvoice {
+    id: string;
+    reference_number?: string;
+    status:
+      | 'scheduled'
+      | 'skipped'
+      | 'in_progress'
+      | 'success'
+      | 'failed'
+      | 'registered';
+    message?: string;
+  }
+}

package/types/resources/Estimate.d.ts

@@ -413,6 +413,7 @@ declare module 'chargebee' {
       payment_intent?: PaymentIntentGiftSubscriptionForItemsInputParam;
       shipping_address?: ShippingAddressGiftSubscriptionForItemsInputParam;
       subscription_items?: SubscriptionItemsGiftSubscriptionForItemsInputParam[];
+      item_tiers?: ItemTiersGiftSubscriptionForItemsInputParam[];
     }
     export interface CreateInvoiceInputParam {
       currency_code?: string;
@@ -1131,6 +1132,17 @@ declare module 'chargebee' {
       item_price_id?: string;
       quantity?: number;
       quantity_in_decimal?: string;
+      unit_price?: number;
+      unit_price_in_decimal?: string;
+    }
+    export interface ItemTiersGiftSubscriptionForItemsInputParam {
+      item_price_id?: string;
+      starting_unit?: number;
+      ending_unit?: number;
+      price?: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      price_in_decimal?: string;
     }
     export interface InvoiceCreateInvoiceInputParam {
       customer_id?: string;

package/types/resources/Event.d.ts

@@ -228,7 +228,13 @@ declare module 'chargebee' {
       PaymentSourceUpdatedContent &
       BusinessEntityDeletedContent &
       AuthorizationVoidedContent &
-      SubscriptionRampDeletedContent;
+      SubscriptionRampDeletedContent &
+      PlanDeletedContent &
+      AddonDeletedContent &
+      AddonUpdatedContent &
+      AddonCreatedContent &
+      PlanCreatedContent &
+      PlanUpdatedContent;
     origin_user?: string;
   }
 

package/types/resources/Gift.d.ts

@@ -131,11 +131,13 @@ declare module 'chargebee' {
       no_expiry?: boolean;
       claim_expiry_date?: number;
       coupon_ids?: string[];
+      meta_data?: any;
       gifter?: GifterCreateForItemsInputParam;
       gift_receiver?: GiftReceiverCreateForItemsInputParam;
       payment_intent?: PaymentIntentCreateForItemsInputParam;
       shipping_address?: ShippingAddressCreateForItemsInputParam;
       subscription_items?: SubscriptionItemsCreateForItemsInputParam[];
+      item_tiers?: ItemTiersCreateForItemsInputParam[];
     }
     export interface ListInputParam {
       limit?: number;
@@ -286,6 +288,17 @@ declare module 'chargebee' {
       item_price_id?: string;
       quantity?: number;
       quantity_in_decimal?: string;
+      unit_price?: number;
+      unit_price_in_decimal?: string;
+    }
+    export interface ItemTiersCreateForItemsInputParam {
+      item_price_id?: string;
+      starting_unit?: number;
+      ending_unit?: number;
+      price?: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      price_in_decimal?: string;
     }
     export interface GifterGiftListInputParam {
       customer_id?: filter.String;

package/types/resources/HostedPage.d.ts

@@ -435,6 +435,7 @@ declare module 'chargebee' {
       coupon_ids?: string[];
       gifter?: GifterCheckoutGiftForItemsInputParam;
       subscription_items?: SubscriptionItemsCheckoutGiftForItemsInputParam[];
+      item_tiers?: ItemTiersCheckoutGiftForItemsInputParam[];
     }
     export interface ClaimGiftInputParam {
       redirect_url?: string;
@@ -1105,6 +1106,17 @@ declare module 'chargebee' {
       item_price_id?: string;
       quantity?: number;
       quantity_in_decimal?: string;
+      unit_price?: number;
+      unit_price_in_decimal?: string;
+    }
+    export interface ItemTiersCheckoutGiftForItemsInputParam {
+      item_price_id?: string;
+      starting_unit?: number;
+      ending_unit?: number;
+      price?: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      price_in_decimal?: string;
     }
     export interface GiftClaimGiftInputParam {
       id: string;

package/types/resources/Invoice.d.ts

@@ -42,6 +42,7 @@ declare module 'chargebee' {
     voided_at?: number;
     resource_version?: number;
     updated_at?: number;
+    line_items_next_offset?: string;
     first_invoice?: boolean;
     new_sales_amount?: number;
     has_advance_charges?: boolean;
@@ -1062,6 +1063,8 @@ declare module 'chargebee' {
       offset?: string;
     }
     export interface RetrieveInputParam {
+      line_items_limit?: number;
+      line_items_offset?: string;
       line_item?: LineItemRetrieveInputParam;
     }
     export interface PdfInputParam {

package/types/resources/ItemPrice.d.ts

@@ -91,6 +91,12 @@ declare module 'chargebee' {
         input?: FindApplicableItemPricesInputParam,
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<FindApplicableItemPricesResponse>>;
+
+      moveItemPrice(
+        item_price_id: string,
+        input: MoveItemPriceInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<MoveItemPriceResponse>>;
     }
 
     export interface CreateResponse {
@@ -124,6 +130,10 @@ declare module 'chargebee' {
       next_offset?: string;
     }
 
+    export interface MoveItemPriceResponse {
+      item_price: ItemPrice;
+    }
+
     export interface Tier {
       starting_unit: number;
       ending_unit?: number;
@@ -269,6 +279,9 @@ declare module 'chargebee' {
       'sort_by[asc]'?: string;
       'sort_by[desc]'?: string;
     }
+    export interface MoveItemPriceInputParam {
+      destination_item_id: string;
+    }
     export interface TaxDetailCreateInputParam {
       tax_profile_id?: string;
       avalara_tax_code?: string;

package/types/resources/PricingPageSession.d.ts

@@ -36,6 +36,7 @@ declare module 'chargebee' {
     export interface CreateForNewSubscriptionInputParam {
       redirect_url?: string;
       business_entity_id?: string;
+      auto_select_local_currency?: boolean;
       pricing_page?: PricingPageCreateForNewSubscriptionInputParam;
       subscription?: SubscriptionCreateForNewSubscriptionInputParam;
       customer?: CustomerCreateForNewSubscriptionInputParam;

package/types/resources/QuotedDeltaRamp.d.ts

@@ -0,0 +1,16 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface QuotedDeltaRamp {
+    line_items?: QuotedDeltaRamp.LineItem[];
+  }
+
+  export namespace QuotedDeltaRamp {
+    export interface LineItem {
+      item_level_discount_per_billing_cycle_in_decimal?: string;
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/SalesOrder.d.ts

@@ -27,6 +27,7 @@ declare module 'chargebee' {
     billing_configuration?: SalesOrder.BillingConfiguration;
     renewal_term?: SalesOrder.RenewalTerm;
     status: 'active' | 'completed';
+    credit_lines?: SalesOrder.CreditLine[];
   }
 
   export namespace SalesOrder {
@@ -37,6 +38,9 @@ declare module 'chargebee' {
       name?: string;
       quantity: string;
       unit_price: string;
+      billable_unit_price?: string;
+      billable_quantity?: string;
+      billable_amount?: string;
       billing_period?: number;
       billing_period_unit?: 'day' | 'week' | 'month' | 'year';
       service_period_days?: number;
@@ -137,6 +141,11 @@ declare module 'chargebee' {
       cancellation_cutoff_period?: number;
       renewal_billing_cycles?: number;
     }
+    export interface CreditLine {
+      amount: string;
+      unit_price: string;
+      line_item_association_id?: string;
+    }
     // REQUEST PARAMS
     //---------------
   }

package/types/resources/WebhookEvent.d.ts

@@ -213,6 +213,12 @@ declare module 'chargebee' {
     BusinessEntityDeleted = 'business_entity_deleted',
     AuthorizationVoided = 'authorization_voided',
     SubscriptionRampDeleted = 'subscription_ramp_deleted',
+    PlanDeleted = 'plan_deleted',
+    AddonDeleted = 'addon_deleted',
+    AddonUpdated = 'addon_updated',
+    AddonCreated = 'addon_created',
+    PlanCreated = 'plan_created',
+    PlanUpdated = 'plan_updated',
   }
 
   export type WebhookContentMap = {
@@ -425,6 +431,12 @@ declare module 'chargebee' {
     [WebhookContentType.BusinessEntityDeleted]: BusinessEntityDeletedContent;
     [WebhookContentType.AuthorizationVoided]: AuthorizationVoidedContent;
     [WebhookContentType.SubscriptionRampDeleted]: SubscriptionRampDeletedContent;
+    [WebhookContentType.PlanDeleted]: PlanDeletedContent;
+    [WebhookContentType.AddonDeleted]: AddonDeletedContent;
+    [WebhookContentType.AddonUpdated]: AddonUpdatedContent;
+    [WebhookContentType.AddonCreated]: AddonCreatedContent;
+    [WebhookContentType.PlanCreated]: PlanCreatedContent;
+    [WebhookContentType.PlanUpdated]: PlanUpdatedContent;
   };
 
   export type ContentFor<T extends WebhookContentType> = WebhookContentMap[T];
@@ -1621,4 +1633,22 @@ declare module 'chargebee' {
   export type SubscriptionRampDeletedContent = {
     ramp: Ramp;
   };
+  export type PlanDeletedContent = {
+    plan: Plan;
+  };
+  export type AddonDeletedContent = {
+    addon: Addon;
+  };
+  export type AddonUpdatedContent = {
+    addon: Addon;
+  };
+  export type AddonCreatedContent = {
+    addon: Addon;
+  };
+  export type PlanCreatedContent = {
+    plan: Plan;
+  };
+  export type PlanUpdatedContent = {
+    plan: Plan;
+  };
 }