chargebee 2.28.0 → 2.30.0

package/types/resources/ItemPrice.d.ts

@@ -23,6 +23,11 @@ declare module 'chargebee' {
     
     item_family_id?:string;
     
+    /**
+      * @description Identifier of the product
+
+      */
+    
     product_id?:string;
     
     /**
@@ -33,7 +38,9 @@ declare module 'chargebee' {
     item_id?:string;
     
     /**
-      * @description Description of the item price.
+      * @description Description of the item price.   
+**Note:**   
+If your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.
 
       */
     
@@ -218,7 +225,7 @@ In-App Subscriptions is currently in early access. Contact [eap@chargebee.com](m
     is_taxable?:boolean;
     
     /**
-      * @description A set of key-value pairs stored as additional information for the item price. [Learn more](./#meta_data).
+      * @description A collection of key-value pairs that provides extra information about the item price. [Learn more](advanced-features#metadata).
 
       */
     
@@ -269,11 +276,11 @@ In-App Subscriptions is currently in early access. Contact [eap@chargebee.com](m
   export namespace ItemPrice {
     export class ItemPriceResource {  
       /**
-        * @description Returns the set of all applicable [addon-items](items?prod_cat_ver=2#addon-items) for a specific [plan-item price](item_prices?prod_cat_ver=2#types). This set consists of all addon-items whose item prices can be applied to a subscription having the plan-item price in it. When determining this set, Chargebee considers the [item_applicability](items?prod_cat_ver=2#item_item_applicability) and [applicable_items](items?prod_cat_ver=2#item_applicable_items) defined for the parent item of the plan-item price.
+        * @description This API creates an item price (a price point) for an [item](./items?prod_cat_ver=2).
 
         */
       
-      find_applicable_items(item_price_id:string, input?:FindApplicableItemsInputParam):ChargebeeRequest<FindApplicableItemsResponse>;
+      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
        
       /**
         * @description This API retrieves a specific item price using the id.
@@ -289,6 +296,13 @@ In-App Subscriptions is currently in early access. Contact [eap@chargebee.com](m
       
       update(item_price_id:string, input?:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
        
+      /**
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
+
+        */
+      
+      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+       
       /**
         * @description Deletes an item price, marking its &#x60;status&#x60; as &#x60;deleted&#x60;. If it is part of a subscription or invoice, the item price &#x60;status&#x60; is marked &#x60;archived&#x60; instead. Once deleted, the &#x60;id&#x60; and &#x60;name&#x60; of the item price can be reused to create a new item price.
 
@@ -296,6 +310,13 @@ In-App Subscriptions is currently in early access. Contact [eap@chargebee.com](m
       
       delete(item_price_id:string):ChargebeeRequest<DeleteResponse>;
        
+      /**
+        * @description Returns the set of all applicable [addon-items](items?prod_cat_ver&#x3D;2#addon-items) for a specific [plan-item price](item_prices?prod_cat_ver&#x3D;2#types). This set consists of all addon-items whose item prices can be applied to a subscription having the plan-item price in it. When determining this set, Chargebee considers the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price.
+
+        */
+      
+      find_applicable_items(item_price_id:string, input?:FindApplicableItemsInputParam):ChargebeeRequest<FindApplicableItemsResponse>;
+       
       /**
         * @description Returns the set of all applicable [addon-item](item_prices?prod_cat_ver&#x3D;2#types) prices for a specific plan-item price. This set consists of all the addon-item prices that can be applied to a subscription having the plan-item price. When determining this set, Chargebee considers the following:
 
@@ -309,58 +330,219 @@ If an addon-item price has [differential pricing](differential_prices?prod_cat_v
         */
       
       find_applicable_item_prices(item_price_id:string, input?:FindApplicableItemPricesInputParam):ChargebeeRequest<FindApplicableItemPricesResponse>;
+    }
+    export interface CreateResponse {  
+       item_price:ItemPrice;
+    }
+    export interface CreateInputParam {
+      [key : string] : any;  
+      /**
+        * @description The identifier for the item price. It is unique and immutable.
+
+        */
+       
+      id:string;
        
       /**
-        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
+        * @description A unique display name for the item price in the Chargebee UI. If &#x60;external_name&#x60; is not provided, this is also used in customer-facing pages and documents such as [invoices](./invoices?prod_cat_ver&#x3D;2) and [hosted pages](hosted_pages?prod_cat_ver&#x3D;2).
 
         */
-      
-      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+       
+      name:string;
        
       /**
-        * @description This API creates an item price (a price point) for an [item](./items?prod_cat_ver&#x3D;2).
+        * @description Description of the item price.   
+**Note:**   
+If your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.
 
         */
-      
-      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
-    }
-    export interface FindApplicableItemsResponse {  
+       
+      description?:string;
+       
       /**
-        * @description Returns the set of all applicable [addon-items](items?prod_cat_ver&#x3D;2#addon-items) for a specific [plan-item price](item_prices?prod_cat_ver&#x3D;2#types). This set consists of all addon-items whose item prices can be applied to a subscription having the plan-item price in it. When determining this set, Chargebee considers the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price.
+        * @description The id of the item that the item price belongs to.
 
         */
        
-       list:{item:Item}[];
+      item_id:string;
        
       /**
-        * @description Returns the set of all applicable [addon-items](items?prod_cat_ver&#x3D;2#addon-items) for a specific [plan-item price](item_prices?prod_cat_ver&#x3D;2#types). This set consists of all addon-items whose item prices can be applied to a subscription having the plan-item price in it. When determining this set, Chargebee considers the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price.
+        * @description A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices#invoice_notes) displayed on the invoice PDF.
 
         */
        
-       next_offset?:string;
-    }
-    export interface FindApplicableItemsInputParam {
-      [key : string]: any;  
+      invoice_notes?:string;
+       
       /**
-        * @description The number of resources to be returned.
+        * @description The name of the item price used in customer-facing pages and documents. These include [invoices](./invoices?prod_cat_ver&#x3D;2) and [hosted pages](hosted_pages?prod_cat_ver&#x3D;2). If not provided, then &#x60;name&#x60; is used.
 
         */
-        
-      limit?:number;
+       
+      external_name?:string;
        
       /**
-        * @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.
+        * @description The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)) for the item price. Is required when multiple currencies have been enabled.
 
         */
-        
-      offset?:string;
+       
+      currency_code?:string;
        
       /**
-        * @description Returns the set of all applicable [addon-items](items?prod_cat_ver&#x3D;2#addon-items) for a specific [plan-item price](item_prices?prod_cat_ver&#x3D;2#types). This set consists of all addon-items whose item prices can be applied to a subscription having the plan-item price in it. When determining this set, Chargebee considers the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price.
+        * @description Specifies whether taxes apply to this item price. This value is set and returned even if [Taxes](https://www.chargebee.com/docs/tax.html) have been disabled in Chargebee. However, the value is effective only while Taxes are enabled.
 
         */
-        
-      sort_by?:{asc?:'updated_at' | 'name' | 'id',desc?:'updated_at' | 'name' | 'id'};
+       
+      is_taxable?:boolean;
+       
+      /**
+        * @description Free quantity the subscriptions of this item_price will have. Only the quantity more than this will be charged for the subscription.
+
+        */
+       
+      free_quantity?:number;
+       
+      /**
+        * @description The quantity of the item that is available free-of-charge, represented in decimal. When a subscription is created for this plan or when the plan of a subscription is changed to this one, only the quantity above this number is charged for. Applicable for quantity-based plans and only when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
+
+        */
+       
+      free_quantity_in_decimal?:string;
+       
+      /**
+        * @description A collection of key-value pairs that provides extra information about the item price.  
+**Note:** There&#x27;s a character limit of 65,535.
+[Learn more](advanced-features#metadata).
+
+        */
+       
+      metadata?:object;
+       
+      /**
+        * @description Whether the item price&#x27;s description should be shown on [invoice PDFs](/docs/api/invoices#retrieve_invoice_as_pdf). If this Boolean is changed, only invoices generated (or [regenerated](https://www.chargebee.com/docs/invoice-operations.html#actions-for-payment-due-not-paid-invoices_regenerate-invoice)) after the change are affected; past invoices are not.
+
+        */
+       
+      show_description_in_invoices?:boolean;
+       
+      /**
+        * @description Whether the item price&#x27;s description should be shown on [quote PDFs](/docs/api/quotes#retrieve_quote_as_pdf). If this Boolean is changed, only quotes created after the change are affected; past quotes are not.
+
+        */
+       
+      show_description_in_quotes?:boolean;
+       
+      /**
+        * @description The [pricing scheme](https://www.chargebee.com/docs/2.0/plans.html#pricing-models) for this item price. If subscriptions, invoices or [differential prices](./differential_prices?prod_cat_ver&#x3D;2) exist for this item price, &#x60;pricing_model&#x60; cannot be changed.
+\* tiered - The per unit price is based on the tier that the total quantity falls in.
+\* per_unit - A fixed price per unit quantity.
+\* flat_fee - A fixed price that is not quantity-based.
+\* volume - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
+\* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
+
+        */
+       
+      pricing_model?:PricingModel;
+       
+      /**
+        * @description The cost of the item price when the pricing model is &#x60;flat_fee&#x60;. When the pricing model is &#x60;per_unit&#x60;, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in the [minor unit of the currency](https://apidocs.chargebee.com/docs/api#handling_currency_units).
+
+        */
+       
+      price?:number;
+       
+      /**
+        * @description The price of the item when the pricing_model is &#x60;flat_fee&#x60;. When the pricing model is &#x60;per_unit&#x60;, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
+
+        */
+       
+      price_in_decimal?:string;
+       
+      /**
+        * @description The unit of time for &#x60;period&#x60;. If subscriptions or invoices exist for this item price, &#x60;period_unit&#x60; cannot be changed. The &#x60;period_unit&#x60; is mandatory when the item &#x60;type&#x60; is &#x60;plan&#x60; or &#x60;addon&#x60;. \* month - A period of 1 calendar month. \* week - A period of 7 days. \* year - A period of 1 calendar year. \* day - A period of 24 hours.
+
+        */
+       
+      period_unit?:'week' | 'month' | 'year' | 'day';
+       
+      /**
+        * @description 
+
+* When the item &#x60;type&#x60; is &#x60;plan&#x60;: The billing period of the plan in &#x60;period_unit&#x60;s. For example, create a 6 month plan by providing &#x60;period&#x60; as 6 and &#x60;period_unit&#x60; as month.
+* When item &#x60;type&#x60; is &#x60;addon&#x60;: The period of the addon in &#x60;period_unit&#x60;s. For example, create an addon with a 2 month &#x60;period&#x60; by providing period as 2 and &#x60;period_unit&#x60; as &#x60;month&#x60;. The period of an addon is the duration for which its &#x60;price&#x60; applies. When attached to a plan, the addon is billed for the billing period of the plan. [Learn more.](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
+
+
+
+If subscriptions or invoices exist for this item price, &#x60;period&#x60; cannot be changed. The &#x60;period&#x60; is mandatory when the item &#x60;type&#x60; is &#x60;plan&#x60; or &#x60;addon&#x60;.
+
+        */
+       
+      period?:number;
+       
+      /**
+        * @description The unit of time for &#x60;trial_period&#x60;. \* month - A period of 1 calendar month. \* day - A period of 24 hours.
+
+        */
+       
+      trial_period_unit?:'month' | 'day';
+       
+      /**
+        * @description The trial period of the plan in &#x60;trial_period_unit&#x60;s. You can also set [trial periods for addons](https://www.chargebee.com/docs/2.0/addons-trial.html); contact [Support](https://chargebee.freshdesk.com/support/home) to enable that feature.
+
+        */
+       
+      trial_period?:number;
+       
+      /**
+        * @description Defines the shipping frequency. Example: to bill customer every 2 weeks, provide &quot;2&quot; here.
+
+        */
+       
+      shipping_period?:number;
+       
+      /**
+        * @description Defines the shipping frequency in association with shipping period. \* day - A period of 24 hours. \* week - A period of 7 days. \* year - A period of 1 calendar year. \* month - A period of 1 calendar month.
+
+        */
+       
+      shipping_period_unit?:'week' | 'month' | 'year' | 'day';
+       
+      /**
+        * @description The default number of billing cycles a subscription to the plan must run. Can be [overridden](./subscriptions?prod_cat_ver&#x3D;2) for a subscription.
+
+Addons can also [have billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html). However, you must contact [Support](https://chargebee.freshdesk.com/support/home) to enable that. Also, for addons, you can [override this](./attached_items?prod_cat_ver&#x3D;2) while attaching it to a plan. However, if you provide the value while [applying the addon to a subscription](./subscriptions?prod_cat_ver&#x3D;2#subscription_subscription_items_item_type), then that value takes still higher precedence.
+If subscriptions, invoices or [differential prices](./differential_prices?prod_cat_ver&#x3D;2) exist for this item price, &#x60;billing_cycles&#x60; cannot be changed.
+
+        */
+       
+      billing_cycles?:number;
+       
+      /**
+        * @description Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/trial_periods.html#how-to-define-the-end-of-trial-actions-for-subscriptions) has been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever the &#x60;item.type&#x60; is &#x60;plan&#x60; and a trial period is defined for this item price, this attribute (parameter) is returned (required). This can be overridden at the [subscription-level](subscriptions?prod_cat_ver&#x3D;2#subscription_trial_end_action). \* cancel_subscription - The subscription cancels. \* activate_subscription - The subscription activates and charges are raised for non-metered items. \* site_default - The action [configured for the site](https://www.chargebee.com/docs/trial_periods.html#how-to-define-the-end-of-trial-actions-for-subscriptions) at the time when the trial ends, takes effect.
+
+        */
+       
+      trial_end_action?:'activate_subscription' | 'cancel_subscription' | 'site_default';
+       
+      /**
+        * @description Parameters for tax_detail
+
+        */
+       
+      tax_detail?:{avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_tax_code?:string,avalara_transaction_type?:number,hsn_code?:string,tax_profile_id?:string,taxjar_product_code?:string};
+       
+      /**
+        * @description Parameters for accounting_detail
+
+        */
+       
+      accounting_detail?:{accounting_category1?:string,accounting_category2?:string,accounting_category3?:string,accounting_category4?:string,accounting_code?:string,sku?:string};
+       
+      /**
+        * @description Parameters for tiers
+
+        */
+       
+      tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
     }
     export interface RetrieveResponse {  
        item_price:ItemPrice;
@@ -379,7 +561,9 @@ If an addon-item price has [differential pricing](differential_prices?prod_cat_v
       name?:string;
        
       /**
-        * @description Description of the item price.
+        * @description Description of the item price.   
+**Note:**   
+If your input contains characters that are subjected to sanitization (like incomplete HTML tags), the sanitization process might increase the length of your input. If the sanitized input exceeds the limit, your request will be rejected.
 
         */
        
@@ -435,7 +619,9 @@ If an addon-item price has [differential pricing](differential_prices?prod_cat_v
       free_quantity_in_decimal?:string;
        
       /**
-        * @description A set of key-value pairs stored as additional information for the item price. [Learn more](./#meta_data).
+        * @description A collection of key-value pairs that provides extra information about the item price.  
+**Note:** There&#x27;s a character limit of 65,535.
+[Learn more](advanced-features#metadata).
 
         */
        
@@ -568,207 +754,130 @@ If subscriptions, invoices or [differential prices](./differential_prices?prod_c
        
       tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
     }
-    export interface DeleteResponse {  
-       item_price:ItemPrice;
-    }
-    
-    export interface FindApplicableItemPricesResponse {  
+    export interface ListResponse {  
       /**
-        * @description Returns the set of all applicable [addon-item](item_prices?prod_cat_ver&#x3D;2#types) prices for a specific plan-item price. This set consists of all the addon-item prices that can be applied to a subscription having the plan-item price. When determining this set, Chargebee considers the following:
-
-* the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price
-* the [compatibility](subscriptions?prod_cat_ver&#x3D;2#compatibility) of the addon-item prices to the plan-item price
-
-**Note**
-
-If an addon-item price has [differential pricing](differential_prices?prod_cat_ver&#x3D;2) defined against the parent item of the plan-item price, then the pricing information in the addon-item price object returned, reflects the differential pricing.
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
         */
        
        list:{item_price:ItemPrice}[];
        
       /**
-        * @description Returns the set of all applicable [addon-item](item_prices?prod_cat_ver&#x3D;2#types) prices for a specific plan-item price. This set consists of all the addon-item prices that can be applied to a subscription having the plan-item price. When determining this set, Chargebee considers the following:
-
-* the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price
-* the [compatibility](subscriptions?prod_cat_ver&#x3D;2#compatibility) of the addon-item prices to the plan-item price
-
-**Note**
-
-If an addon-item price has [differential pricing](differential_prices?prod_cat_ver&#x3D;2) defined against the parent item of the plan-item price, then the pricing information in the addon-item price object returned, reflects the differential pricing.
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
         */
        
        next_offset?:string;
     }
-    export interface FindApplicableItemPricesInputParam {
+    export interface ListInputParam {
       [key : string]: any;  
       /**
-        * @description The number of resources to be returned.
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
         */
         
       limit?:number;
        
       /**
-        * @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.
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
         */
         
       offset?:string;
        
       /**
-        * @description Returns the set of all applicable [addon-item](item_prices?prod_cat_ver&#x3D;2#types) prices for a specific plan-item price. This set consists of all the addon-item prices that can be applied to a subscription having the plan-item price. When determining this set, Chargebee considers the following:
-
-* the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price
-* the [compatibility](subscriptions?prod_cat_ver&#x3D;2#compatibility) of the addon-item prices to the plan-item price
-
-**Note**
-
-If an addon-item price has [differential pricing](differential_prices?prod_cat_ver&#x3D;2) defined against the parent item of the plan-item price, then the pricing information in the addon-item price object returned, reflects the differential pricing.
-
-        */
-        
-      item_id?:string;
-       
-      /**
-        * @description Returns the set of all applicable [addon-item](item_prices?prod_cat_ver&#x3D;2#types) prices for a specific plan-item price. This set consists of all the addon-item prices that can be applied to a subscription having the plan-item price. When determining this set, Chargebee considers the following:
-
-* the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price
-* the [compatibility](subscriptions?prod_cat_ver&#x3D;2#compatibility) of the addon-item prices to the plan-item price
-
-**Note**
-
-If an addon-item price has [differential pricing](differential_prices?prod_cat_ver&#x3D;2) defined against the parent item of the plan-item price, then the pricing information in the addon-item price object returned, reflects the differential pricing.
-
-        */
-        
-      sort_by?:{asc?:'updated_at' | 'name' | 'id',desc?:'updated_at' | 'name' | 'id'};
-    }
-    export interface ListResponse {  
-      /**
-        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
-
-        */
-       
-       list:{item_price:ItemPrice}[];
-       
-      /**
-        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
-
-        */
-       
-       next_offset?:string;
-    }
-    export interface ListInputParam {
-      [key : string]: any;  
-      /**
-        * @description The number of resources to be returned.
-
-        */
-        
-      limit?:number;
-       
-      /**
-        * @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 Filter item prices based on their [id](#).
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
         */
         
       id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Filter item prices based on their &#x60;name&#x60;s.
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
         */
         
       name?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Filter item prices based on their &#x60;pricing_model&#x60;.
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
         */
         
       pricing_model?:{in?:string,is?:'volume' | 'per_unit' | 'tiered' | 'flat_fee' | 'stairstep',is_not?:'volume' | 'per_unit' | 'tiered' | 'flat_fee' | 'stairstep',not_in?:string};
        
       /**
-        * @description Filter item prices based on their &#x60;item_id&#x60;.
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
         */
         
       item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Filter item prices based on &#x60;item_family_id&#x60;.
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
         */
         
       item_family_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Filter item prices based on &#x60;item_type&#x60;.
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
         */
         
       item_type?:{in?:string,is?:'charge' | 'addon' | 'plan',is_not?:'charge' | 'addon' | 'plan',not_in?:string};
        
       /**
-        * @description Filter item prices based on their &#x60;currency_code&#x60;.
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
         */
         
       currency_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Filter item prices based on their &#x60;trial_period&#x60;.
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
         */
         
       trial_period?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
        
       /**
-        * @description Filter item prices based on their &#x60;trial_period_unit&#x60;.
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
         */
         
       trial_period_unit?:{in?:string,is?:'month' | 'day',is_not?:'month' | 'day',not_in?:string};
        
       /**
-        * @description Filter item prices based on their &#x60;status&#x60;.
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
         */
         
       status?:{in?:string,is?:'archived' | 'deleted' | 'active',is_not?:'archived' | 'deleted' | 'active',not_in?:string};
        
       /**
-        * @description Filter item prices based on their &#x60;updated_at&#x60;.
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
         */
         
       updated_at?:{after?:string,before?:string,between?:string,on?:string};
        
       /**
-        * @description Filter item prices based on their &#x60;period_unit&#x60;.
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
         */
         
       period_unit?:{in?:string,is?:'week' | 'month' | 'year' | 'day',is_not?:'week' | 'month' | 'year' | 'day',not_in?:string};
        
       /**
-        * @description Filter item prices based on their &#x60;period&#x60;.
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
         */
         
       period?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string};
        
       /**
-        * @description The subscription channel this object originated from and is maintained in.
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
         */
         
@@ -781,221 +890,156 @@ If an addon-item price has [differential pricing](differential_prices?prod_cat_v
         
       sort_by?:{asc?:'updated_at' | 'name' | 'id',desc?:'updated_at' | 'name' | 'id'};
     }
-    export interface CreateResponse {  
+    export interface DeleteResponse {  
        item_price:ItemPrice;
     }
-    export interface CreateInputParam {
-      [key : string] : any;  
+    
+    export interface FindApplicableItemsResponse {  
       /**
-        * @description The identifier for the item price. It is unique and immutable.
+        * @description Returns the set of all applicable [addon-items](items?prod_cat_ver&#x3D;2#addon-items) for a specific [plan-item price](item_prices?prod_cat_ver&#x3D;2#types). This set consists of all addon-items whose item prices can be applied to a subscription having the plan-item price in it. When determining this set, Chargebee considers the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price.
 
         */
        
-      id:string;
+       list:{item:Item}[];
        
       /**
-        * @description A unique display name for the item price in the Chargebee UI. If &#x60;external_name&#x60; is not provided, this is also used in customer-facing pages and documents such as [invoices](./invoices?prod_cat_ver&#x3D;2) and [hosted pages](hosted_pages?prod_cat_ver&#x3D;2).
+        * @description Returns the set of all applicable [addon-items](items?prod_cat_ver&#x3D;2#addon-items) for a specific [plan-item price](item_prices?prod_cat_ver&#x3D;2#types). This set consists of all addon-items whose item prices can be applied to a subscription having the plan-item price in it. When determining this set, Chargebee considers the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price.
 
         */
        
-      name:string;
-       
+       next_offset?:string;
+    }
+    export interface FindApplicableItemsInputParam {
+      [key : string]: any;  
       /**
-        * @description Description of the item price.
+        * @description Returns the set of all applicable [addon-items](items?prod_cat_ver&#x3D;2#addon-items) for a specific [plan-item price](item_prices?prod_cat_ver&#x3D;2#types). This set consists of all addon-items whose item prices can be applied to a subscription having the plan-item price in it. When determining this set, Chargebee considers the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price.
 
         */
-       
-      description?:string;
+        
+      limit?:number;
        
       /**
-        * @description The id of the item that the item price belongs to.
+        * @description Returns the set of all applicable [addon-items](items?prod_cat_ver&#x3D;2#addon-items) for a specific [plan-item price](item_prices?prod_cat_ver&#x3D;2#types). This set consists of all addon-items whose item prices can be applied to a subscription having the plan-item price in it. When determining this set, Chargebee considers the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price.
 
         */
-       
-      item_id:string;
+        
+      offset?:string;
        
       /**
-        * @description A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices#invoice_notes) displayed on the invoice PDF.
+        * @description Returns the set of all applicable [addon-items](items?prod_cat_ver&#x3D;2#addon-items) for a specific [plan-item price](item_prices?prod_cat_ver&#x3D;2#types). This set consists of all addon-items whose item prices can be applied to a subscription having the plan-item price in it. When determining this set, Chargebee considers the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price.
 
         */
-       
-      invoice_notes?:string;
-       
+        
+      sort_by?:{asc?:'updated_at' | 'name' | 'id',desc?:'updated_at' | 'name' | 'id'};
+    }
+    export interface FindApplicableItemPricesResponse {  
       /**
-        * @description The name of the item price used in customer-facing pages and documents. These include [invoices](./invoices?prod_cat_ver&#x3D;2) and [hosted pages](hosted_pages?prod_cat_ver&#x3D;2). If not provided, then &#x60;name&#x60; is used.
+        * @description Returns the set of all applicable [addon-item](item_prices?prod_cat_ver&#x3D;2#types) prices for a specific plan-item price. This set consists of all the addon-item prices that can be applied to a subscription having the plan-item price. When determining this set, Chargebee considers the following:
 
-        */
-       
-      external_name?:string;
-       
-      /**
-        * @description The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)) for the item price. Is required when multiple currencies have been enabled.
+* the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price
+* the [compatibility](subscriptions?prod_cat_ver&#x3D;2#compatibility) of the addon-item prices to the plan-item price
 
-        */
-       
-      currency_code?:string;
-       
-      /**
-        * @description Specifies whether taxes apply to this item price. This value is set and returned even if [Taxes](https://www.chargebee.com/docs/tax.html) have been disabled in Chargebee. However, the value is effective only while Taxes are enabled.
+**Note**
 
-        */
-       
-      is_taxable?:boolean;
-       
-      /**
-        * @description Free quantity the subscriptions of this item_price will have. Only the quantity more than this will be charged for the subscription.
+If an addon-item price has [differential pricing](differential_prices?prod_cat_ver&#x3D;2) defined against the parent item of the plan-item price, then the pricing information in the addon-item price object returned, reflects the differential pricing.
 
         */
        
-      free_quantity?:number;
+       list:{item_price:ItemPrice}[];
        
       /**
-        * @description The quantity of the item that is available free-of-charge, represented in decimal. When a subscription is created for this plan or when the plan of a subscription is changed to this one, only the quantity above this number is charged for. Applicable for quantity-based plans and only when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
+        * @description Returns the set of all applicable [addon-item](item_prices?prod_cat_ver&#x3D;2#types) prices for a specific plan-item price. This set consists of all the addon-item prices that can be applied to a subscription having the plan-item price. When determining this set, Chargebee considers the following:
 
-        */
-       
-      free_quantity_in_decimal?:string;
-       
-      /**
-        * @description A set of key-value pairs stored as additional information for the item price. [Learn more](./#meta_data).
+* the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price
+* the [compatibility](subscriptions?prod_cat_ver&#x3D;2#compatibility) of the addon-item prices to the plan-item price
 
-        */
-       
-      metadata?:object;
-       
-      /**
-        * @description Whether the item price&#x27;s description should be shown on [invoice PDFs](/docs/api/invoices#retrieve_invoice_as_pdf). If this Boolean is changed, only invoices generated (or [regenerated](https://www.chargebee.com/docs/invoice-operations.html#actions-for-payment-due-not-paid-invoices_regenerate-invoice)) after the change are affected; past invoices are not.
+**Note**
 
-        */
-       
-      show_description_in_invoices?:boolean;
-       
-      /**
-        * @description Whether the item price&#x27;s description should be shown on [quote PDFs](/docs/api/quotes#retrieve_quote_as_pdf). If this Boolean is changed, only quotes created after the change are affected; past quotes are not.
+If an addon-item price has [differential pricing](differential_prices?prod_cat_ver&#x3D;2) defined against the parent item of the plan-item price, then the pricing information in the addon-item price object returned, reflects the differential pricing.
 
         */
        
-      show_description_in_quotes?:boolean;
-       
+       next_offset?:string;
+    }
+    export interface FindApplicableItemPricesInputParam {
+      [key : string]: any;  
       /**
-        * @description The [pricing scheme](https://www.chargebee.com/docs/2.0/plans.html#pricing-models) for this item price. If subscriptions, invoices or [differential prices](./differential_prices?prod_cat_ver&#x3D;2) exist for this item price, &#x60;pricing_model&#x60; cannot be changed.
-\* tiered - The per unit price is based on the tier that the total quantity falls in.
-\* per_unit - A fixed price per unit quantity.
-\* flat_fee - A fixed price that is not quantity-based.
-\* volume - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers.
-\* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
+        * @description Returns the set of all applicable [addon-item](item_prices?prod_cat_ver&#x3D;2#types) prices for a specific plan-item price. This set consists of all the addon-item prices that can be applied to a subscription having the plan-item price. When determining this set, Chargebee considers the following:
 
-        */
-       
-      pricing_model?:PricingModel;
-       
-      /**
-        * @description The cost of the item price when the pricing model is &#x60;flat_fee&#x60;. When the pricing model is &#x60;per_unit&#x60;, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in the [minor unit of the currency](https://apidocs.chargebee.com/docs/api#handling_currency_units).
+* the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price
+* the [compatibility](subscriptions?prod_cat_ver&#x3D;2#compatibility) of the addon-item prices to the plan-item price
 
-        */
-       
-      price?:number;
-       
-      /**
-        * @description The price of the item when the pricing_model is &#x60;flat_fee&#x60;. When the pricing model is &#x60;per_unit&#x60;, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
+**Note**
 
-        */
-       
-      price_in_decimal?:string;
-       
-      /**
-        * @description The unit of time for &#x60;period&#x60;. If subscriptions or invoices exist for this item price, &#x60;period_unit&#x60; cannot be changed. The &#x60;period_unit&#x60; is mandatory when the item &#x60;type&#x60; is &#x60;plan&#x60; or &#x60;addon&#x60;. \* month - A period of 1 calendar month. \* week - A period of 7 days. \* year - A period of 1 calendar year. \* day - A period of 24 hours.
+If an addon-item price has [differential pricing](differential_prices?prod_cat_ver&#x3D;2) defined against the parent item of the plan-item price, then the pricing information in the addon-item price object returned, reflects the differential pricing.
 
         */
-       
-      period_unit?:'week' | 'month' | 'year' | 'day';
+        
+      limit?:number;
        
       /**
-        * @description 
-
-* When the item &#x60;type&#x60; is &#x60;plan&#x60;: The billing period of the plan in &#x60;period_unit&#x60;s. For example, create a 6 month plan by providing &#x60;period&#x60; as 6 and &#x60;period_unit&#x60; as month.
-* When item &#x60;type&#x60; is &#x60;addon&#x60;: The period of the addon in &#x60;period_unit&#x60;s. For example, create an addon with a 2 month &#x60;period&#x60; by providing period as 2 and &#x60;period_unit&#x60; as &#x60;month&#x60;. The period of an addon is the duration for which its &#x60;price&#x60; applies. When attached to a plan, the addon is billed for the billing period of the plan. [Learn more.](https://www.chargebee.com/docs/2.0/addons-billingcycle.html)
+        * @description Returns the set of all applicable [addon-item](item_prices?prod_cat_ver&#x3D;2#types) prices for a specific plan-item price. This set consists of all the addon-item prices that can be applied to a subscription having the plan-item price. When determining this set, Chargebee considers the following:
 
+* the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price
+* the [compatibility](subscriptions?prod_cat_ver&#x3D;2#compatibility) of the addon-item prices to the plan-item price
 
+**Note**
 
-If subscriptions or invoices exist for this item price, &#x60;period&#x60; cannot be changed. The &#x60;period&#x60; is mandatory when the item &#x60;type&#x60; is &#x60;plan&#x60; or &#x60;addon&#x60;.
+If an addon-item price has [differential pricing](differential_prices?prod_cat_ver&#x3D;2) defined against the parent item of the plan-item price, then the pricing information in the addon-item price object returned, reflects the differential pricing.
 
         */
-       
-      period?:number;
+        
+      offset?:string;
        
       /**
-        * @description The unit of time for &#x60;trial_period&#x60;. \* month - A period of 1 calendar month. \* day - A period of 24 hours.
+        * @description Returns the set of all applicable [addon-item](item_prices?prod_cat_ver&#x3D;2#types) prices for a specific plan-item price. This set consists of all the addon-item prices that can be applied to a subscription having the plan-item price. When determining this set, Chargebee considers the following:
 
-        */
-       
-      trial_period_unit?:'month' | 'day';
-       
-      /**
-        * @description The trial period of the plan in &#x60;trial_period_unit&#x60;s. You can also set [trial periods for addons](https://www.chargebee.com/docs/2.0/addons-trial.html); contact [Support](https://chargebee.freshdesk.com/support/home) to enable that feature.
+* the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price
+* the [compatibility](subscriptions?prod_cat_ver&#x3D;2#compatibility) of the addon-item prices to the plan-item price
 
-        */
-       
-      trial_period?:number;
-       
-      /**
-        * @description Defines the shipping frequency. Example: to bill customer every 2 weeks, provide &quot;2&quot; here.
+**Note**
 
-        */
-       
-      shipping_period?:number;
-       
-      /**
-        * @description Defines the shipping frequency in association with shipping period. \* day - A period of 24 hours. \* week - A period of 7 days. \* year - A period of 1 calendar year. \* month - A period of 1 calendar month.
+If an addon-item price has [differential pricing](differential_prices?prod_cat_ver&#x3D;2) defined against the parent item of the plan-item price, then the pricing information in the addon-item price object returned, reflects the differential pricing.
 
         */
-       
-      shipping_period_unit?:'week' | 'month' | 'year' | 'day';
+        
+      item_id?:string;
        
       /**
-        * @description The default number of billing cycles a subscription to the plan must run. Can be [overridden](./subscriptions?prod_cat_ver&#x3D;2) for a subscription.
+        * @description Returns the set of all applicable [addon-item](item_prices?prod_cat_ver&#x3D;2#types) prices for a specific plan-item price. This set consists of all the addon-item prices that can be applied to a subscription having the plan-item price. When determining this set, Chargebee considers the following:
 
-Addons can also [have billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html). However, you must contact [Support](https://chargebee.freshdesk.com/support/home) to enable that. Also, for addons, you can [override this](./attached_items?prod_cat_ver&#x3D;2) while attaching it to a plan. However, if you provide the value while [applying the addon to a subscription](./subscriptions?prod_cat_ver&#x3D;2#subscription_subscription_items_item_type), then that value takes still higher precedence.
-If subscriptions, invoices or [differential prices](./differential_prices?prod_cat_ver&#x3D;2) exist for this item price, &#x60;billing_cycles&#x60; cannot be changed.
+* the [item_applicability](items?prod_cat_ver&#x3D;2#item_item_applicability) and [applicable_items](items?prod_cat_ver&#x3D;2#item_applicable_items) defined for the parent item of the plan-item price
+* the [compatibility](subscriptions?prod_cat_ver&#x3D;2#compatibility) of the addon-item prices to the plan-item price
 
-        */
-       
-      billing_cycles?:number;
-       
-      /**
-        * @description Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/trial_periods.html#how-to-define-the-end-of-trial-actions-for-subscriptions) has been enabled for the site. Specifies the operation to be carried out for the subscription once the trial ends. Whenever the &#x60;item.type&#x60; is &#x60;plan&#x60; and a trial period is defined for this item price, this attribute (parameter) is returned (required). This can be overridden at the [subscription-level](subscriptions?prod_cat_ver&#x3D;2#subscription_trial_end_action). \* cancel_subscription - The subscription cancels. \* activate_subscription - The subscription activates and charges are raised for non-metered items. \* site_default - The action [configured for the site](https://www.chargebee.com/docs/trial_periods.html#how-to-define-the-end-of-trial-actions-for-subscriptions) at the time when the trial ends, takes effect.
+**Note**
 
-        */
-       
-      trial_end_action?:'activate_subscription' | 'cancel_subscription' | 'site_default';
-       
-      /**
-        * @description Parameters for tax_detail
+If an addon-item price has [differential pricing](differential_prices?prod_cat_ver&#x3D;2) defined against the parent item of the plan-item price, then the pricing information in the addon-item price object returned, reflects the differential pricing.
 
         */
-       
-      tax_detail?:{avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_tax_code?:string,avalara_transaction_type?:number,hsn_code?:string,tax_profile_id?:string,taxjar_product_code?:string};
-       
-      /**
-        * @description Parameters for accounting_detail
+        
+      sort_by?:{asc?:'updated_at' | 'name' | 'id',desc?:'updated_at' | 'name' | 'id'};
+    }
+    export interface Tier {  
+         /**
+          * @description The lower limit of a range of units for the tier
 
-        */
+          */
        
-      accounting_detail?:{accounting_category1?:string,accounting_category2?:string,accounting_category3?:string,accounting_category4?:string,accounting_code?:string,sku?:string};
+      starting_unit:number;
        
-      /**
-        * @description Parameters for tiers
+         /**
+          * @description The upper limit of a range of units for the tier
 
-        */
-       
-      tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
-    }
-    export interface Tier {  
-      starting_unit?:number;
+          */
        
       ending_unit?:number;
        
-      price?:number;
+         /**
+          * @description The per-unit price for the tier when the &#x60;pricing_model&#x60; is &#x60;tiered&#x60; or &#x60;volume&#x60;; the total cost for the item price when the &#x60;pricing_model&#x60; is &#x60;stairstep&#x60;. The value is in the [minor unit of the currency](https://apidocs.chargebee.com/docs/api#handling_currency_units).
+
+          */
+       
+      price:number;
        
       starting_unit_in_decimal?:string;
        
@@ -1033,7 +1077,7 @@ If subscriptions, invoices or [differential prices](./differential_prices?prod_c
       avalara_service_type?:number;
        
          /**
-          * @description The [Avalara tax codes](https://taxcode.avatax.avalara.com) for the item price. Applicable only if you use [AvaTax for Sales integration](https://www.chargebee.com/docs/2.0/avalara-for-sales.html).
+          * @description The [Avalara tax codes](https://taxcode.avatax.avalara.com) for the item price. Applicable only if you use [AvaTax for Sales integration](https://www.chargebee.com/docs/2.0/avatax-for-sales.html).
 
           */
        
@@ -1043,7 +1087,7 @@ If subscriptions, invoices or [differential prices](./differential_prices?prod_c
           * @description The [HSN code](https://cbic-gst.gov.in/gst-goods-services-rates.html) to which the item is mapped for calculating the customer&#x27;s tax in India. Applicable only when both of the following conditions are true:
 
 * **[India](https://www.chargebee.com/docs/indian-gst.html#configuring-indian-gst)** has been enabled as a **Tax Region**. (An error is returned when this condition is not true.)
-* The [**AvaTax for Sales** integration](\&quot;https://www.chargebee.com/docs/avalara.html\&quot;) has been enabled in Chargebee.
+* The [**AvaTax for Sales** integration](https://www.chargebee.com/docs/avalara.html) has been enabled in Chargebee.
 
           */