chargebee 3.13.0 → 3.14.0

package/CHANGELOG.md

@@ -1,3 +1,59 @@
+### 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/cjs/coreCommon.js

@@ -21,7 +21,7 @@ function throwError(callBack, rawError, headers) {
 }
 const handleResponse = async (callback, response) => {
     try {
-        const res = await response.toJson();
+        const res = response.getStatusCode() === 204 ? response : await response.toJson();
         const status = response.getStatusCode();
         const headers = response.getHeaders();
         if (status && (status < 200 || status > 299)) {

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.14.0',
     port: DEFAULT_PORT,
     timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
     exportWaitInMillis: DEFAULT_EXPORT_WAIT,

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/coreCommon.js

@@ -17,7 +17,7 @@ export function throwError(callBack, rawError, headers) {
 }
 export const handleResponse = async (callback, response) => {
     try {
-        const res = await response.toJson();
+        const res = response.getStatusCode() === 204 ? response : await response.toJson();
         const status = response.getStatusCode();
         const headers = response.getHeaders();
         if (status && (status < 200 || status > 299)) {

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.14.0',
     port: DEFAULT_PORT,
     timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
     exportWaitInMillis: DEFAULT_EXPORT_WAIT,

package/esm/resources/api_endpoints.js

@@ -4642,6 +4642,19 @@ export const Endpoints = {
             {},
             {},
         ],
+        [
+            'move',
+            'POST',
+            '/omnichannel_subscriptions',
+            '/move',
+            true,
+            null,
+            false,
+            {},
+            {
+                isIdempotent: true,
+            },
+        ],
     ],
     omnichannelTransaction: [],
     omnichannelSubscriptionItem: [
@@ -4752,7 +4765,60 @@ export const 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/package.json

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

package/types/core.d.ts

@@ -45,6 +45,7 @@ declare module 'chargebee' {
     | 'end_of_term'
     | 'specific_date'
     | 'end_of_billing_term';
+  type CategoryEnum = 'introductory' | 'promotional' | 'developer_determined';
   type ChangeOptionEnum = 'immediately' | 'end_of_term' | 'specific_date';
   type ChannelEnum = 'web' | 'app_store' | 'play_store';
   type ChargeModelEnum = 'full_charge' | 'prorate';
@@ -80,6 +81,7 @@ declare module 'chargebee' {
     | 'becs_nz'
     | 'pad'
     | 'not_applicable';
+  type DiscountTypeEnum = 'fixed_amount' | 'percentage' | 'price';
   type DispositionTypeEnum = 'attachment' | 'inline';
   type DunningTypeEnum = 'auto_collect' | 'offline' | 'direct_debit';
   type DurationTypeEnum = 'one_time' | 'forever' | 'limited_period';
@@ -219,6 +221,7 @@ declare module 'chargebee' {
     | 'transaction_deleted'
     | 'payment_succeeded'
     | 'payment_failed'
+    | 'dunning_updated'
     | 'payment_refunded'
     | 'payment_initiated'
     | 'refund_initiated'
@@ -356,6 +359,7 @@ declare module 'chargebee' {
     | 'omnichannel_one_time_order_item_cancelled'
     | 'usage_file_ingested'
     | 'omnichannel_subscription_item_pause_scheduled'
+    | 'omnichannel_subscription_moved_in'
     | 'plan_created'
     | 'plan_updated'
     | 'plan_deleted'
@@ -611,7 +615,10 @@ declare module 'chargebee' {
     | 'automated_bank_transfer'
     | 'klarna_pay_now'
     | 'online_banking_poland'
-    | 'payconiq_by_bancontact';
+    | 'payconiq_by_bancontact'
+    | 'free_trial'
+    | 'pay_up_front'
+    | 'pay_as_you_go';
   type UnbilledChargesHandlingEnum = 'no_action' | 'invoice';
   type UnbilledChargesOptionEnum = 'invoice' | 'delete';
   type UnpaidInvoicesHandlingEnum = 'no_action' | 'schedule_payment_collection';

package/types/index.d.ts

@@ -47,10 +47,13 @@
 ///<reference path='./resources/ItemPrice.d.ts' />
 ///<reference path='./resources/Metadata.d.ts' />
 ///<reference path='./resources/NonSubscription.d.ts' />
+///<reference path='./resources/OfferEvent.d.ts' />
+///<reference path='./resources/OfferFulfillment.d.ts' />
 ///<reference path='./resources/OmnichannelOneTimeOrder.d.ts' />
 ///<reference path='./resources/OmnichannelOneTimeOrderItem.d.ts' />
 ///<reference path='./resources/OmnichannelSubscription.d.ts' />
 ///<reference path='./resources/OmnichannelSubscriptionItem.d.ts' />
+///<reference path='./resources/OmnichannelSubscriptionItemOffer.d.ts' />
 ///<reference path='./resources/OmnichannelSubscriptionItemScheduledChange.d.ts' />
 ///<reference path='./resources/OmnichannelTransaction.d.ts' />
 ///<reference path='./resources/Order.d.ts' />
@@ -61,6 +64,7 @@
 ///<reference path='./resources/PaymentScheduleScheme.d.ts' />
 ///<reference path='./resources/PaymentSource.d.ts' />
 ///<reference path='./resources/PaymentVoucher.d.ts' />
+///<reference path='./resources/PersonalizedOffer.d.ts' />
 ///<reference path='./resources/Plan.d.ts' />
 ///<reference path='./resources/PortalSession.d.ts' />
 ///<reference path='./resources/PriceVariant.d.ts' />
@@ -199,6 +203,8 @@ declare module 'chargebee' {
     itemFamily: ItemFamily.ItemFamilyResource;
     itemPrice: ItemPrice.ItemPriceResource;
     nonSubscription: NonSubscription.NonSubscriptionResource;
+    offerEvent: OfferEvent.OfferEventResource;
+    offerFulfillment: OfferFulfillment.OfferFulfillmentResource;
     omnichannelOneTimeOrder: OmnichannelOneTimeOrder.OmnichannelOneTimeOrderResource;
     omnichannelSubscription: OmnichannelSubscription.OmnichannelSubscriptionResource;
     omnichannelSubscriptionItem: OmnichannelSubscriptionItem.OmnichannelSubscriptionItemResource;
@@ -207,6 +213,7 @@ declare module 'chargebee' {
     paymentScheduleScheme: PaymentScheduleScheme.PaymentScheduleSchemeResource;
     paymentSource: PaymentSource.PaymentSourceResource;
     paymentVoucher: PaymentVoucher.PaymentVoucherResource;
+    personalizedOffer: PersonalizedOffer.PersonalizedOfferResource;
     plan: Plan.PlanResource;
     portalSession: PortalSession.PortalSessionResource;
     priceVariant: PriceVariant.PriceVariantResource;

package/types/resources/Comment.d.ts

@@ -77,15 +77,6 @@ declare module 'chargebee' {
         | 'coupon'
         | 'order'
         | 'business_entity'
-        | 'omnichannel_subscription'
-        | 'omnichannel_subscription_item'
-        | 'omnichannel_transaction'
-        | 'recorded_purchase'
-        | 'omnichannel_subscription_item_scheduled_change'
-        | 'sales_order'
-        | 'omnichannel_one_time_order'
-        | 'omnichannel_one_time_order_item'
-        | 'usage_file'
         | 'item_family'
         | 'item'
         | 'item_price'

package/types/resources/Content.d.ts

@@ -52,10 +52,13 @@ declare module 'chargebee' {
     item_price: ItemPrice;
     metadata: Metadata;
     non_subscription: NonSubscription;
+    offer_event: OfferEvent;
+    offer_fulfillment: OfferFulfillment;
     omnichannel_one_time_order: OmnichannelOneTimeOrder;
     omnichannel_one_time_order_item: OmnichannelOneTimeOrderItem;
     omnichannel_subscription: OmnichannelSubscription;
     omnichannel_subscription_item: OmnichannelSubscriptionItem;
+    omnichannel_subscription_item_offer: OmnichannelSubscriptionItemOffer;
     omnichannel_subscription_item_scheduled_change: OmnichannelSubscriptionItemScheduledChange;
     omnichannel_transaction: OmnichannelTransaction;
     order: Order;
@@ -66,6 +69,7 @@ declare module 'chargebee' {
     payment_schedule_scheme: PaymentScheduleScheme;
     payment_source: PaymentSource;
     payment_voucher: PaymentVoucher;
+    personalized_offer: PersonalizedOffer;
     plan: Plan;
     portal_session: PortalSession;
     price_variant: PriceVariant;

package/types/resources/CreditNote.d.ts

@@ -3,6 +3,7 @@
 ///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface CreditNote {
+    [key: string]: unknown;
     id: string;
     customer_id: string;
     subscription_id?: string;
@@ -395,7 +396,6 @@ declare module 'chargebee' {
       country?: string;
       zip?: string;
       validation_status?: ValidationStatusEnum;
-      index: number;
     }
     export interface BillingAddress {
       first_name?: string;
@@ -450,6 +450,7 @@ declare module 'chargebee' {
       currency_code?: string;
       comment?: string;
       line_items?: LineItemsCreateInputParam[];
+      [key: `cf_${string}`]: unknown;
     }
     export interface RetrieveInputParam {
       line_item?: LineItemRetrieveInputParam;
@@ -528,6 +529,7 @@ declare module 'chargebee' {
       taxes?: TaxesImportCreditNoteInputParam[];
       allocations?: AllocationsImportCreditNoteInputParam[];
       linked_refunds?: LinkedRefundsImportCreditNoteInputParam[];
+      [key: `cf_${string}`]: unknown;
     }
     export interface LineItemsCreateInputParam {
       reference_line_item_id?: string;

package/types/resources/CreditNoteEstimate.d.ts

@@ -12,11 +12,11 @@ declare module 'chargebee' {
     amount_allocated: number;
     amount_available: number;
     line_items?: CreditNoteEstimate.LineItem[];
+    line_item_tiers?: CreditNoteEstimate.LineItemTier[];
+    line_item_discounts?: CreditNoteEstimate.LineItemDiscount[];
+    line_item_taxes?: CreditNoteEstimate.LineItemTax[];
     discounts?: CreditNoteEstimate.Discount[];
     taxes?: CreditNoteEstimate.Tax[];
-    line_item_taxes?: CreditNoteEstimate.LineItemTax[];
-    line_item_discounts?: CreditNoteEstimate.LineItemDiscount[];
-    line_item_tiers?: CreditNoteEstimate.LineItemTier[];
     round_off_amount?: number;
     customer_id?: string;
   }
@@ -71,24 +71,31 @@ declare module 'chargebee' {
       entity_id?: string;
       customer_id?: string;
     }
-    export interface Discount {
-      amount: number;
-      description?: string;
-      entity_type:
+    export interface LineItemTier {
+      line_item_id?: string;
+      starting_unit: number;
+      ending_unit?: number;
+      quantity_used: number;
+      unit_amount: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      quantity_used_in_decimal?: string;
+      unit_amount_in_decimal?: string;
+      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
+      package_size?: number;
+    }
+    export interface LineItemDiscount {
+      line_item_id: string;
+      discount_type:
         | 'item_level_coupon'
         | 'document_level_coupon'
         | 'promotional_credits'
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
-      discount_type?: 'fixed_amount' | 'percentage';
+      coupon_id?: string;
       entity_id?: string;
-      coupon_set_code?: string;
-    }
-    export interface Tax {
-      name: string;
-      amount: number;
-      description?: string;
+      discount_amount: number;
     }
     export interface LineItemTax {
       line_item_id?: string;
@@ -115,31 +122,24 @@ declare module 'chargebee' {
       tax_amount_in_local_currency?: number;
       local_currency_code?: string;
     }
-    export interface LineItemDiscount {
-      line_item_id: string;
-      discount_type:
+    export interface Discount {
+      amount: number;
+      description?: string;
+      entity_type:
         | 'item_level_coupon'
         | 'document_level_coupon'
         | 'promotional_credits'
         | 'prorated_credits'
         | 'item_level_discount'
         | 'document_level_discount';
-      coupon_id?: string;
+      discount_type?: 'fixed_amount' | 'percentage';
       entity_id?: string;
-      discount_amount: number;
+      coupon_set_code?: string;
     }
-    export interface LineItemTier {
-      line_item_id?: string;
-      starting_unit: number;
-      ending_unit?: number;
-      quantity_used: number;
-      unit_amount: number;
-      starting_unit_in_decimal?: string;
-      ending_unit_in_decimal?: string;
-      quantity_used_in_decimal?: string;
-      unit_amount_in_decimal?: string;
-      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
-      package_size?: number;
+    export interface Tax {
+      name: string;
+      amount: number;
+      description?: string;
     }
     // REQUEST PARAMS
     //---------------

package/types/resources/Currency.d.ts

@@ -1,19 +1,20 @@
 ///<reference path='./../core.d.ts'/>
 ///<reference path='./../index.d.ts'/>
-
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface Currency {
-    id?: string;
+    id: string;
     enabled: boolean;
     forex_type?: 'manual' | 'auto';
-    currency_code?: string;
-    is_base_currency?: boolean;
+    currency_code: string;
+    is_base_currency: boolean;
     manual_exchange_rate?: string;
   }
 
   export namespace Currency {
     export class CurrencyResource {
       list(
+        input?: ListInputParam,
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<ListResponse>>;
 
@@ -46,7 +47,8 @@ declare module 'chargebee' {
     }
 
     export interface ListResponse {
-      currency: Currency;
+      list: { currency: Currency }[];
+      next_offset?: string;
     }
 
     export interface RetrieveResponse {
@@ -74,6 +76,10 @@ declare module 'chargebee' {
     // REQUEST PARAMS
     //---------------
 
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+    }
     export interface CreateInputParam {
       currency_code: string;
       forex_type: 'manual' | 'auto';

package/types/resources/Customer.d.ts

@@ -412,6 +412,7 @@ declare module 'chargebee' {
       unbilled_charges: number;
       currency_code: string;
       balance_currency_code: string;
+      business_entity_id?: string;
     }
     export interface EntityIdentifier {
       id: string;

package/types/resources/Estimate.d.ts

@@ -593,6 +593,7 @@ declare module 'chargebee' {
        * @deprecated Please refer API docs to use other attributes
        */
       coupon?: string;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       free_period?: number;
       free_period_unit?: FreePeriodUnitEnum;
       contract_term_billing_cycle_on_renewal?: number;
@@ -734,6 +735,7 @@ declare module 'chargebee' {
        */
       setup_fee?: number;
       start_date?: number;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       free_period?: number;
       free_period_unit?: FreePeriodUnitEnum;
       contract_term_billing_cycle_on_renewal?: number;

package/types/resources/Event.d.ts

@@ -73,6 +73,7 @@ declare module 'chargebee' {
       SubscriptionAdvanceInvoiceScheduleUpdatedContent &
       ItemDeletedContent &
       SubscriptionRampDraftedContent &
+      DunningUpdatedContent &
       ItemEntitlementsUpdatedContent &
       TokenConsumedContent &
       HierarchyDeletedContent &
@@ -166,6 +167,7 @@ declare module 'chargebee' {
       SubscriptionScheduledCancellationRemovedContent &
       PaymentRefundedContent &
       UsageFileIngestedContent &
+      OmnichannelSubscriptionMovedInContent &
       DifferentialPriceCreatedContent &
       TransactionCreatedContent &
       PaymentSucceededContent &

package/types/resources/GatewayErrorDetail.d.ts

@@ -17,5 +17,6 @@ declare module 'chargebee' {
     processor_error_code?: string;
     processor_error_message?: string;
     error_cause_id?: string;
+    processor_advice_code?: string;
   }
 }

package/types/resources/HostedPage.d.ts

@@ -14,6 +14,7 @@ declare module 'chargebee' {
       | 'checkout_one_time'
       | 'pre_cancel'
       | 'view_voucher'
+      | 'accept_quote'
       | 'checkout_gift'
       | 'claim_gift';
     url?: string;
@@ -813,6 +814,7 @@ declare module 'chargebee' {
       start_date?: number;
       coupon?: string;
       auto_collection?: AutoCollectionEnum;
+      offline_payment_method?: OfflinePaymentMethodEnum;
       invoice_notes?: string;
       po_number?: string;
       contract_term_billing_cycle_on_renewal?: number;