chargebee 2.42.0 → 2.44.0

package/types/resources/Customer.d.ts

@@ -214,7 +214,7 @@ declare module 'chargebee' {
     }
     export interface CreateInputParam {
       [key : string] : any;  
-      card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway?:Gateway,gateway_account_id?:string,ip_address?:string,last_name?:string,number?:string,tmp_token?:string};
+      card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway?:Gateway,gateway_account_id?:string,ip_address?:string,last_name?:string,number?:string,preferred_scheme?:'cartes_bancaires' | 'mastercard' | 'visa',tmp_token?:string};
        
       bank_account?:{account_holder_type?:AccountHolderType,account_number?:string,account_type?:AccountType,bank_code?:string,bank_name?:string,billing_address?:object,company?:string,echeck_type?:EcheckType,email?:string,first_name?:string,gateway_account_id?:string,iban?:string,issuing_country?:string,last_name?:string,phone?:string,routing_number?:string,swedish_identity_number?:string};
        
@@ -660,7 +660,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
        
       payment_method?:{additional_information?:object,gateway_account_id?:string,reference_id?:string,tmp_token?:string,type?:Type};
        
-      card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway_account_id?:string,last_name?:string,number?:string};
+      card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway_account_id?:string,last_name?:string,number?:string,preferred_scheme?:'cartes_bancaires' | 'mastercard' | 'visa'};
        
       payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
        

package/types/resources/DifferentialPrice.d.ts

