chargebee 3.12.0-beta.1 → 3.12.0

package/CHANGELOG.md

@@ -1,3 +1,60 @@
+### v3.12.0 (2025-08-19)
+* * * 
+
+### New Resources: 
+* WebhookEndpoints has been added. 
+* OmnichannelOneTimeOrder has been added.
+* OmnichannelOneTimeOrderItem has been added. 
+
+### New Attributes: 
+* business_entity_id has been added to Comment.
+* business_entity_id has been added to PromotionalCredit.
+* quantity has been added to Discount.
+* business_entity_id has been added to PromotionalCredit.
+* coupon_applicability_mappings[] has been added to QuotedCharge.
+* linked_omnichannel_one_time_orders[] has been added to RecordedPurchase.
+* quantity has been added to Subscripiton#Discount.
+
+### New Input Parameters: 
+* transaction[id] has been added to Customer#RecordExcessPaymentRequest.
+* discounts[quantity][] has been added to Estimate#CreateSubItemEstimateRequest.
+* consolidate_entitlements has been added to CustomerEntitlement#EntitlementsForCustomer.
+* discounts[quantity][] has been added to Estimate#CreateSubItemEstimateRequest.
+* discounts[quantity][] has been added to Estimate#CreateSubItemForCustomerEstimateRequest.
+* discounts[quantity][] has been added to Estimate#UpdateSubscriptionForItemsRequest.
+* discounts[quantity][] has been added to Estimate#CreateInvoiceForItemsRequest.
+* discounts[quantity][] has been added to HostedPage#CheckoutOneTimeForItemsRequest.
+* discounts[quantity][] has been added to HostedPage#CheckoutNewForItemsRequest.
+* discounts[quantity][] has been added to HostedPage#CheckoutExistingForItemsRequest.
+* discounts[quantity][] has been added to PricingPageSession#CreateForNewSubscriptionRequest.
+* discounts[quantity][] has been added to PricingPageSession#CreateForExistingSubscriptionRequest.
+* discounts[quantity][] has been added to Purchase#CreateRequest.
+* discounts[quantity][] has been added to Purchase#EstimateRequest.
+* discounts[quantity][] has been added to Quote#CreateSubItemsForCustomerQuoteRequest.
+* discounts[quantity][] has been added to Quote#EditCreateSubCustomerQuoteForItemsRequest.
+* discounts[quantity][] has been added to Quote#UpdateSubscriptionQuoteForItemsRequest.
+* discounts[quantity][] has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequest.
+* discounts[quantity][] has been added to Quote#CreateForChargeItemsAndChargesRequest.
+* discounts[quantity][] has been added to Quote#EditForChargeItemsAndChargesRequest.
+* discounts[quantity][] has been added to Subscription#CreateWithItemsRequest.
+* discounts[quantity][] has been added to Subscription#UpdateForItemsRequest.
+* discounts[quantity][] has been added to Subscription#ImportForItemsRequest.
+* google_play_store[product_id] has been added to RecordedPurchase#CreateRequest.
+* google_play_store[order_id] has been added to RecordedPurchase#CreateRequest.
+
+### New Enums
+* PAUSE has been added to OmnichannelSubscriptionItemScheduledChange#ChangeType.
+* OFFER_QUANTITY has been added to Discount#Type.
+* OFFER_QUANTITY has been added to Subscription#Discount#Type.
+* OMNICHANNEL_ONE_TIME_ORDER has been added to EntityType.
+* OMNICHANNEL_ONE_TIME_ORDER_ITEM has been added to EntityType.
+* USAGE_FILE has been added to EntityType.
+* OMNICHANNEL_ONE_TIME_ORDER_CREATED has been added to EventType.
+* OMNICHANNEL_ONE_TIME_ORDER_ITEM_CANCELLED has been added to EventType.
+* USAGE_FILE_INGESTED has been added to EventType.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_PAUSE_SCHEDULED has been added to EventType.
+
+
 ### v3.12.0-beta.1 (2025-07-23) 
 * * * 
 

package/cjs/environment.js

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

package/cjs/resources/api_endpoints.js

