chargebee 2.28.0 → 2.30.0

package/types/resources/UnbilledCharge.d.ts

@@ -45,7 +45,7 @@ declare module 'chargebee' {
     unit_amount?:number;
     
     /**
-      * @description The pricing scheme for this line item. \* tiered - The per unit price is based on the tier that the total quantity falls in. \* volume - There are quantity tiers for which per unit prices are set. Quantities are purchased from successive tiers. \* per_unit - A fixed price per unit quantity. \* flat_fee - A fixed price that is not quantity-based. \* stairstep - A quantity-based pricing scheme. The item is charged a fixed price based on the tier that the total quantity falls in.
+      * @description The pricing scheme for this line item. \* 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.
 
       */
     
@@ -87,7 +87,7 @@ declare module 'chargebee' {
     description?:string;
     
     /**
-      * @description Specifies the modelled entity this line item is based on. \* plan_setup - Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/plans#plan_attributes) id \* charge_item_price - Indicates that this line item is based on charge Item Price \* plan - Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/plans#plan_attributes) id \* addon_item_price - Indicates that this line item is based on addon Item Price \* plan_item_price - Indicates that this line item is based on plan Item Price \* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case \* addon - Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/addons#addon_attributes) id
+      * @description Specifies the modelled entity this line item is based on. \* plan_setup - Indicates that this lineitem is based on 'Plan Setup' charge. The 'entity_id' attribute specifies the [plan](/docs/api/plans#plan_attributes) id \* plan - Indicates that this lineitem is based on 'Plan' entity. The 'entity_id' attribute specifies the [plan](/docs/api/plans#plan_attributes) id \* addon_item_price - Indicates that this line item is based on addon Item Price \* plan_item_price - Indicates that this line item is based on plan Item Price \* adhoc - Indicates that this lineitem is not modelled. i.e created adhoc. So the 'entity_id' attribute will be null in this case \* addon - Indicates that this lineitem is based on 'Addon' entity. The 'entity_id' attribute specifies the [addon](/docs/api/addons#addon_attributes) id \* charge_item_price - Indicates that this line item is based on charge Item Price
 
       */
     
@@ -142,6 +142,11 @@ declare module 'chargebee' {
     
     updated_at:number;
     
+    /**
+      * @description The value of this parameter will be true if it is a recurring unbilled charge for a future term.
+
+      */
+    
     is_advance_charge?:boolean;
     
     /**
@@ -161,30 +166,11 @@ declare module 'chargebee' {
   export namespace UnbilledCharge {
     export class UnbilledChargeResource {  
       /**
-        * @description Use this API to delete an unbilled charge by specifying the id of the charge.
-
-        */
-      
-      delete(unbilled_charge_id:string):ChargebeeRequest<DeleteResponse>;
-       
-      /**
-        * @description This is similar to the &quot;Create an invoice for unbilled charges&quot; API but no invoice will be created, only an estimate for this operation is created.
-
-In the estimate response,
-
-* **estimate.invoice_estimates** is an array of **estimate.invoice_estimate**. This has the details of the invoices that will be generated now.
-
-**Note:**
-
-* This API when invoked does not perform the actual operation. It just generates an estimate.
-* Both *subscription_id* and *customer_id* parameters should not be given at the same time.
-
-
-
+        * @description This endpoint creates unbilled charges for a subscription.
 
         */
       
-      invoice_now_estimate(input?:InvoiceNowEstimateInputParam):ChargebeeRequest<InvoiceNowEstimateResponse>;
+      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
        
       /**
         * @description Use this API to bill the [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html). Available Credits and Excess Payments will automatically be applied while creating the invoice.
@@ -207,6 +193,13 @@ If consolidated invoicing is enabled and the parameter &#x27;customer_id&#x27; i
       
       invoice_unbilled_charges(input?:InvoiceUnbilledChargesInputParam):ChargebeeRequest<InvoiceUnbilledChargesResponse>;
        
+      /**
+        * @description Use this API to delete an unbilled charge by specifying the id of the charge.
+
+        */
+      
+      delete(unbilled_charge_id:string):ChargebeeRequest<DeleteResponse>;
+       
       /**
         * @description This endpoint lists all the unbilled charges.
 
@@ -215,34 +208,63 @@ If consolidated invoicing is enabled and the parameter &#x27;customer_id&#x27; i
       list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
        
       /**
-        * @description This endpoint creates unbilled charges for a subscription.
+        * @description This is similar to the &quot;Create an invoice for unbilled charges&quot; API but no invoice will be created, only an estimate for this operation is created.
+
+In the estimate response,
+
+* **estimate.invoice_estimates** is an array of **estimate.invoice_estimate**. This has the details of the invoices that will be generated now.
+
+**Note:**
+
+* This API when invoked does not perform the actual operation. It just generates an estimate.
+* Both *subscription_id* and *customer_id* parameters should not be given at the same time.
+
+
+
 
         */
       
-      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
-    }
-    export interface DeleteResponse {  
-       unbilled_charge:UnbilledCharge;
+      invoice_now_estimate(input?:InvoiceNowEstimateInputParam):ChargebeeRequest<InvoiceNowEstimateResponse>;
     }
-    
-    export interface InvoiceNowEstimateResponse {  
-       estimate:Estimate;
+    export interface CreateResponse {  
+       unbilled_charges:UnbilledCharge[];
     }
-    export interface InvoiceNowEstimateInputParam {
+    export interface CreateInputParam {
        
       /**
-        * @description Identifier of the subscription for which this estimate needs to be created. Should be given if &#x27;customer_id&#x27; is not specified.
+        * @description Identifier of the subscription for which this unbilled charges needs to be created.
 
         */
        
-      subscription_id?:string;
+      subscription_id:string;
        
       /**
-        * @description Identifier of the customer for whom this estimate is created. Is given if &#x27;subscription_id&#x27; is not specified. Applicable only if the &#x27;Consolidated Invoicing&#x27; is enabled. If &#x27;Consolidated Invoicing&#x27; is not enabled, an invoice will be generated for every subscription.
+        * @description The currency code (ISO 4217 format) of the unbilled_charge.
 
         */
        
-      customer_id?:string;
+      currency_code?:string;
+       
+      /**
+        * @description Parameters for item_prices
+
+        */
+       
+      item_prices?:{date_from?:number,date_to?:number,item_price_id?:string,quantity?:number,quantity_in_decimal?:string,unit_price?:number,unit_price_in_decimal?:string}[];
+       
+      /**
+        * @description Parameters for item_tiers
+
+        */
+       
+      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}[];
+       
+      /**
+        * @description Parameters for charges
+
+        */
+       
+      charges?:{amount?:number,amount_in_decimal?:string,avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_tax_code?:string,avalara_transaction_type?:number,date_from?:number,date_to?:number,description?:string,hsn_code?:string,tax_profile_id?:string,taxable?:boolean,taxjar_product_code?:string}[];
     }
     export interface InvoiceUnbilledChargesResponse {  
        invoices:Invoice[];
@@ -263,6 +285,10 @@ If consolidated invoicing is enabled and the parameter &#x27;customer_id&#x27; i
        
       customer_id?:string;
     }
+    export interface DeleteResponse {  
+       unbilled_charge:UnbilledCharge;
+    }
+    
     export interface ListResponse {  
       /**
         * @description This endpoint lists all the unbilled charges.
@@ -281,21 +307,21 @@ If consolidated invoicing is enabled and the parameter &#x27;customer_id&#x27; i
     export interface ListInputParam {
       [key : string]: any;  
       /**
-        * @description The number of resources to be returned.
+        * @description This endpoint lists all the unbilled charges.
 
         */
         
       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 This endpoint lists all the unbilled charges.
 
         */
         
       offset?:string;
        
       /**
-        * @description Indicates whether to include deleted objects in the list. The deleted objects have the attribute \&#x60;deleted\&#x60; as \&#x60;true\&#x60;.
+        * @description This endpoint lists all the unbilled charges.
 
         */
         
@@ -309,74 +335,93 @@ If consolidated invoicing is enabled and the parameter &#x27;customer_id&#x27; i
       is_voided?:boolean;
        
       /**
-        * @description A unique identifier for the subscription this charge belongs to.
+        * @description This endpoint lists all the unbilled charges.
 
         */
         
       subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string};
        
       /**
-        * @description A unique identifier for the customer being charged.
+        * @description This endpoint lists all the unbilled charges.
 
         */
         
       customer_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string};
     }
-    export interface CreateResponse {  
-       unbilled_charges:UnbilledCharge[];
+    export interface InvoiceNowEstimateResponse {  
+       estimate:Estimate;
     }
-    export interface CreateInputParam {
+    export interface InvoiceNowEstimateInputParam {
        
       /**
-        * @description Identifier of the subscription for which this unbilled charges needs to be created.
+        * @description Identifier of the subscription for which this estimate needs to be created. Should be given if &#x27;customer_id&#x27; is not specified.
 
         */
        
-      subscription_id:string;
+      subscription_id?:string;
        
       /**
-        * @description The currency code (ISO 4217 format) of the unbilled_charge.
+        * @description Identifier of the customer for whom this estimate is created. Is given if &#x27;subscription_id&#x27; is not specified. Applicable only if the &#x27;Consolidated Invoicing&#x27; is enabled. If &#x27;Consolidated Invoicing&#x27; is not enabled, an invoice will be generated for every subscription.
 
         */
        
-      currency_code?:string;
-       
-      /**
-        * @description Parameters for item_prices
+      customer_id?:string;
+    }
+    export interface LineItemTier {  
+         /**
+          * @description The lower limit of a range of units for the tier
 
-        */
+          */
        
-      item_prices?:{date_from?:number,date_to?:number,item_price_id?:string,quantity?:number,quantity_in_decimal?:string,unit_price?:number,unit_price_in_decimal?:string}[];
+      starting_unit:number;
        
-      /**
-        * @description Parameters for item_tiers
+         /**
+          * @description The upper limit of a range of units for the tier
 
-        */
+          */
        
-      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}[];
+      ending_unit?:number;
        
-      /**
-        * @description Parameters for charges
+         /**
+          * @description The number of units purchased in a range.
 
-        */
+          */
        
-      charges?:{amount?:number,amount_in_decimal?:string,avalara_sale_type?:AvalaraSaleType,avalara_service_type?:number,avalara_tax_code?:string,avalara_transaction_type?:number,date_from?:number,date_to?:number,description?:string,hsn_code?:string,tax_profile_id?:string,taxable?:boolean,taxjar_product_code?:string}[];
-    }
-    export interface LineItemTier {  
-      starting_unit?:number;
+      quantity_used:number;
        
-      ending_unit?:number;
+         /**
+          * @description The price of the tier if the charge model is a &#x60;stairtstep&#x60; pricing , or the price of each unit in the tier if the charge model is &#x60;tiered&#x60;/&#x60;volume&#x60; pricing.
+
+          */
        
-      quantity_used?:number;
+      unit_amount:number;
        
-      unit_amount?:number;
+         /**
+          * @description The decimal representation of the the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as &#x60;ending_unit_in_decimal&#x60; of the next lower tier. Returned only when the &#x60;line_items.pricing_model&#x60; is &#x60;tiered&#x60;, &#x60;volume&#x60; or &#x60;stairstep&#x60; and [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units ) is enabled.
+
+          */
        
       starting_unit_in_decimal?:string;
        
+         /**
+          * @description The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the &#x60;starting_unit_in_decimal&#x60; of the next higher tier. Returned only when the &#x60;line_items.pricing_model&#x60; is &#x60;tiered&#x60;, &#x60;volume&#x60; or stairstep and [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units ) is enabled.
+
+          */
+       
       ending_unit_in_decimal?:string;
        
+         /**
+          * @description The decimal representation of the quantity purchased from this tier. Returned when the &#x60;line_item&#x60; is quantity-based and [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units ) is enabled.
+
+          */
+       
       quantity_used_in_decimal?:string;
        
+         /**
+          * @description The decimal representation of the per-unit price for the tier when the &#x60;pricing_model&#x60; is &#x60;tiered&#x60; or &#x60;volume&#x60;. When the &#x60;pricing_model&#x60; is &#x60;stairstep&#x60;, it is the decimal representation of the total price for &#x60;line_item&#x60;. The value is in major units of the currency. Returned when the &#x60;line_item&#x60; is quantity-based and [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units ) is enabled.
+
+          */
+       
       unit_amount_in_decimal?:string;
     }
   }

package/types/resources/Usage.d.ts

@@ -90,11 +90,13 @@ declare module 'chargebee' {
   export namespace Usage {
     export class UsageResource {  
       /**
-        * @description Retrieves usages record for an invoice in PDF file format.
+        * @description Creates a usage record for an item price in a subscription. The item price must belong to a [metered](/docs/api/items?prod_cat_ver=2#item_metered) item.  
+**Max Usages**   
+The maximum number of usages that can be recorded for the entire lifetime of a subscription is 5000. [Contact Support](https://chargebee.freshdesk.com/support/home) if you want this limit to be increased for your site.
 
         */
       
-      pdf(input?:PdfInputParam):ChargebeeRequest<PdfResponse>;
+      create(subscription_id:string, input:CreateInputParam):ChargebeeRequest<CreateResponse>;
        
       /**
         * @description Retrieves a usage record of a specific subscription.
@@ -103,15 +105,6 @@ declare module 'chargebee' {
       
       retrieve(subscription_id:string, input:RetrieveInputParam):ChargebeeRequest<RetrieveResponse>;
        
-      /**
-        * @description Creates a usage record for an item price in a subscription. The item price must belong to a [metered](/docs/api/items?prod_cat_ver&#x3D;2#item_metered) item.  
-**Max Usages**   
-The maximum number of usages that can be recorded for the entire lifetime of a subscription is 5000. [Contact Support](https://chargebee.freshdesk.com/support/home) if you want this limit to be increased for your site.
-
-        */
-      
-      create(subscription_id:string, input:CreateInputParam):ChargebeeRequest<CreateResponse>;
-       
       /**
         * @description Deletes a usage record. This operation cannot be invoked for a usage record that has been [invoiced](usages?prod_cat_ver&#x3D;2#invoicing_usages).
 
@@ -125,37 +118,13 @@ The maximum number of usages that can be recorded for the entire lifetime of a s
         */
       
       list(input:ListInputParam):ChargebeeRequest<ListResponse>;
-    }
-    export interface PdfResponse {  
-       download:Download;
-    }
-    export interface PdfInputParam {
-       
-      /**
-        * @description Determines the pdf should be rendered as inline or attachment in the browser. \* attachment - PDF is rendered as attachment in the browser \* inline - PDF is rendered as inline in the browser
-
-        */
-       
-      disposition_type?:DispositionType;
-       
-      /**
-        * @description Parameters for invoice
-
-        */
-       
-      invoice?:{id:string};
-    }
-    export interface RetrieveResponse {  
-       usage:Usage;
-    }
-    export interface RetrieveInputParam {
        
       /**
-        * @description Retrieves a usage record of a specific subscription.
+        * @description Retrieves usages record for an invoice in PDF file format.
 
         */
-        
-      id:string;
+      
+      pdf(input?:PdfInputParam):ChargebeeRequest<PdfResponse>;
     }
     export interface CreateResponse {  
        usage:Usage;
@@ -198,6 +167,18 @@ The maximum number of usages that can be recorded for the entire lifetime of a s
        
       note?:string;
     }
+    export interface RetrieveResponse {  
+       usage:Usage;
+    }
+    export interface RetrieveInputParam {
+       
+      /**
+        * @description Retrieves a usage record of a specific subscription.
+
+        */
+        
+      id:string;
+    }
     export interface DeleteResponse {  
        usage:Usage;
     }
@@ -228,57 +209,56 @@ The maximum number of usages that can be recorded for the entire lifetime of a s
     export interface ListInputParam {
       [key : string]: any;  
       /**
-        * @description The number of resources to be returned.
+        * @description Retrieves the list of usages.
 
         */
         
       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 Retrieves the list of usages.
 
         */
         
       offset?:string;
        
       /**
-        * @description A unique and immutable id for the usage. If not provided, it is autogenerated.
+        * @description Retrieves the list of usages.
 
         */
         
       id?:{is?:string,is_not?:string,starts_with?:string};
        
       /**
-        * @description The id of the [subscription](/docs/api/subscriptions?prod_cat_ver&#x3D;2) to which this usage record belongs.
+        * @description Retrieves the list of usages.
 
         */
         
       subscription_id:{is?:string,is_not?:string,starts_with?:string};
        
       /**
-        * @description The time at which this usage occurred. Chargebee bills only those usages whose &#x60;usage_date&#x60; falls within a time when the subscription &#x60;status&#x60; was &#x60;active&#x60; or &#x60;non_renewing&#x60;. However, the remaining usage records are still stored and are [retrievable](/docs/api/usages?prod_cat_ver&#x3D;2#retrieve_a_usage).   
-**Note:** If &#x60;usage_date&#x60; corresponds to a time already invoiced, then it is stored but never invoiced unless the [invoice is regenerated](/docs/api/subscriptions?prod_cat_ver&#x3D;2#regenerate_an_invoice).
+        * @description Retrieves the list of usages.
 
         */
         
       usage_date?:{after?:string,before?:string,between?:string,on?:string};
        
       /**
-        * @description The id of the [item price](/docs/api/item_prices?prod_cat_ver&#x3D;2) to which this usage belongs. The item price must be a part of the subscription or should have been part of it historically.
+        * @description Retrieves the list of usages.
 
         */
         
       item_price_id?:{is?:string,is_not?:string,starts_with?:string};
        
       /**
-        * @description When the usage has been invoiced, this is the &#x60;id&#x60; of the [invoice](/docs/api/invoices?prod_cat_ver&#x3D;2). This is cleared when the invoice is &#x60;voided&#x60; or deleted.
+        * @description Retrieves the list of usages.
 
         */
         
       invoice_id?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string};
        
       /**
-        * @description The source from which the usage record was created.
+        * @description Retrieves the list of usages.
 
         */
         
@@ -291,6 +271,25 @@ The maximum number of usages that can be recorded for the entire lifetime of a s
         
       sort_by?:{asc?:'usage_date',desc?:'usage_date'};
     }
+    export interface PdfResponse {  
+       download:Download;
+    }
+    export interface PdfInputParam {
+       
+      /**
+        * @description Determines the pdf should be rendered as inline or attachment in the browser. \* attachment - PDF is rendered as attachment in the browser \* inline - PDF is rendered as inline in the browser
+
+        */
+       
+      disposition_type?:DispositionType;
+       
+      /**
+        * @description Parameters for invoice
+
+        */
+       
+      invoice?:{id:string};
+    }
     
   }
 }