chargebee 2.35.1 → 2.36.0

package/types/resources/Subscription.d.ts

@@ -1113,6 +1113,8 @@ You can also use our [Hosted Pages](https://www.chargebee.com/docs/hosted_pages.
         */
        
       event_based_addons?:{charge_on?:ChargeOn,charge_once?:boolean,id?:string,on_event?:OnEvent,quantity?:number,quantity_in_decimal?:string,service_period_in_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
+      tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
+      
     }
     export interface CreateForCustomerResponse {  
        subscription:Subscription;

package/types/resources/UnbilledCharge.d.ts

@@ -2,289 +2,107 @@
 declare module 'chargebee' {
   export interface UnbilledCharge {
     
-    /**
-      * @description Uniquely identifies an unbilled charge.
-
-      */
-    
     id?:string;
     
-    /**
-      * @description A unique identifier for the customer being charged.
-
-      */
-    
     customer_id?:string;
     
-    /**
-      * @description A unique identifier for the subscription this charge belongs to.
-
-      */
-    
     subscription_id?:string;
     
-    /**
-      * @description Start date of this charge.
-
-      */
-    
     date_from?:number;
     
-    /**
-      * @description End date of this charge.
-
-      */
-    
     date_to?:number;
     
-    /**
-      * @description Unit amount of the charge item.
-
-      */
-    
     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. \* 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 Quantity of the item which is represented by this charge.
-
-      */
-    
     quantity?:number;
     
-    /**
-      * @description Total amount of this charge. Typically equals to unit amount x quantity.
-
-      */
-    
     amount?:number;
     
-    /**
-      * @description The currency code (ISO 4217 format) for the charge.
-
-      */
-    
     currency_code:string;
     
-    /**
-      * @description Total discounts for this charge.
-
-      */
-    
     discount_amount?:number;
     
-    /**
-      * @description Detailed description about this charge.
-
-      */
-    
     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 \* 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
-
-      */
-    
-    entity_type:'addon_item_price' | 'plan_item_price' | 'charge_item_price' | 'adhoc';
-    
-    /**
-      * @description The identifier of the modelled entity this charge is based on. Will be null for 'adhoc' entity type.
-
-      */
+    entity_type:'plan_setup' | 'plan' | 'addon' | 'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price';
     
     entity_id?:string;
     
-    /**
-      * @description Will be true if the charge has been voided. Usually the unbilled charge will be voided and revised to different charges(s) during proration.
-
-      */
-    
     is_voided:boolean;
     
-    /**
-      * @description Timestamp indicating the date and time this charge got voided.
-
-      */
-    
     voided_at?:number;
     
-    /**
-      * @description The decimal representation of the unit amount for the entity. The value is in major units of the currency. Returned when the entity is quantity-based and [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units ) is enabled.
-
-      */
-    
     unit_amount_in_decimal?:string;
     
-    /**
-      * @description The decimal representation of the quantity of this entity. Returned when the entity is quantity-based and [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units ) is enabled.
-
-      */
-    
     quantity_in_decimal?:string;
     
-    /**
-      * @description The decimal representation of the amount for the charge, in major units of the currency. Typically equals to `unit_amount_in_decimal` x `quantity_in_decimal`. Returned when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units ) is enabled.
-
-      */
-    
     amount_in_decimal?:string;
     
-    /**
-      * @description Timestamp indicating when the unbilled charge was last updated
-
-      */
-    
     updated_at:number;
     
-    /**
-      * @description The value of this parameter will be true if it is a recurring unbilled charge for a future term.
-
-      */
+    tiers?:UnbilledCharge.LineItemTier[];
     
     is_advance_charge?:boolean;
     
     business_entity_id?:string;
     
-    /**
-      * @description Indicates that this resource has been deleted.
-
-      */
-    
     deleted:boolean;
-    
-    /**
-      * @description The list of tiers applicable for this line item
-
-      */
-    
-    tiers?:UnbilledCharge.LineItemTier[];
   }
   export namespace UnbilledCharge {
     export class UnbilledChargeResource {  
-      /**
-        * @description This endpoint creates unbilled charges for a subscription.
-
-        */
-      
+      create_unbilled_charge(input:CreateUnbilledChargeInputParam):ChargebeeRequest<CreateUnbilledChargeResponse>;
+       
       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.
-
-If the *Auto Collection* is turned on for the particular customer, the invoice will be created in payment_due state and the payment collection will be scheduled immediately.
-
-During invoice creation, the PO number for the line items will be filled from the subscription&#x27;s current PO number, if available.
-
-If no recurring item is present in the created invoice, the invoice will be marked as recurring&#x3D;false.
-
-If consolidated invoicing is enabled and the parameter &#x27;customer_id&#x27; is passed, multiple invoices can be created based on the following factors.
-
-* Currency
-* PO number if &#x27;Group by PO number&#x27; is enabled
-* Shipping address
-* Auto Collection
-* Payment method
-
-        */
-      
       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.
-
-        */
-      
       list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
        
-      /**
-        * @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.
-
-
-
-
-        */
-      
       invoice_now_estimate(input?:InvoiceNowEstimateInputParam):ChargebeeRequest<InvoiceNowEstimateResponse>;
     }
-    export interface CreateResponse {  
+    export interface CreateUnbilledChargeResponse {  
        unbilled_charges:UnbilledCharge[];
     }
-    export interface CreateInputParam {
+    export interface CreateUnbilledChargeInputParam {
        
-      /**
-        * @description Identifier of the subscription for which this unbilled charges needs to be created.
-
-        */
+      addons?:{date_from?:number,date_to?:number,id?:string,quantity?:number,quantity_in_decimal?:string,unit_price?:number,unit_price_in_decimal?:string}[];
        
-      subscription_id:string;
+      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}[];
        
-      /**
-        * @description The currency code (ISO 4217 format) of the unbilled_charge.
-
-        */
+      tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
        
-      currency_code?:string;
+      subscription_id:string;
        
-      /**
-        * @description Parameters for item_prices
-
-        */
+      currency_code?:string;
+    }
+    export interface CreateResponse {  
+       unbilled_charges:UnbilledCharge[];
+    }
+    export interface CreateInputParam {
        
       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}[];
+       
+      tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
+       
+      subscription_id:string;
+       
+      currency_code?:string;
     }
     export interface InvoiceUnbilledChargesResponse {  
        invoices:Invoice[];
     }
     export interface InvoiceUnbilledChargesInputParam {
        
-      /**
-        * @description Identifier of the subscription for which this invoice needs to be created. Should be specified if &#x27;customer_id&#x27; is not specified.
-
-        */
-       
       subscription_id?:string;
        
-      /**
-        * @description Identifier of the customer for whom this invoice needs to be created. Should be specified if &#x27;subscription_id&#x27; is not specified. Applicable only if the consolidated invoicing is enabled. .
-
-        */
-       
       customer_id?:string;
     }
     export interface DeleteResponse {  
@@ -292,59 +110,44 @@ In the estimate response,
     }
     
     export interface ListResponse {  
-      /**
-        * @description This endpoint lists all the unbilled charges.
-
-        */
-       
        list:{unbilled_charge:UnbilledCharge}[];
        
-      /**
-        * @description This endpoint lists all the unbilled charges.
-
-        */
-       
        next_offset?:string;
     }
     export interface ListInputParam {
       [key : string]: any;  
       /**
-        * @description This endpoint lists all the unbilled charges.
+        * @description The number of resources to be returned.
 
         */
         
       limit?:number;
        
       /**
-        * @description This endpoint lists all the unbilled charges.
+        * @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 This endpoint lists all the unbilled charges.
+        * @description Indicates whether to include deleted objects in the list. The deleted objects have the attribute \&#x60;deleted\&#x60; as \&#x60;true\&#x60;.
 
         */
         
       include_deleted?:boolean;
        
-      /**
-        * @description This endpoint lists all the unbilled charges.
-
-        */
-        
       is_voided?:boolean;
        
       /**
-        * @description This endpoint lists all the unbilled charges.
+        * @description A unique identifier for the subscription this charge belongs to.
 
         */
         
       subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string};
        
       /**
-        * @description This endpoint lists all the unbilled charges.
+        * @description A unique identifier for the customer being charged.
 
         */
         
@@ -355,75 +158,25 @@ In the estimate response,
     }
     export interface InvoiceNowEstimateInputParam {
        
-      /**
-        * @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;
        
-      /**
-        * @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.
-
-        */
-       
       customer_id?:string;
     }
-    export interface LineItemTier {  
-         /**
-          * @description The lower limit of a range of units for the tier
-
-          */
-       
+    export interface Tier {  
       starting_unit:number;
        
-         /**
-          * @description The upper limit of a range of units for the tier
-
-          */
-       
       ending_unit?:number;
        
-         /**
-          * @description The number of units purchased in a range.
-
-          */
-       
       quantity_used: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.
-
-          */
-       
       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/.github/workflows/greeting.yml

@@ -1,47 +0,0 @@
-name: Greet New Contributors
-
-on: 
-  issues:
-    types: [opened]
-  pull_request:
-    types: [opened]
-
-permissions:
-  issues: write
-  pull-requests: write
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    steps:   
-    - name: Greet for issue
-      if: github.event_name == 'issues' && github.event.action == 'opened'
-      uses: actions/github-script@v6
-      with:
-        script: |
-          const issueComment = `
-            Hello @${context.payload.sender.login}, thank you for raising the issue. Your contribution is greatly appreciated and we look forward to addressing it.
-          `
-          github.rest.issues.createComment({
-            issue_number: context.payload.issue.number,
-            owner: context.repo.owner,
-            repo: context.repo.repo,
-            body: issueComment,
-          })
-          
-    - name: Greet for pull request
-      if: github.event_name == 'pull_request' && github.event.action == 'opened'
-      uses: actions/github-script@v6
-      with:
-        script: |
-          const prComment = `
-            Thank you, @${context.payload.sender.login}, for the pull request. We will take a look at it and get back to you shortly.
-          `
-          github.rest.issues.createComment({
-            issue_number: context.payload.pull_request.number,
-            owner: context.repo.owner,
-            repo: context.repo.repo,
-            body: prComment,
-          })