chargebee 2.51.0 → 2.53.0

package/types/resources/Invoice.d.ts

@@ -6,44 +6,58 @@ declare module 'chargebee' {
 
     id:string;
 
-    po_number?:string;
-
     customer_id:string;
 
+    payment_owner?:string;
+
     subscription_id?:string;
 
     recurring:boolean;
 
     status:'paid' | 'posted' | 'payment_due' | 'not_paid' | 'voided' | 'pending';
 
-    vat_number?:string;
-
-    price_type:PriceType;
-
     date?:number;
 
     due_date?:number;
 
     net_term_days?:number;
 
+    po_number?:string;
+
+    vat_number?:string;
+
+    price_type:PriceType;
+
     exchange_rate?:number;
 
+    local_currency_exchange_rate?:number;
+
     currency_code:string;
 
-    total?:number;
+    local_currency_code?:string;
 
-    amount_paid?:number;
+    tax:number;
 
-    amount_adjusted?:number;
+    sub_total:number;
 
-    write_off_amount?:number;
+    sub_total_in_local_currency?:number;
 
-    credits_applied?:number;
+    total?:number;
+
+    total_in_local_currency?:number;
 
     amount_due?:number;
 
+    amount_adjusted?:number;
+
+    amount_paid?:number;
+
     paid_at?:number;
 
+    write_off_amount?:number;
+
+    credits_applied?:number;
+
     dunning_status?:'in_progress' | 'exhausted' | 'stopped' | 'success';
 
     next_retry_at?:number;
@@ -54,18 +68,6 @@ declare module 'chargebee' {
 
     updated_at?:number;
 
-    sub_total:number;
-
-    sub_total_in_local_currency?:number;
-
-    total_in_local_currency?:number;
-
-    local_currency_code?:string;
-
-    tax:number;
-
-    local_currency_exchange_rate?:number;
-
     first_invoice?:boolean;
 
     new_sales_amount?:number;
@@ -86,17 +88,21 @@ declare module 'chargebee' {
 
     line_items?:Invoice.LineItem[];
 
-    discounts?:Invoice.Discount[];
+    line_item_tiers?:Invoice.LineItemTier[];
 
     line_item_discounts?:Invoice.LineItemDiscount[];
 
-    taxes?:Invoice.Tax[];
-
     line_item_taxes?:Invoice.LineItemTax[];
 
     line_item_credits?:Invoice.LineItemCredit[];
 
-    line_item_tiers?:Invoice.LineItemTier[];
+    line_item_addresses?:Invoice.LineItemAddress[];
+
+    discounts?:Invoice.Discount[];
+
+    taxes?:Invoice.Tax[];
+
+    tax_origin?:Invoice.TaxOrigin;
 
     linked_payments?:Invoice.LinkedPayment[];
 
@@ -114,13 +120,11 @@ declare module 'chargebee' {
 
     shipping_address?:Invoice.ShippingAddress;
 
-    statement_descriptor?:Invoice.StatementDescriptor;
-
     billing_address?:Invoice.BillingAddress;
 
-    einvoice?:Invoice.Einvoice;
+    statement_descriptor?:Invoice.StatementDescriptor;
 
-    payment_owner?:string;
+    einvoice?:Invoice.Einvoice;
 
     void_reason_code?:string;
 
@@ -136,10 +140,6 @@ declare module 'chargebee' {
 
     site_details_at_creation?:Invoice.SiteDetailsAtCreation;
 
-    tax_origin?:Invoice.TaxOrigin;
-
-    line_item_addresses?:Invoice.LineItemAddress[];
-
   }
   export namespace Invoice {
     export class InvoiceResource {  
@@ -238,7 +238,7 @@ declare module 'chargebee' {
        
       payment_method?:{additional_information?:object,gateway?:Gateway,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type?:Type};
        
-      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
+      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact',reference_id?:string};
        
       addons?:{date_from?:number,date_to?:number,id?:string,quantity?:number,quantity_in_decimal?:string,unit_price?:number,unit_price_in_decimal?:string}[];
        
@@ -295,7 +295,7 @@ declare module 'chargebee' {
        
       payment_method?:{additional_information?:object,gateway?:Gateway,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type?:Type};
        
-      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
+      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact',reference_id?:string};
        
       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}[];
        
@@ -307,7 +307,7 @@ declare module 'chargebee' {
        
       tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
        
-      discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
+      discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number,quantity?:number}[];
        
       customer_id?:string;
        
@@ -476,7 +476,7 @@ declare module 'chargebee' {
        
       shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
        
-      line_items:{amount?:number,amount_in_decimal?:string,created_at?:number,date_from?:number,date_to?:number,description:string,entity_id?:string,entity_type?:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price',id?:string,item_level_discount1_amount?:number,item_level_discount1_entity_id?:string,item_level_discount2_amount?:number,item_level_discount2_entity_id?:string,quantity?:number,quantity_in_decimal?:string,subscription_id?:string,tax10_amount?:number,tax10_name?:string,tax1_amount?:number,tax1_name?:string,tax2_amount?:number,tax2_name?:string,tax3_amount?:number,tax3_name?:string,tax4_amount?:number,tax4_name?:string,tax5_amount?:number,tax5_name?:string,tax6_amount?:number,tax6_name?:string,tax7_amount?:number,tax7_name?:string,tax8_amount?:number,tax8_name?:string,tax9_amount?:number,tax9_name?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
+      line_items:{amount?:number,amount_in_decimal?:string,created_at?:number,date_from?:number,date_to?:number,description:string,entity_id?:string,entity_type?:'adhoc' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'plan_setup' | 'plan' | 'addon',id?:string,item_level_discount1_amount?:number,item_level_discount1_entity_id?:string,item_level_discount2_amount?:number,item_level_discount2_entity_id?:string,quantity?:number,quantity_in_decimal?:string,subscription_id?:string,tax10_amount?:number,tax10_name?:string,tax1_amount?:number,tax1_name?:string,tax2_amount?:number,tax2_name?:string,tax3_amount?:number,tax3_name?:string,tax4_amount?:number,tax4_name?:string,tax5_amount?:number,tax5_name?:string,tax6_amount?:number,tax6_name?:string,tax7_amount?:number,tax7_name?:string,tax8_amount?:number,tax8_name?:string,tax9_amount?:number,tax9_name?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
        
       payment_reference_numbers:{id?:string,number:string,type:'kid' | 'ocr' | 'frn' | 'fik' | 'swiss_reference'}[];
        
@@ -486,9 +486,9 @@ declare module 'chargebee' {
        
       taxes:{amount?:number,description?:string,juris_code?:string,juris_name?:string,juris_type?:'country' | 'federal' | 'state' | 'county' | 'city' | 'special' | 'unincorporated' | 'other',name:string,rate:number}[];
        
-      payments:{amount:number,date?:number,payment_method:PaymentMethod,reference_number?:string}[];
+      payments:{amount:number,date?:number,id?:string,payment_method:PaymentMethod,reference_number?:string}[];
        
-      notes?:{entity_id?:string,entity_type?:'coupon' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price',note?:string}[];
+      notes?:{entity_id?:string,entity_type?:'coupon' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'plan' | 'addon',note?:string}[];
        
       line_item_addresses?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,line_item_id?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string}[];
        
@@ -580,7 +580,7 @@ declare module 'chargebee' {
       limit?:number;
        
       /**
-        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \`offset\` to the value of \`next_offset\` obtained in the previous iteration of the API call.
+        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
 
         */
         
@@ -602,16 +602,6 @@ declare module 'chargebee' {
         
       include_deleted?:boolean;
        
-      hide_zero_line_item?:boolean;
-       
-      show_zero_tax_lines?:boolean;
-       
-      show_exempted_tax_lines?:boolean;
-       
-      include_consolidated_invoices?:boolean;
-       
-      ignore_imported_invoice?:boolean;
-       
       /**
         * @description The invoice number. Acts as a identifier for invoice and typically generated sequentially.
 
@@ -746,7 +736,7 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
         
       void_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
-      sort_by?:{asc?:'date' | 'updated_at',desc?:'date' | 'updated_at'};
+      sort_by?:object;
     }
     export interface InvoicesForCustomerResponse {  
        list:{invoice:Invoice}[];
@@ -763,7 +753,7 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
       limit?:number;
        
       /**
-        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \`offset\` to the value of \`next_offset\` obtained in the previous iteration of the API call.
+        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
 
         */
         
@@ -784,7 +774,7 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
       limit?:number;
        
       /**
-        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \`offset\` to the value of \`next_offset\` obtained in the previous iteration of the API call.
+        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
 
         */
         
@@ -796,10 +786,6 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
     export interface RetrieveInputParam {
        
       line_item?:{customer_id?:{is?:string},subscription_id?:{is?:string}};
-       
-      line_items_limit?:number;
-       
-      line_items_offset?:string;
     }
     export interface PdfResponse {  
        download:Download;
@@ -827,7 +813,7 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
       limit?:number;
        
       /**
-        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \`offset\` to the value of \`next_offset\` obtained in the previous iteration of the API call.
+        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
 
         */
         
@@ -1136,18 +1122,28 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
        
       customer_id?:string;
     }
-    export interface Discount {  
-      amount:number;
+    export interface LineItemTier {  
+      line_item_id?:string;
        
-      description?:string;
+      starting_unit:number;
        
-      entity_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
+      ending_unit?:number;
        
-      discount_type?:'fixed_amount' | 'percentage';
+      quantity_used:number;
        
-      entity_id?:string;
+      unit_amount:number;
        
-      coupon_set_code?:string;
+      starting_unit_in_decimal?:string;
+       
+      ending_unit_in_decimal?:string;
+       
+      quantity_used_in_decimal?:string;
+       
+      unit_amount_in_decimal?:string;
+       
+      pricing_type?:'per_unit' | 'flat_fee' | 'package';
+       
+      package_size?:number;
     }
     export interface LineItemDiscount {  
       line_item_id:string;
@@ -1160,13 +1156,6 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
        
       discount_amount:number;
     }
-    export interface Tax {  
-      name:string;
-       
-      amount:number;
-       
-      description?:string;
-    }
     export interface LineItemTax {  
       line_item_id?:string;
        
@@ -1205,28 +1194,61 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
        
       line_item_id?:string;
     }
-    export interface LineItemTier {  
+    export interface LineItemAddress {  
       line_item_id?:string;
        
-      starting_unit:number;
+      first_name?:string;
        
-      ending_unit?:number;
+      last_name?:string;
        
-      quantity_used:number;
+      email?:string;
        
-      unit_amount:number;
+      company?:string;
        
-      starting_unit_in_decimal?:string;
+      phone?:string;
        
-      ending_unit_in_decimal?:string;
+      line1?:string;
        
-      quantity_used_in_decimal?:string;
+      line2?:string;
        
-      unit_amount_in_decimal?:string;
+      line3?:string;
        
-      pricing_type?:'per_unit' | 'flat_fee' | 'package';
+      city?:string;
        
-      package_size?:number;
+      state_code?:string;
+       
+      state?:string;
+       
+      country?:string;
+       
+      zip?:string;
+       
+      validation_status?:'not_validated' | 'valid' | 'partially_valid' | 'invalid';
+    }
+    export interface Discount {  
+      amount:number;
+       
+      description?:string;
+       
+      entity_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
+       
+      discount_type?:'fixed_amount' | 'percentage';
+       
+      entity_id?:string;
+       
+      coupon_set_code?:string;
+    }
+    export interface Tax {  
+      name:string;
+       
+      amount:number;
+       
+      description?:string;
+    }
+    export interface TaxOrigin {  
+      country?:string;
+       
+      registration_number?:string;
     }
     export interface LinkedPayment {  
       txn_id:string;
@@ -1352,11 +1374,6 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
        
       index:number;
     }
-    export interface StatementDescriptor {  
-      id:string;
-       
-      descriptor?:string;
-    }
     export interface BillingAddress {  
       first_name?:string;
        
@@ -1386,6 +1403,11 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
        
       validation_status?:ValidationStatus;
     }
+    export interface StatementDescriptor {  
+      id:string;
+       
+      descriptor?:string;
+    }
     export interface Einvoice {  
       id:string;
        
@@ -1400,41 +1422,5 @@ NOTE: Not to be used if *consolidated invoicing* is enabled.
        
       organization_address?:object;
     }
-    export interface TaxOrigin {  
-      country?:string;
-       
-      registration_number?:string;
-    }
-    export interface LineItemAddress {  
-      line_item_id?:string;
-       
-      first_name?:string;
-       
-      last_name?:string;
-       
-      email?:string;
-       
-      company?:string;
-       
-      phone?:string;
-       
-      line1?:string;
-       
-      line2?:string;
-       
-      line3?:string;
-       
-      city?:string;
-       
-      state_code?:string;
-       
-      state?:string;
-       
-      country?:string;
-       
-      zip?:string;
-       
-      validation_status?:'not_validated' | 'valid' | 'partially_valid' | 'invalid';
-    }
   }
 }

package/types/resources/InvoiceEstimate.d.ts

@@ -79,7 +79,7 @@ declare module 'chargebee' {
        
       metered?:boolean;
        
-      percentage?:string;
+      is_percentage_pricing?:boolean;
        
       reference_line_item_id?:string;
        

package/types/resources/Item.d.ts

@@ -79,7 +79,7 @@ declare module 'chargebee' {
        item:Item;
     }
     export interface CreateInputParam {
-      [key : string] : any;  
+       
       bundle_configuration?:{type?:'fixed'};
        
       bundle_items_to_add?:{item_id?:string,item_type?:ItemType,price_allocation?:number,quantity?:number}[];
@@ -134,7 +134,7 @@ declare module 'chargebee' {
        item:Item;
     }
     export interface UpdateInputParam {
-      [key : string] : any;  
+       
       bundle_configuration?:{type?:'fixed'};
        
       bundle_items_to_add?:{item_id?:string,item_type?:ItemType,price_allocation?:number,quantity?:number}[];
@@ -192,7 +192,7 @@ declare module 'chargebee' {
       limit?:number;
        
       /**
-        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \`offset\` to the value of \`next_offset\` obtained in the previous iteration of the API call.
+        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set 'offset' to the value of 'next_offset' obtained in the previous iteration of the API call.
 
         */
         
@@ -290,13 +290,6 @@ declare module 'chargebee' {
         
       usage_calculation?:{in?:string,is?:'sum_of_usages' | 'last_usage' | 'max_usage',is_not?:'sum_of_usages' | 'last_usage' | 'max_usage',not_in?:string};
        
-      /**
-        * @description Indicates Whether a plan is grouped(bundle) or not. If it is grouped, it gives us the type of group.
-
-        */
-        
-      item_grouping_category?:{in?:string,is?:'non_bundle' | 'fixed',is_not?:'non_bundle' | 'fixed',not_in?:string};
-       
       /**
         * @description The subscription channel this object originated from and is maintained in.
 
@@ -317,7 +310,7 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
        
       include_site_level_resources?:{is?:'true' | 'false'};
        
-      sort_by?:{asc?:'name' | 'id' | 'updated_at',desc?:'name' | 'id' | 'updated_at'};
+      sort_by?:object;
     }
     export interface DeleteResponse {  
        item:Item;