@@ -4676,6 +4676,31 @@ exports.Endpoints = {
         ],
         ['retrieve', 'GET', '/recorded_purchases', null, true, null, false, {}, {}],
     ],
+    omnichannelOneTimeOrder: [
+        [
+            'retrieve',
+            'GET',
+            '/omnichannel_one_time_orders',
+            null,
+            true,
+            null,
+            false,
+            {},
+            {},
+        ],
+        [
+            'list',
+            'GET',
+            '/omnichannel_one_time_orders',
+            null,
+            false,
+            null,
+            false,
+            {},
+            {},
+        ],
+    ],
+    omnichannelOneTimeOrderItem: [],
     rule: [['retrieve', 'GET', '/rules', null, true, null, false, {}, {}]],
     usageEvent: [
         [
@@ -4708,10 +4733,10 @@ exports.Endpoints = {
     omnichannelSubscriptionItemScheduledChange: [],
     usageFile: [
         [
-            'upload',
+            'uploadUrl',
             'POST',
             '/usage_files',
-            '/upload',
+            '/upload_url',
             false,
             'file-ingest',
             false,
@@ -4719,10 +4744,10 @@ exports.Endpoints = {
             {},
         ],
         [
-            'status',
+            'processingStatus',
             'GET',
             '/usage_files',
-            '/status',
+            '/processing_status',
             true,
             'file-ingest',
             false,
@@ -4731,4 +4756,50 @@ exports.Endpoints = {
         ],
     ],
     brand: [],
+    webhookEndpoint: [
+        [
+            'create',
+            'POST',
+            '/webhook_endpoints',
+            null,
+            false,
+            null,
+            false,
+            {},
+            {
+                isIdempotent: true,
+            },
+        ],
+        [
+            'update',
+            'POST',
+            '/webhook_endpoints',
+            null,
+            true,
+            null,
+            false,
+            {},
+            {
+                isIdempotent: true,
+            },
+        ],
+        ['retrieve', 'GET', '/webhook_endpoints', null, true, null, false, {}, {}],
+        [
+            'delete',
+            'POST',
+            '/webhook_endpoints',
+            '/delete',
+            true,
+            null,
+            false,
+            {},
+            {
+                isIdempotent: true,
+            },
+        ],
+        ['list', 'GET', '/webhook_endpoints', null, false, null, false, {}, {}],
+    ],
+    impactedCustomer: [],
+    subscriptionEntitlementsUpdatedDetail: [],
+    subscriptionEntitlementsCreatedDetail: [],
 };

package/esm/environment.js

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

package/esm/resources/api_endpoints.js

@@ -4673,6 +4673,31 @@ export const Endpoints = {
         ],
         ['retrieve', 'GET', '/recorded_purchases', null, true, null, false, {}, {}],
     ],
+    omnichannelOneTimeOrder: [
+        [
+            'retrieve',
+            'GET',
+            '/omnichannel_one_time_orders',
+            null,
+            true,
+            null,
+            false,
+            {},
+            {},
+        ],
+        [
+            'list',
+            'GET',
+            '/omnichannel_one_time_orders',
+            null,
+            false,
+            null,
+            false,
+            {},
+            {},
+        ],
+    ],
+    omnichannelOneTimeOrderItem: [],
     rule: [['retrieve', 'GET', '/rules', null, true, null, false, {}, {}]],
     usageEvent: [
         [
@@ -4705,10 +4730,10 @@ export const Endpoints = {
     omnichannelSubscriptionItemScheduledChange: [],
     usageFile: [
         [
-            'upload',
+            'uploadUrl',
             'POST',
             '/usage_files',
-            '/upload',
+            '/upload_url',
             false,
             'file-ingest',
             false,
@@ -4716,10 +4741,10 @@ export const Endpoints = {
             {},
         ],
         [
-            'status',
+            'processingStatus',
             'GET',
             '/usage_files',
-            '/status',
+            '/processing_status',
             true,
             'file-ingest',
             false,
@@ -4728,4 +4753,50 @@ export const Endpoints = {
         ],
     ],
     brand: [],
+    webhookEndpoint: [
+        [
+            'create',
+            'POST',
+            '/webhook_endpoints',
+            null,
+            false,
+            null,
+            false,
+            {},
+            {
+                isIdempotent: true,
+            },
+        ],
+        [
+            'update',
+            'POST',
+            '/webhook_endpoints',
+            null,
+            true,
+            null,
+            false,
+            {},
+            {
+                isIdempotent: true,
+            },
+        ],
+        ['retrieve', 'GET', '/webhook_endpoints', null, true, null, false, {}, {}],
+        [
+            'delete',
+            'POST',
+            '/webhook_endpoints',
+            '/delete',
+            true,
+            null,
+            false,
+            {},
+            {
+                isIdempotent: true,
+            },
+        ],
+        ['list', 'GET', '/webhook_endpoints', null, false, null, false, {}, {}],
+    ],
+    impactedCustomer: [],
+    subscriptionEntitlementsUpdatedDetail: [],
+    subscriptionEntitlementsCreatedDetail: [],
 };

package/package.json

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

package/types/core.d.ts

@@ -144,7 +144,10 @@ declare module 'chargebee' {
     | 'omnichannel_transaction'
     | 'recorded_purchase'
     | 'omnichannel_subscription_item_scheduled_change'
-    | 'sales_order';
+    | 'sales_order'
+    | 'omnichannel_one_time_order'
+    | 'omnichannel_one_time_order_item'
+    | 'usage_file';
   type EventNameEnum = 'cancellation_page_loaded';
   type EventTypeEnum =
     | 'coupon_created'
@@ -349,6 +352,10 @@ declare module 'chargebee' {
     | 'omnichannel_subscription_item_changed'
     | 'omnichannel_subscription_item_paused'
     | 'omnichannel_subscription_item_resumed'
+    | 'omnichannel_one_time_order_created'
+    | 'omnichannel_one_time_order_item_cancelled'
+    | 'usage_file_ingested'
+    | 'omnichannel_subscription_item_pause_scheduled'
     | 'plan_created'
     | 'plan_updated'
     | 'plan_deleted'

package/types/index.d.ts

@@ -33,6 +33,7 @@
 ///<reference path='./resources/Gift.d.ts' />
 ///<reference path='./resources/Hierarchy.d.ts' />
 ///<reference path='./resources/HostedPage.d.ts' />
+///<reference path='./resources/ImpactedCustomer.d.ts' />
 ///<reference path='./resources/ImpactedItem.d.ts' />
 ///<reference path='./resources/ImpactedItemPrice.d.ts' />
 ///<reference path='./resources/ImpactedSubscription.d.ts' />
@@ -45,6 +46,8 @@
 ///<reference path='./resources/ItemPrice.d.ts' />
 ///<reference path='./resources/Metadata.d.ts' />
 ///<reference path='./resources/NonSubscription.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/OmnichannelSubscriptionItemScheduledChange.d.ts' />
@@ -75,6 +78,8 @@
 ///<reference path='./resources/SiteMigrationDetail.d.ts' />
 ///<reference path='./resources/Subscription.d.ts' />
 ///<reference path='./resources/SubscriptionEntitlement.d.ts' />
+///<reference path='./resources/SubscriptionEntitlementsCreatedDetail.d.ts' />
+///<reference path='./resources/SubscriptionEntitlementsUpdatedDetail.d.ts' />
 ///<reference path='./resources/SubscriptionEstimate.d.ts' />
 ///<reference path='./resources/TaxWithheld.d.ts' />
 ///<reference path='./resources/ThirdPartyPaymentMethod.d.ts' />
@@ -86,6 +91,7 @@
 ///<reference path='./resources/UsageEvent.d.ts' />
 ///<reference path='./resources/UsageFile.d.ts' />
 ///<reference path='./resources/VirtualBankAccount.d.ts' />
+///<reference path='./resources/WebhookEndpoint.d.ts' />
 
 export type Config = {
   /**
@@ -186,6 +192,7 @@ declare module 'chargebee' {
     itemFamily: ItemFamily.ItemFamilyResource;
     itemPrice: ItemPrice.ItemPriceResource;
     nonSubscription: NonSubscription.NonSubscriptionResource;
+    omnichannelOneTimeOrder: OmnichannelOneTimeOrder.OmnichannelOneTimeOrderResource;
     omnichannelSubscription: OmnichannelSubscription.OmnichannelSubscriptionResource;
     omnichannelSubscriptionItem: OmnichannelSubscriptionItem.OmnichannelSubscriptionItemResource;
     order: Order.OrderResource;
@@ -214,5 +221,6 @@ declare module 'chargebee' {
     usageEvent: UsageEvent.UsageEventResource;
     usageFile: UsageFile.UsageFileResource;
     virtualBankAccount: VirtualBankAccount.VirtualBankAccountResource;
+    webhookEndpoint: WebhookEndpoint.WebhookEndpointResource;
   }
 }

package/types/resources/Comment.d.ts

@@ -10,6 +10,7 @@ declare module 'chargebee' {
     created_at: number;
     type: 'user' | 'system';
     entity_id: string;
+    business_entity_id?: string;
   }
 
   export namespace Comment {
@@ -82,6 +83,9 @@ declare module 'chargebee' {
         | '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/CreditNote.d.ts

@@ -36,7 +36,6 @@ declare module 'chargebee' {
     resource_version?: number;
     updated_at?: number;
     channel?: ChannelEnum;
-    einvoice?: CreditNote.Einvoice;
     sub_total: number;
     sub_total_in_local_currency?: number;
     total_in_local_currency?: number;
@@ -44,11 +43,13 @@ declare module 'chargebee' {
     round_off_amount?: number;
     fractional_correction?: number;
     line_items?: CreditNote.LineItem[];
-    discounts?: CreditNote.Discount[];
-    line_item_discounts?: CreditNote.LineItemDiscount[];
     line_item_tiers?: CreditNote.LineItemTier[];
-    taxes?: CreditNote.Tax[];
+    line_item_discounts?: CreditNote.LineItemDiscount[];
     line_item_taxes?: CreditNote.LineItemTax[];
+    line_item_addresses?: CreditNote.LineItemAddress[];
+    discounts?: CreditNote.Discount[];
+    taxes?: CreditNote.Tax[];
+    tax_origin?: CreditNote.TaxOrigin;
     linked_refunds?: CreditNote.LinkedRefund[];
     allocations?: CreditNote.Allocation[];
     deleted: boolean;
@@ -59,9 +60,8 @@ declare module 'chargebee' {
     business_entity_id?: string;
     shipping_address?: CreditNote.ShippingAddress;
     billing_address?: CreditNote.BillingAddress;
+    einvoice?: CreditNote.Einvoice;
     site_details_at_creation?: CreditNote.SiteDetailsAtCreation;
-    tax_origin?: CreditNote.TaxOrigin;
-    line_item_addresses?: CreditNote.LineItemAddress[];
   }
 
   export namespace CreditNote {
@@ -206,18 +206,6 @@ declare module 'chargebee' {
       credit_note: CreditNote;
     }
 
-    export interface Einvoice {
-      id: string;
-      reference_number?: string;
-      status:
-        | 'scheduled'
-        | 'skipped'
-        | 'in_progress'
-        | 'success'
-        | 'failed'
-        | 'registered';
-      message?: string;
-    }
     export interface LineItem {
       id?: string;
       subscription_id?: string;
@@ -267,33 +255,6 @@ declare module 'chargebee' {
       entity_id?: string;
       customer_id?: string;
     }
-    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';
-      discount_type?: 'fixed_amount' | 'percentage';
-      entity_id?: string;
-      coupon_set_code?: string;
-    }
-    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';
-      coupon_id?: string;
-      entity_id?: string;
-      discount_amount: number;
-    }
     export interface LineItemTier {
       line_item_id?: string;
       starting_unit: number;
@@ -307,10 +268,18 @@ declare module 'chargebee' {
       pricing_type?: 'per_unit' | 'flat_fee' | 'package';
       package_size?: number;
     }
-    export interface Tax {
-      name: string;
-      amount: number;
-      description?: string;
+    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';
+      coupon_id?: string;
+      entity_id?: string;
+      discount_amount: number;
     }
     export interface LineItemTax {
       line_item_id?: string;
@@ -337,6 +306,50 @@ declare module 'chargebee' {
       tax_amount_in_local_currency?: number;
       local_currency_code?: string;
     }
+    export interface LineItemAddress {
+      line_item_id?: string;
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      state?: string;
+      country?: string;
+      zip?: string;
+      validation_status?:
+        | 'not_validated'
+        | 'valid'
+        | 'partially_valid'
+        | 'invalid';
+    }
+    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';
+      discount_type?: 'fixed_amount' | 'percentage';
+      entity_id?: string;
+      coupon_set_code?: string;
+    }
+    export interface Tax {
+      name: string;
+      amount: number;
+      description?: string;
+    }
+    export interface TaxOrigin {
+      country?: string;
+      registration_number?: string;
+    }
     export interface LinkedRefund {
       txn_id: string;
       applied_amount: number;
@@ -400,35 +413,22 @@ declare module 'chargebee' {
       zip?: string;
       validation_status?: ValidationStatusEnum;
     }
+    export interface Einvoice {
+      id: string;
+      reference_number?: string;
+      status:
+        | 'scheduled'
+        | 'skipped'
+        | 'in_progress'
+        | 'success'
+        | 'failed'
+        | 'registered';
+      message?: string;
+    }
     export interface SiteDetailsAtCreation {
       timezone?: string;
       organization_address?: object;
     }
-    export interface TaxOrigin {
-      country?: string;
-      registration_number?: string;
-    }
-    export interface LineItemAddress {
-      line_item_id?: string;
-      first_name?: string;
-      last_name?: string;
-      email?: string;
-      company?: string;
-      phone?: string;
-      line1?: string;
-      line2?: string;
-      line3?: string;
-      city?: string;
-      state_code?: string;
-      state?: string;
-      country?: string;
-      zip?: string;
-      validation_status?:
-        | 'not_validated'
-        | 'valid'
-        | 'partially_valid'
-        | 'invalid';
-    }
     // REQUEST PARAMS
     //---------------
 
@@ -543,7 +543,9 @@ declare module 'chargebee' {
         | 'adhoc'
         | 'plan_item_price'
         | 'addon_item_price'
-        | 'charge_item_price';
+        | 'charge_item_price'
+        | 'plan'
+        | 'addon';
       entity_id?: string;
     }
     export interface LineItemRetrieveInputParam {
@@ -558,6 +560,7 @@ declare module 'chargebee' {
     }
 
     export interface TransactionRecordRefundInputParam {
+      id?: string;
       amount?: number;
       payment_method: PaymentMethodEnum;
       reference_number?: string;
@@ -590,6 +593,7 @@ declare module 'chargebee' {
       amount: number;
     }
     export interface LinkedRefundsImportCreditNoteInputParam {
+      id?: string;
       amount: number;
       payment_method: PaymentMethodEnum;
       date: number;
@@ -640,7 +644,10 @@ declare module 'chargebee' {
         | 'adhoc'
         | 'plan_item_price'
         | 'addon_item_price'
-        | 'charge_item_price';
+        | 'charge_item_price'
+        | 'plan_setup'
+        | 'plan'
+        | 'addon';
       entity_id?: string;
       item_level_discount1_entity_id?: string;
       item_level_discount1_amount?: number;

package/types/resources/Customer.d.ts

@@ -869,6 +869,7 @@ declare module 'chargebee' {
     }
 
     export interface TransactionRecordExcessPaymentInputParam {
+      id?: string;
       amount: number;
       currency_code?: string;
       date: number;

package/types/resources/CustomerEntitlement.d.ts

@@ -31,6 +31,7 @@ declare module 'chargebee' {
     export interface EntitlementsForCustomerInputParam {
       limit?: number;
       offset?: string;
+      consolidate_entitlements?: boolean;
     }
   }
 }

package/types/resources/Discount.d.ts

@@ -5,9 +5,10 @@ declare module 'chargebee' {
   export interface Discount {
     id: string;
     invoice_name?: string;
-    type: 'fixed_amount' | 'percentage';
+    type: 'fixed_amount' | 'percentage' | 'offer_quantity';
     percentage?: number;
     amount?: number;
+    quantity?: number;
     currency_code?: string;
     duration_type: DurationTypeEnum;
     period?: number;