chargebee 2.26.1 → 2.28.0

package/types/resources/Estimate.d.ts

@@ -247,27 +247,6 @@ In the response,
       advance_invoice_estimate(subscription_id:string, input?:AdvanceInvoiceEstimateInputParam):ChargebeeRequest<AdvanceInvoiceEstimateResponse>;
     }
     export interface RenewalEstimateResponse {  
-      /**
-        * @description This returns an estimate of the amount that will be charged when the subscription is billed next. The estimate is calculated based on the current recurring items of the subscription - plan, addons, and coupons.
-
-In the response,
-
-* **estimate.subscription_estimate** has the current subscription details like its status, next billing date, and so on.
-* **estimate.invoice_estimate** has details of the invoice that will be generated at the next billing date.
-
-  The generated invoice estimate will include all the balances - [Promotional Credits](https://www.chargebee.com/docs/promotional-credits.html), Refundable Credits, and Excess Payments - if any. If you don&#x27;t want these balances to be included you can specify &#x27;false&#x27; for the parameter *use_existing_balances*.
-
-  To exclude the [delayed charges](https://www.chargebee.com/docs/charges.html) from the invoice estimate, specify &#x27;false&#x27; for the parameter *include_delayed_charges*.
-
-**Note:**
-
-* This API will not generate a renewal invoice if an [advance invoice](https://www.chargebee.com/docs/advance-invoices.html) is already present for the subscription.
-* For &#x27;Non Renewing&#x27; subscriptions, only the [delayed charges](https://www.chargebee.com/docs/charges.html) will be included in the invoice estimate.
-* This API is not supported for &#x27;Cancelled&#x27; subscriptions.
-* Only the subscription&#x27;s charges will be included. If you have enabled the Consolidated invoicing feature, use the *Upcoming Invoices* estimate available for the Customer object to get the actual estimate invoice for the customer.
-
-        */
-       
        estimate:Estimate;
     }
     export interface RenewalEstimateInputParam {
@@ -365,26 +344,6 @@ In the response,
       ignore_scheduled_changes?:boolean;
     }
     export interface CreateSubItemEstimateResponse {  
-      /**
-        * @description Generates an estimate for creating a subscription when the customer does not exist in Chargebee. This estimate API can be called when the customer has not yet signed up and you want to preview how a new subscription would look like for them.
-
-**Note:** Estimate operations do not make any changes in Chargebee; hence this API does not create an actual &#x60;customer&#x60; or &#x60;subscription&#x60; record.  
-**See also**
-
-* [Estimate a purchase](https://apidocs.chargebee.com/docs/api/purchases#estimates_for_purchase): an operation that estimates a &#x60;purchase&#x60; representing multiple subscriptions bought together by a customer.
-
-The response contains one or more of the following objects:
-
-* &#x60;subscription_estimate&#x60;: The subscription details like the status of the subscription (such as &#x60;in_trial&#x60; or &#x60;active&#x60;), next billing date, and so on.
-* &#x60;invoice_estimate&#x60;:The details of the immediate invoice, if there is one. If the subscription is created in &#x60;trial&#x60;/&#x60;future&#x60; states, &#x60;invoice_estimate&#x60; is unavailable as no immediate invoice is generated.
-* &#x60;next_invoice_estimate&#x60;:This is returned when an immediate invoice is not generated. It contains the details of the invoice that will be generated on the next billing date of the subscription.
-* &#x60;unbilled_charge_estimates&#x60;: This contains the details of charges that have not been invoiced. This is returned only if the &#x60;invoice_immediately&#x60; parameter is set to &#x60;false&#x60;.
-
-
-
-
-        */
-       
        estimate:Estimate;
     }
     export interface CreateSubItemEstimateInputParam {
@@ -503,11 +462,6 @@ The response contains one or more of the following objects:
       item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
     }
     export interface CancelSubscriptionForItemsResponse {  
-      /**
-        * @description This creates an estimate for canceling a subscription without actually canceling it. Estimate details include canceling date, unbilled charge options, refund credit handling, the amount to be credited after cancellation, and so on.
-
-        */
-       
        estimate:Estimate;
     }
     export interface CancelSubscriptionForItemsInputParam {
@@ -604,22 +558,6 @@ The response contains one or more of the following objects:
       subscription_items?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
     }
     export interface ResumeSubscriptionResponse {  
-      /**
-        * @description Generates an estimate for the &#x27;resume subscription&#x27; operation. This is similar to the [Resume a subscription](/docs/api/subscriptions#resume_a_subscription) API, but the subscription will not be resumed. Only an estimate for this operation is created.
-
-In the response,
-
-* **estimate.subscription_estimate** has the subscription details.
-* **estimate.invoice_estimate** has details of the invoice that will be generated immediately. This will not be present if no immediate invoice is generated for this operation. This will happen for in-term resumption^++^.   
-
-  **^++^What is an &quot;in-term resumption&quot;?**   
-  An &quot;in-term resumption&quot; is when the resumption happens within the billing term of the subscription.
-* **estimate.next_invoice_estimate** has details of the invoice that will be generated during the next billing date of this subscription. This will be present only if no immediate invoice is generated during this operation (scenario mentioned above) and this subscription has next billing.   
-
-  The generated invoice_estimate/next_invoice_estimate will include all the balances - [Promotional Credits](https://www.chargebee.com/docs/promotional-credits.html), Refundable Credits, and Excess Payments - if any.
-
-        */
-       
        estimate:Estimate;
     }
     export interface ResumeSubscriptionInputParam {
@@ -646,11 +584,6 @@ In the response,
       subscription?:{resume_date?:number};
     }
     export interface CreateInvoiceForItemsResponse {  
-      /**
-        * @description This endpoint creates an invoice estimate for non-recurring items.
-
-        */
-       
        estimate:Estimate;
     }
     export interface CreateInvoiceForItemsInputParam {
@@ -761,11 +694,6 @@ In the response,
       discounts?:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
     }
     export interface GiftSubscriptionForItemsResponse {  
-      /**
-        * @description This endpoint generates an estimate for a subscription that is intended to be a gift. The estimate provides details about the gift sender, gift recipient, address details of the recipient, and the type and details of subscription items included in the gift.
-
-        */
-       
        estimate:Estimate;
     }
     export interface GiftSubscriptionForItemsInputParam {
@@ -820,23 +748,6 @@ In the response,
       subscription_items?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string}[];
     }
     export interface UpdateSubscriptionForItemsResponse {  
-      /**
-        * @description Returns an estimate for updating a subscription.
-
-In the response,
-
-* [subscription_estimate](/docs/api/estimates#subscription_estimate_attributes): The details of the changed subscription such as &#x60;status&#x60;, next billing date, and so on.
-* [invoice_estimate](/docs/api/estimates#invoice_estimate_attributes):The details of the immediate invoice, if it is generated. An immediate invoice is not generated when:
-  * &#x60;end_of_term&#x60; parameter is true
-  * &#x60;prorate&#x60; parameter is &#x60;false&#x60;
-  * No changes are made to the plan item prices or addon item prices in &#x60;subscription_items&#x60;.
-  * For changes such as [quantity downgrades](https://www.chargebee.com/docs/proration.html#proration-mechanism_plan-quantity-downgrade-paid-invoice).
-* [next_invoice_estimate](/docs/api/estimates#next_invoice_estimate_attributes):The details of the invoice to be generated later (if any) on the occasion that no immediate invoice has been generated.
-* [credit_note_estimates](/docs/api/estimates#credit_note_estimate_attributes):The list of credit notes (if any) generated during this operation.
-* [unbilled_charge_estimates](/docs/api/estimates#unbilled_charge_estimate_attributes): The details of charges that have not been invoiced. This is returned only if the &#x60;invoice_immediately&#x60; parameter is set to &#x60;false&#x60;.
-
-        */
-       
        estimate:Estimate;
     }
     export interface UpdateSubscriptionForItemsInputParam {
@@ -1030,42 +941,10 @@ An immediate previous change was made
       item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
     }
     export interface UpcomingInvoicesEstimateResponse {  
-      /**
-        * @description Estimate of the upcoming scheduled invoices (subscription activations, renewals etc) of a customer. For now preview of the invoices generated on the immediate upcoming date is supported. Say a customer has couple of subscription renewals scheduled on *Jan,10th* and another subscription renewal scheduled on *Jan,15th* . This API gives the preview of all the invoices scheduled to be generated on *Jan,10th* (immediate upcoming date).
-
-In the response:
-
-* **estimate.invoice_estimates\[\]** has details of the invoices scheduled to be generated.
-
-**Note:** If *consolidated invoicing* is enabled you may use this API to test whether upcoming renewals are consolidated.
-
-        */
-       
        estimate:Estimate;
     }
     
     export interface RegenerateInvoiceEstimateResponse {  
-      /**
-        * @description Regenerates the invoice for the current term of the subscription. The subscription must have &#x60;status&#x60; as &#x60;active&#x60; or &#x60;non_renewing&#x60;. This operation is not allowed when any of the following conditions hold true for the subscription:
-
-* An invoice exists for the current term and its &#x60;status&#x60; is not &#x60;voided&#x60;.
-* There are [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html) for the current term.
-* The subscription has an [advance invoice](https://www.chargebee.com/docs/advance-invoices.html).
-
-
-
-#### Response
-
-Returns an &#x60;estimate&#x60; object with one of the following components depending on the value of &#x60;invoice_immediately&#x60;.
-
-* If the value is &#x60;true&#x60;: an &#x60;invoice_estimate&#x60; object that corresponds to the regenerated invoice.
-* If the value is &#x60;false&#x60;: a list of &#x60;unbilled_charge_estimate&#x60; objects corresponding to all the unbilled charges created for the current term of the subscription.
-
-
-
-
-        */
-       
        estimate:Estimate;
     }
     export interface RegenerateInvoiceEstimateInputParam {
@@ -1099,14 +978,6 @@ Returns an &#x60;estimate&#x60; object with one of the following components depe
       invoice_immediately?:boolean;
     }
     export interface CreateSubItemForCustomerEstimateResponse {  
-      /**
-        * @description Generates an estimate without creating a subscription. This endpoint can be called when you want to preview details of a new subscription before actually creating one.  
-**See also**
-
-* [Estimate a purchase](https://apidocs.chargebee.com/docs/api/purchases#estimates_for_purchase): an operation that estimates a &#x60;purchase&#x60; representing multiple subscriptions bought together by a customer.
-
-        */
-       
        estimate:Estimate;
     }
     export interface CreateSubItemForCustomerEstimateInputParam {
@@ -1211,21 +1082,6 @@ Returns an &#x60;estimate&#x60; object with one of the following components depe
       item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
     }
     export interface ChangeTermEndResponse {  
-      /**
-        * @description Generates an estimate for the &#x27;change term end&#x27; operation. This is similar to the [Change term end](/docs/api/subscriptions#change_term_end) API but the subscription&#x27;s term end will not be changed, only an estimate for this operation is created. This is applicable only for subscriptions in &#x27;in-trial&#x27;, &#x27;active&#x27; and &#x27;non-renewing&#x27; states.
-
-In the response,
-
-* **estimate.subscription_estimate** has the subscription details like the status of the subscription (in_trial, active, etc.), next billing date, and so on.
-* **estimate.invoice_estimate** has details of the invoice that will be generated immediately. This will not be present if no immediate invoice is generated for this operation. This will happen when
-  * *prorate* parameter is false, or
-  * *invoice_immediately* parameter is false, or
-  * subscription is in *in-trial* state
-* **estimate.credit_note_estimates\[\]** has details of the credit-notes that will get generated during this operation. This list will be empty if no credit-note gets generated during this operation.
-* **estimate.unbilled_charge_estimates\[\]** has details of the unbilled charges. This is returned only if *invoice_immediately* is set as false.
-
-        */
-       
        estimate:Estimate;
     }
     export interface ChangeTermEndInputParam {
@@ -1253,17 +1109,6 @@ In the response,
       invoice_immediately?:boolean;
     }
     export interface PauseSubscriptionResponse {  
-      /**
-        * @description This API provides an estimate of the details pertaining to the [pause_subscription](/docs/api/subscriptions#pause_a_subscription) operation. It returns attributes such as [pause_date](/docs/api/estimates#estimate_subscription_estimate_pause_date) and [resume_date](/docs/api/estimates#estimate_subscription_estimate_resume_date). This is similar to the [Pause a subscription](/docs/api/subscriptions#pause_a_subscription) API with the exception that the subscription is not paused. Only an estimate for this operation is created.
-
-In the response,
-
-* **estimate.subscription_estimate** has the subscription details.
-* **estimate.invoice_estimate** has details of the invoice that are generated immediately. This is not present if no immediate invoices are generated for this operation.
-* **estimate.credit_note_estimates\[\]** has details of the credit notes that are generated during this operation. This list is empty if no credit notes are generated.
-
-        */
-       
        estimate:Estimate;
     }
     export interface PauseSubscriptionInputParam {
@@ -1305,11 +1150,6 @@ If &#x60;no_action&#x60; is chosen, charges are added to the resumption invoice.
       subscription?:{pause_date?:number,resume_date?:number,skip_billing_cycles?:number};
     }
     export interface AdvanceInvoiceEstimateResponse {  
-      /**
-        * @description This API is used to generate an invoice estimate for preview. Estimate details include the number of billing cycles to be invoiced in advance, the number of billing cycles in one interval, advance invoicing schedules, and so on.
-
-        */
-       
        estimate:Estimate;
     }
     export interface AdvanceInvoiceEstimateInputParam {

package/types/resources/Event.d.ts

@@ -160,13 +160,6 @@ declare module 'chargebee' {
       sort_by?:{asc?:'occurred_at',desc?:'occurred_at'};
     }
     export interface RetrieveResponse {  
-      /**
-        * @description Retrieves a specific event identified by a unique event identifier.
-
-**Note:** Only events that are less than 90 days old will be retrieved.
-
-        */
-       
        event:Event;
     }
     

package/types/resources/Export.d.ts

@@ -158,11 +158,6 @@ declare module 'chargebee' {
       subscriptions(input?:SubscriptionsInputParam):ChargebeeRequest<SubscriptionsResponse>;
     }
     export interface CustomersResponse {  
-      /**
-        * @description This API triggers export of customer data. The exported zip file contains CSV files with customer-related data.
-
-        */
-       
        export:Export;
     }
     export interface CustomersInputParam {
@@ -200,11 +195,6 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
       relationship?:{invoice_owner_id?:{is?:string,is_not?:string,starts_with?:string},parent_id?:{is?:string,is_not?:string,starts_with?:string},payment_owner_id?:{is?:string,is_not?:string,starts_with?:string}};
     }
     export interface AttachedItemsResponse {  
-      /**
-        * @description This API triggers export of attached item data. The exported zip file contains CSV files with attached item-related data.
-
-        */
-       
        export:Export;
     }
     export interface AttachedItemsInputParam {
@@ -228,11 +218,6 @@ To filter based on the type of of the attached item. Possible values are : &#x60
       attached_item?:{charge_on_event?:{in?:string,is?:'subscription_creation' | 'subscription_activation' | 'subscription_trial_start' | 'contract_termination' | 'plan_activation' | 'on_demand',is_not?:'subscription_creation' | 'subscription_activation' | 'subscription_trial_start' | 'contract_termination' | 'plan_activation' | 'on_demand',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},parent_item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},type?:{in?:string,is?:'optional' | 'mandatory' | 'recommended',is_not?:'optional' | 'mandatory' | 'recommended',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
     }
     export interface TransactionsResponse {  
-      /**
-        * @description This API triggers export of transaction data. The exported zip file contains CSV files with transaction-related data.
-
-        */
-       
        export:Export;
     }
     export interface TransactionsInputParam {
@@ -245,11 +230,6 @@ To filter based on the type of of the attached item. Possible values are : &#x60
       transaction?:{amount?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_capturable?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},customer_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},date?:{after?:string,before?:string,between?:string,on?:string},gateway?:{in?:string,is?:'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay',is_not?:'bluepay' | 'beanstream' | 'elavon' | 'orbital' | 'hdfc' | 'nmi' | 'moneris' | 'metrics_global' | 'pin' | 'stripe' | 'quickbooks' | 'razorpay' | 'eway_rapid' | 'balanced_payments' | 'ecentric' | 'wepay' | 'chargebee_payments' | 'bank_of_america' | 'braintree' | 'first_data_global' | 'paypal_express_checkout' | 'ingenico_direct' | 'moneris_us' | 'exact' | 'migs' | 'checkout_com' | 'not_applicable' | 'paypal_pro' | 'ogone' | 'eway' | 'gocardless' | 'global_payments' | 'paymill' | 'adyen' | 'paypal' | 'chargebee' | 'authorize_net' | 'tco' | 'bluesnap' | 'windcave' | 'paypal_payflow_pro' | 'amazon_payments' | 'mollie' | 'cybersource' | 'wirecard' | 'sage_pay' | 'vantiv' | 'worldpay',not_in?:string},gateway_account_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},id_at_gateway?:{is?:string,is_not?:string,starts_with?:string},payment_method?:{in?:string,is?:'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'chargeback' | 'wechat_pay' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'sofort' | 'amazon_payments' | 'upi' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card',is_not?:'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'chargeback' | 'wechat_pay' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'sofort' | 'amazon_payments' | 'upi' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card',not_in?:string},payment_source_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},reference_number?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string},status?:{in?:string,is?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention',is_not?:'in_progress' | 'success' | 'failure' | 'voided' | 'timeout' | 'needs_attention',not_in?:string},subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},type?:{in?:string,is?:'authorization' | 'payment_reversal' | 'payment' | 'refund',is_not?:'authorization' | 'payment_reversal' | 'payment' | 'refund',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
     }
     export interface DifferentialPricesResponse {  
-      /**
-        * @description This API triggers export of differential price data. The exported zip file contains CSV files with differential price-related data.
-
-        */
-       
        export:Export;
     }
     export interface DifferentialPricesInputParam {
@@ -273,11 +253,6 @@ Item Id of Addon / Charge item price for which differential pricing is applied t
       differential_price?:{id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},item_price_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},parent_item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string}};
     }
     export interface ItemFamiliesResponse {  
-      /**
-        * @description This API triggers export of item family data. The exported zip file contains CSV files with item family-related data.
-
-        */
-       
        export:Export;
     }
     export interface ItemFamiliesInputParam {
@@ -290,11 +265,6 @@ Item Id of Addon / Charge item price for which differential pricing is applied t
       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}};
     }
     export interface InvoicesResponse {  
-      /**
-        * @description This API triggers export of invoice data. The exported zip file contains CSV files with invoice-related data.
-
-        */
-       
        export:Export;
     }
     export interface InvoicesInputParam {
@@ -318,22 +288,10 @@ Payment owner of an invoice.
       invoice?:{amount_adjusted?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_due?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_paid?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},credits_applied?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},date?:{after?:string,before?:string,between?:string,on?:string},dunning_status?:{in?:string,is?:'in_progress' | 'stopped' | 'success' | 'exhausted',is_not?:'in_progress' | 'stopped' | 'success' | 'exhausted',is_present?:'true' | 'false',not_in?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},paid_at?:{after?:string,before?:string,between?:string,on?:string},price_type?:{in?:string,is?:'tax_exclusive' | 'tax_inclusive',is_not?:'tax_exclusive' | 'tax_inclusive',not_in?:string},recurring?:{is?:'true' | 'false'},status?:{in?:string,is?:'pending' | 'paid' | 'voided' | 'not_paid' | 'posted' | 'payment_due',is_not?:'pending' | 'paid' | 'voided' | 'not_paid' | 'posted' | 'payment_due',not_in?:string},subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},total?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
     }
     export interface RetrieveResponse {  
-      /**
-        * @description This API gets the status of the export job initiated by the Exports API. If the export job is completed, the downloads resource will also be obtained in the API response. The returned URL in the downloads resource is secure and can be downloaded. The URL expires after 4 hours. Please note that this is a public URL, and can be downloaded by anyone with whom it&#x27;s shared.
-
-**Note:** In case the export is in Failed or In-process state, then the downloads resource will not be available.
-
-        */
-       
        export:Export;
     }
     
     export interface ItemsResponse {  
-      /**
-        * @description This API triggers export of item data. The exported zip file contains CSV files with item-related data.
-
-        */
-       
        export:Export;
     }
     export interface ItemsInputParam {
@@ -346,13 +304,6 @@ Payment owner of an invoice.
       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}};
     }
     export interface DeferredRevenueResponse {  
-      /**
-        * @description This API triggers export for the Deferred Revenue Report.
-
-**Note:** This API call is asynchronous. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. In case you are using any of the client libraries, use the **wait for export completion** function provided as an instance method in the library. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **WaitForExportCompletion** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes.
-
-        */
-       
        export:Export;
     }
     export interface DeferredRevenueInputParam {
@@ -490,13 +441,6 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
       relationship?:{invoice_owner_id?:{is?:string,is_not?:string,starts_with?:string},parent_id?:{is?:string,is_not?:string,starts_with?:string},payment_owner_id?:{is?:string,is_not?:string,starts_with?:string}};
     }
     export interface RevenueRecognitionResponse {  
-      /**
-        * @description This API triggers export for the revenue recognition report.
-
-**Note:** This API call is asynchronous. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. In case you are using any of the client libraries, use the **wait for export completion** function provided as an instance method in the library. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **waitForExportCompletion()** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **WaitForExportCompletion** on the returned **Export** resource which will wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes. You need to check if this operation has completed by checking if the export status is **completed** . You can do this by retrieving the export in a loop with a minimum delay of 10 secs between two retrieve requests. Use the method **wait_for_export_completion** on the returned **export** resource which wait until the export status changes.
-
-        */
-       
        export:Export;
     }
     export interface RevenueRecognitionInputParam {
@@ -634,11 +578,6 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
       relationship?:{invoice_owner_id?:{is?:string,is_not?:string,starts_with?:string},parent_id?:{is?:string,is_not?:string,starts_with?:string},payment_owner_id?:{is?:string,is_not?:string,starts_with?:string}};
     }
     export interface CreditNotesResponse {  
-      /**
-        * @description This API triggers export of credit note data. The exported zip file contains CSV files with credit note-related data.
-
-        */
-       
        export:Export;
     }
     export interface CreditNotesInputParam {
@@ -651,11 +590,6 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
       credit_note?:{amount_allocated?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_available?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},amount_refunded?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string},create_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},date?:{after?:string,before?:string,between?:string,on?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},price_type?:{in?:string,is?:'tax_exclusive' | 'tax_inclusive',is_not?:'tax_exclusive' | 'tax_inclusive',not_in?:string},reason_code?:{in?:string,is?:'other' | 'product_unsatisfactory' | 'subscription_pause' | 'order_cancellation' | 'service_unsatisfactory' | 'subscription_cancellation' | 'chargeback' | 'order_change' | 'write_off' | 'waiver' | 'subscription_change' | 'fraudulent',is_not?:'other' | 'product_unsatisfactory' | 'subscription_pause' | 'order_cancellation' | 'service_unsatisfactory' | 'subscription_cancellation' | 'chargeback' | 'order_change' | 'write_off' | 'waiver' | 'subscription_change' | 'fraudulent',not_in?:string},reference_invoice_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},status?:{in?:string,is?:'refund_due' | 'adjusted' | 'refunded' | 'voided',is_not?:'refund_due' | 'adjusted' | 'refunded' | 'voided',not_in?:string},subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},total?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},type?:{in?:string,is?:'adjustment' | 'refundable',is_not?:'adjustment' | 'refundable',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string},voided_at?:{after?:string,before?:string,between?:string,on?:string}};
     }
     export interface CouponsResponse {  
-      /**
-        * @description This API triggers export of coupon data. The exported zip file contains CSV files with coupon-related data.
-
-        */
-       
        export:Export;
     }
     export interface CouponsInputParam {
@@ -679,11 +613,6 @@ The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-cu
       coupon?:{apply_on?:{in?:string,is?:'invoice_amount' | 'each_specified_item',is_not?:'invoice_amount' | 'each_specified_item',not_in?:string},created_at?:{after?:string,before?:string,between?:string,on?:string},discount_type?:{in?:string,is?:'fixed_amount' | 'percentage',is_not?:'fixed_amount' | 'percentage',not_in?:string},duration_type?:{in?:string,is?:'limited_period' | 'one_time' | 'forever',is_not?:'limited_period' | 'one_time' | 'forever',not_in?: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?:'archived' | 'expired' | 'deleted' | 'active',is_not?:'archived' | 'expired' | 'deleted' | 'active',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
     }
     export interface OrdersResponse {  
-      /**
-        * @description This API triggers export of order data. The exported zip file contains CSV files with order-related data.
-
-        */
-       
        export:Export;
     }
     export interface OrdersInputParam {
@@ -707,11 +636,6 @@ Total amount charged for the order.
       order?:{amount_paid?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},cancelled_at?:{after?:string,before?:string,between?:string,on?:string},customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},delivered_at?:{after?:string,before?:string,between?:string,on?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},is_resent?:{is?:'true' | 'false'},order_date?:{after?:string,before?:string,between?:string,on?:string},original_order_id?:{is?:string,is_not?:string,starts_with?:string},price_type?:{in?:string,is?:'tax_exclusive' | 'tax_inclusive',is_not?:'tax_exclusive' | 'tax_inclusive',not_in?:string},refundable_credits?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},refundable_credits_issued?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,lt?:string,lte?:string},resent_status?:{in?:string,is?:'fully_resent' | 'partially_resent',is_not?:'fully_resent' | 'partially_resent',not_in?:string},shipped_at?:{after?:string,before?:string,between?:string,on?:string},shipping_date?:{after?:string,before?:string,between?:string,on?:string},status?:{in?:string,is?:'new' | 'partially_delivered' | 'queued' | 'delivered' | 'on_hold' | 'shipped' | 'processing' | 'cancelled' | 'voided' | 'complete' | 'awaiting_shipment' | 'returned',is_not?:'new' | 'partially_delivered' | 'queued' | 'delivered' | 'on_hold' | 'shipped' | 'processing' | 'cancelled' | 'voided' | 'complete' | 'awaiting_shipment' | 'returned',not_in?:string},subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
     }
     export interface ItemPricesResponse {  
-      /**
-        * @description This API triggers export of item price data. The exported zip file contains CSV files with item price-related data.
-
-        */
-       
        export:Export;
     }
     export interface ItemPricesInputParam {
@@ -757,11 +681,6 @@ Filter item prices based on their &#x60;currency_code&#x60;.
       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}};
     }
     export interface SubscriptionsResponse {  
-      /**
-        * @description This API triggers export of subscription data. The exported zip file contains CSV files with subscription-related data.
-
-        */
-       
        export:Export;
     }
     export interface SubscriptionsInputParam {

package/types/resources/Feature.d.ts

@@ -227,11 +227,6 @@ However, changing `levels[]` to the state shown below is not permissib
       type?:{in?:string,is?:'quantity' | 'custom' | 'range' | 'switch',is_not?:'quantity' | 'custom' | 'range' | 'switch',not_in?:string};
     }
     export interface CreateResponse {  
-      /**
-        * @description Creates a new feature and optionally defines the <item_entitlements> for it.
-
-        */
-       
        feature:Feature;
     }
     export interface CreateInputParam {
@@ -287,63 +282,14 @@ However, changing `levels[]` to the state shown below is not permissib
       levels?:{is_unlimited?:boolean,level?:number,name?:string,value?:string}[];
     }
     export interface DeleteResponse {  
-      /**
-        * @description Deletes a feature. Any item entitlements and subscription entitlements defined for the feature are also removed. This action is not permissible when the `status` of the feature is `active`.
-
-        */
-       
        feature:Feature;
     }
     
     export interface RetrieveResponse {  
-      /**
-        * @description Retrieve a specific feature using its id.
-
-        */
-       
        feature:Feature;
     }
     
     export interface UpdateResponse {  
-      /**
-        * @description Updates a specific feature.  
-**Note**
-
-The list of objects `levels[]` provided as part of this operation fully replaces the existing list of objects [levels[]](features#feature_levels) of the feature.
-
-### Considerations when modifying `levels` {#considerations}
-
-This section describes validations that are performed by Chargebee when modifying the `levels` list of objects for the feature, using this operation.
-
-#### Adding `levels` {#adding}
-
-Adding a new object to the `levels[]` list is allowed if and only if the feature [type](features#feature_type) is `quantity` or `custom`
-
-#### Removing `levels` {#removing}
-
-Removing an existing object in the `levels[]` list is not allowed if the `value` for that object is currently mapped to one or more [item_entitlement](item_entitlements)s or [subscription_entitlement](subscription_entitlements)s.
-
-#### Reordering `levels` {#reorder}
-
-**Note**
-
-The validation described in this section is only applicable for features of `type` `custom`
-
-If any of `levels[].value` are currently mapped to `item_entitlement`s or `subscription_entitlement`s, then the relative order of the corresponding `levels[].level` must be preserved when invoking this operation.
-
-For example, consider that the `levels[]` list is currently in the state shown below. (For brevity, only the `value` and `level` key are shown here and the JSONs have been compacted.)  
-` {"levels":[{"value":"email-basic","level":0},{"value":"email-rise","level":1},{"value":"email-advanced","level":2},{"value":"email-pro","level":3},{"value":"email-scale","level":4}]} `
-
-Now consider that `email-rise`, `email-advanced`, and `email-pro` have already been mapped to `item_entitlement`s or `subscription_entitlement`s. As seen in the above object, the relative order of `levels[].level` is such that `email-rise` \< `email-advanced` \< `email-pro`.
-
-Invoking this API to change `levels[]` to the state below is allowed since the relative order of `level` corresponding to `email-rise`, `email-advanced`, and `email-pro` has been preserved.  
-` {"levels":[{"value":"email-basic","level":0},{"value":"email-rise","level":1},{"value":"email-scale","level":2},{"value":"email-advanced","level":3},{"value":"email-pro","level":4}]} `
-
-However, changing `levels[]` to the state shown below is not permissible because the `level` of `email-advanced` is provided as greater than the `level` of `email-pro`, thereby disrupting the original order.  
-` {"levels":[{"value":"email-basic","level":0},{"value":"email-rise","level":1},{"value":"email-pro","level":2},{"value":"email-advanced","level":3},{"value":"email-scale","level":4}]} `
-
-        */
-       
        feature:Feature;
     }
     export interface UpdateInputParam {
@@ -385,29 +331,14 @@ However, changing `levels[]` to the state shown below is not permissib
       levels?:{is_unlimited?:boolean,level?:number,name?:string,value?:string}[];
     }
     export interface ArchiveResponse {  
-      /**
-        * @description Archives an `active` feature so that no **new** [item](item_entitlements) or [subscription entitlements](subscription_entitlements) can be created towards the feature. Any pre-existing item or subscription entitlements from the time that the feature was `active` remain effective. This operation changes the [status](features#feature_status) of the feature to `archived`. The feature `status` must be `active` when calling this endpoint.
-
-        */
-       
        feature:Feature;
     }
     
     export interface ActivateResponse {  
-      /**
-        * @description Activates a `draft` feature so that any [item](item_entitlements) or [subscription entitlements](subscription_entitlements) defined towards it take effect immediately. This operation changes the [status](features#feature_status) of the feature to `active`. The feature `status` must be `draft` when calling this endpoint.
-
-        */
-       
        feature:Feature;
     }
     
     export interface ReactivateResponse {  
-      /**
-        * @description Reactivates an archived feature so that **new** [item](item_entitlements) or [subscription entitlements](subscription_entitlements) can be created towards the feature. This operation changes the [status](features#feature_status) of the feature to `active`. The feature `status` must be `archived` when calling this endpoint.
-
-        */
-       
        feature:Feature;
     }