@@ -92,6 +92,8 @@ declare module 'chargebee' {
       */
     
     parent_periods?:DifferentialPrice.ParentPeriod[];
+
+    business_entity_id?:string;
   }
   export namespace DifferentialPrice {
     export class DifferentialPriceResource {  
@@ -169,6 +171,8 @@ declare module 'chargebee' {
         */
        
       tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
+      
+      business_entity_id?:string;
     }
     export interface RetrieveResponse {  
        differential_price:DifferentialPrice;

package/types/resources/Estimate.d.ts

@@ -3,21 +3,25 @@
 declare module 'chargebee' {
   export interface Estimate {
     
+
     created_at:number;
-    
+
     subscription_estimate?:SubscriptionEstimate;
-    
+
     subscription_estimates?:SubscriptionEstimate[];
-    
+
     invoice_estimate?:InvoiceEstimate;
-    
+
     invoice_estimates?:InvoiceEstimate[];
-    
+
+    payment_schedule_estimates?:PaymentScheduleEstimate[];
+
     next_invoice_estimate?:InvoiceEstimate;
-    
+
     credit_note_estimates?:CreditNoteEstimate[];
-    
+
     unbilled_charge_estimates?:UnbilledCharge[];
+
   }
   export namespace Estimate {
     export class EstimateResource {  
@@ -58,6 +62,8 @@ declare module 'chargebee' {
       create_invoice(input?:CreateInvoiceInputParam):ChargebeeRequest<CreateInvoiceResponse>;
        
       create_invoice_for_items(input:CreateInvoiceForItemsInputParam):ChargebeeRequest<CreateInvoiceForItemsResponse>;
+       
+      payment_schedules(input:PaymentSchedulesInputParam):ChargebeeRequest<PaymentSchedulesResponse>;
     }
     export interface CreateSubscriptionResponse {  
        estimate:Estimate;
@@ -565,6 +571,19 @@ declare module 'chargebee' {
        
       invoice_date?:number;
     }
+    export interface PaymentSchedulesResponse {  
+       estimate:Estimate;
+    }
+    export interface PaymentSchedulesInputParam {
+       
+      scheme_id:string;
+       
+      amount?:number;
+       
+      invoice_id?:string;
+       
+      payment_schedule_start_date?:number;
+    }
     
   }
 }

package/types/resources/Export.d.ts

@@ -630,6 +630,10 @@ Total amount charged for the order.
         */
        
       item_family?:{id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},name?:{is?:string,is_not?:string,starts_with?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
+      
+      business_entity_id?:{is?:string,is_present?:'true' | 'false'};
+       
+      include_site_level_resources?:{is?:'true' | 'false'};
     }
     export interface ItemsResponse {  
        export:Export;
@@ -642,6 +646,10 @@ Total amount charged for the order.
         */
        
       item?:{channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},enabled_for_checkout?:{is?:'true' | 'false'},enabled_in_portal?:{is?:'true' | 'false'},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},is_giftable?:{is?:'true' | 'false'},item_applicability?:{in?:string,is?:'all' | 'restricted',is_not?:'all' | 'restricted',not_in?:string},item_family_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},metered?:{is?:'true' | 'false'},name?:{is?:string,is_not?:string,starts_with?:string},status?:{in?:string,is?:'archived' | 'deleted' | 'active',is_not?:'archived' | 'deleted' | 'active',not_in?:string},type?:{in?:string,is?:'charge' | 'addon' | 'plan',is_not?:'charge' | 'addon' | 'plan',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string},usage_calculation?:{in?:string,is?:'max_usage' | 'sum_of_usages' | 'last_usage',is_not?:'max_usage' | 'sum_of_usages' | 'last_usage',not_in?:string}};
+    
+      business_entity_id?:{is?:string,is_present?:'true' | 'false'};
+       
+      include_site_level_resources?:{is?:'true' | 'false'};
     }
     export interface ItemPricesResponse {  
        export:Export;
@@ -687,6 +695,10 @@ Filter item prices based on their `currency_code`.
         */
        
       item_price?:{channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},name?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},period?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},period_unit?:{in?:string,is?:'week' | 'month' | 'year' | 'day',is_not?:'week' | 'month' | 'year' | 'day',not_in?:string},pricing_model?:{in?:string,is?:'volume' | 'per_unit' | 'tiered' | 'flat_fee' | 'stairstep',is_not?:'volume' | 'per_unit' | 'tiered' | 'flat_fee' | 'stairstep',not_in?:string},status?:{in?:string,is?:'archived' | 'deleted' | 'active',is_not?:'archived' | 'deleted' | 'active',not_in?:string},trial_period?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},trial_period_unit?:{in?:string,is?:'month' | 'day',is_not?:'month' | 'day',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
+    
+      business_entity_id?:{is?:string,is_present?:'true' | 'false'};
+       
+      include_site_level_resources?:{is?:'true' | 'false'};
     }
     export interface AttachedItemsResponse {  
        export:Export;
@@ -740,6 +752,10 @@ Item Id of Addon / Charge item price for which differential pricing is applied t
     export interface PriceVariantsInputParam {
        
       price_variant?:{created_at?:{after?:string,before?:string,between?:string,on?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},name?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},status?:{in?:string,is?:'active' | 'archived',is_not?:'active' | 'archived',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
+    
+      business_entity_id?:{is?:string,is_present?:'true' | 'false'};
+       
+      include_site_level_resources?:{is?:'true' | 'false'};
     }
     export interface Download {  
          /**

package/types/resources/Invoice.d.ts

@@ -906,7 +906,7 @@ This endpoint schedules e-invoices manually. This operation is not allowed when
 
         */
        
-      card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway_account_id?:string,last_name?:string,number?:string};
+      card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway?:Gateway,gateway_account_id?:string,ip_address?:string,last_name?:string,number?:string,preferred_scheme?:'cartes_bancaires' | 'mastercard' | 'visa',tmp_token?:string};
        
       /**
         * @description Parameters for bank_account
@@ -1088,7 +1088,7 @@ The invoice is [linked](/docs/api?prod_cat_ver=2#mbe-linked-be) to the same
 
         */
        
-      card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway_account_id?:string,last_name?:string,number?:string};
+      card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway?:Gateway,gateway_account_id?:string,ip_address?:string,last_name?:string,number?:string,preferred_scheme?:'cartes_bancaires' | 'mastercard' | 'visa',tmp_token?:string};
        
       /**
         * @description Parameters for bank_account

package/types/resources/Item.d.ts

@@ -56,6 +56,8 @@ declare module 'chargebee' {
 
     metadata?:object;
 
+    business_entity_id?:string;
+
   }
   export namespace Item {
     export class ItemResource {  
@@ -115,6 +117,8 @@ declare module 'chargebee' {
       usage_calculation?:'sum_of_usages' | 'last_usage' | 'max_usage';
        
       metadata?:object;
+       
+      business_entity_id?:string;
     }
     export interface RetrieveResponse {  
        item:Item;
@@ -292,6 +296,19 @@ declare module 'chargebee' {
         
       channel?:{in?:string,is?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | 'play_store',not_in?:string};
        
+      /**
+        * @description The unique ID of the [business entity](/docs/api?prod_cat_ver=2#mbe) of this subscription. This is always the same as the [business entity](/docs/api/subscriptions?prod_cat_ver=2#subscription_customer_id) of the customer.  
+The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  
+**Note**
+
+[Multiple Business Entities](/docs/api?prod_cat_ver=2#mbe) is a feature available only on Product Catalog 2.0.
+
+        */
+        
+      business_entity_id?:{is?:string,is_present?:'true' | 'false'};
+       
+      include_site_level_resources?:{is?:'true' | 'false'};
+       
       sort_by?:{asc?:'name' | 'id' | 'updated_at',desc?:'name' | 'id' | 'updated_at'};
     }
     export interface DeleteResponse {  

package/types/resources/ItemFamily.d.ts

@@ -1,91 +1,36 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface ItemFamily {
     [key : string] : any;
-    /**
-      * @description The identifier for the item family. It is unique and immutable.
 
-      */
-    
     id:string;
-    
-    /**
-      * @description A unique display name for the item family. This is visible only in Chargebee and not to customers.
 
-      */
-    
     name:string;
-    
-    /**
-      * @description Description of the item family. This is visible only in Chargebee and not to customers.
 
-      */
-    
     description?:string;
-    
-    /**
-      * @description Status of the item family. \* active - The item family is active and can be used to create new items. \* deleted - The item family has been deleted and cannot be used to create new items. The &#x60;id&#x60; and &#x60;name&#x60; can be reused to create a new item family.
 
-      */
-    
-    status?:'deleted' | 'active';
-    
-    /**
-      * @description The version number of this resource. For every change made to the resource, &#x60;resource_version&#x60; is updated with a new timestamp in milliseconds.
+    status?:'active' | 'deleted';
 
-      */
-    
     resource_version?:number;
-    
-    /**
-      * @description When the item family was last updated.
 
-      */
-    
     updated_at?:number;
-    
-    /**
-      * @description The subscription channel this object originated from and is maintained in. \* app_store - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. \* play_store - The object data is synchronized with data from [in-app subscription(s)](https://apidocs.chargebee.com/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. \* web - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI.
 
-      */
-    
     channel?:Channel;
+
+    business_entity_id?:string;
+
   }
   export namespace ItemFamily {
     export class ItemFamilyResource {  
-      /**
-        * @description This endpoint creates an item family for your product line or service.
-
-        */
-      
       create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
        
-      /**
-        * @description This endpoint retrieves an item family based on the item family id.
-
-        */
-      
       retrieve(item_family_id:string):ChargebeeRequest<RetrieveResponse>;
        
-      /**
-        * @description Returns a list of item families satisfying **all** the conditions specified in the filter parameters below. The list is sorted by date of creation, in descending order.
-
-        */
-      
       list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
        
-      /**
-        * @description This endpoint updates the name and/or description of the item family.
-
-        */
-      
       update(item_family_id:string, input?:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
        
-      /**
-        * @description Deletes an item family, marking its &#x60;status&#x60; as &#x60;deleted&#x60;. This is not allowed if there are &#x60;active&#x60; items under the item family. Once deleted, the &#x60;id&#x60; and &#x60;name&#x60; of the item family can be reused to create a new item family.
-
-        */
-      
       delete(item_family_id:string):ChargebeeRequest<DeleteResponse>;
     }
     export interface CreateResponse {  
@@ -93,100 +38,80 @@ declare module 'chargebee' {
     }
     export interface CreateInputParam {
       [key : string] : any;  
-      /**
-        * @description The identifier for the item family. Must be unique and is immutable.
-
-        */
-       
       id:string;
        
-      /**
-        * @description The display name for the item family. Must be unique. This is visible only in Chargebee and not to customers.
-
-        */
-       
       name:string;
        
-      /**
-        * @description Description of the item family. This is visible only in Chargebee and not to customers.
-
-        */
-       
       description?:string;
+       
+      business_entity_id?:string;
     }
     export interface RetrieveResponse {  
        item_family:ItemFamily;
     }
     
     export interface ListResponse {  
-      /**
-        * @description Returns a list of item families satisfying **all** the conditions specified in the filter parameters below. The list is sorted by date of creation, in descending order.
-
-        */
-       
        list:{item_family:ItemFamily}[];
        
-      /**
-        * @description Returns a list of item families satisfying **all** the conditions specified in the filter parameters below. The list is sorted by date of creation, in descending order.
-
-        */
-       
        next_offset?:string;
     }
     export interface ListInputParam {
       [key : string]: any;  
       /**
-        * @description Returns a list of item families satisfying **all** the conditions specified in the filter parameters below. The list is sorted by date of creation, in descending order.
+        * @description The number of resources to be returned.
 
         */
         
       limit?:number;
        
       /**
-        * @description Returns a list of item families satisfying **all** the conditions specified in the filter parameters below. The list is sorted by date of creation, in descending order.
+        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
 
         */
         
       offset?:string;
        
       /**
-        * @description Returns a list of item families satisfying **all** the conditions specified in the filter parameters below. The list is sorted by date of creation, in descending order.
+        * @description The identifier for the item family. It is unique and immutable.
 
         */
         
       id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Returns a list of item families satisfying **all** the conditions specified in the filter parameters below. The list is sorted by date of creation, in descending order.
+        * @description A unique display name for the item family. This is visible only in Chargebee and not to customers.
 
         */
         
       name?:{is?:string,is_not?:string,starts_with?:string};
        
       /**
-        * @description Returns a list of item families satisfying **all** the conditions specified in the filter parameters below. The list is sorted by date of creation, in descending order.
+        * @description When the item family was last updated.
 
         */
         
       updated_at?:{after?:string,before?:string,between?:string,on?:string};
+       
+      /**
+        * @description The unique ID of the [business entity](/docs/api?prod_cat_ver&#x3D;2#mbe) of this subscription. This is always the same as the [business entity](/docs/api/subscriptions?prod_cat_ver&#x3D;2#subscription_customer_id) of the customer.  
+The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  
+**Note**
+
+[Multiple Business Entities](/docs/api?prod_cat_ver&#x3D;2#mbe) is a feature available only on Product Catalog 2.0.
+
+        */
+        
+      business_entity_id?:{is?:string,is_present?:'true' | 'false'};
+       
+      include_site_level_resources?:{is?:'true' | 'false'};
     }
     export interface UpdateResponse {  
        item_family:ItemFamily;
     }
     export interface UpdateInputParam {
       [key : string] : any;  
-      /**
-        * @description The display name for the item family. Must be unique. This is visible only in Chargebee and not to customers.
-
-        */
-       
       name?:string;
        
-      /**
-        * @description Description of the item family. This is visible only in Chargebee and not to customers.
-
-        */
-       
       description?:string;
     }
     export interface DeleteResponse {