chargebee 2.40.0 → 3.0.0-beta.1

package/types/resources/Estimate.d.ts

@@ -1,570 +1,1221 @@
 ///<reference path='./../core.d.ts'/>
 ///<reference path='./../index.d.ts'/>
+
 declare module 'chargebee' {
   export interface Estimate {
-    
-    created_at:number;
-    
-    subscription_estimate?:SubscriptionEstimate;
-    
-    subscription_estimates?:SubscriptionEstimate[];
-    
-    invoice_estimate?:InvoiceEstimate;
-    
-    invoice_estimates?:InvoiceEstimate[];
-    
-    next_invoice_estimate?:InvoiceEstimate;
-    
-    credit_note_estimates?:CreditNoteEstimate[];
-    
-    unbilled_charge_estimates?:UnbilledCharge[];
+    created_at: number;
+    subscription_estimate?: SubscriptionEstimate;
+    subscription_estimates?: SubscriptionEstimate[];
+    invoice_estimate?: InvoiceEstimate;
+    invoice_estimates?: InvoiceEstimate[];
+    next_invoice_estimate?: InvoiceEstimate;
+    credit_note_estimates?: CreditNoteEstimate[];
+    unbilled_charge_estimates?: UnbilledCharge[];
   }
+
   export namespace Estimate {
-    export class EstimateResource {  
-      create_subscription(input:CreateSubscriptionInputParam):ChargebeeRequest<CreateSubscriptionResponse>;
-       
-      create_sub_item_estimate(input:CreateSubItemEstimateInputParam):ChargebeeRequest<CreateSubItemEstimateResponse>;
-       
-      create_sub_for_customer_estimate(customer_id:string, input:CreateSubForCustomerEstimateInputParam):ChargebeeRequest<CreateSubForCustomerEstimateResponse>;
-       
-      create_sub_item_for_customer_estimate(customer_id:string, input:CreateSubItemForCustomerEstimateInputParam):ChargebeeRequest<CreateSubItemForCustomerEstimateResponse>;
-       
-      update_subscription(input:UpdateSubscriptionInputParam):ChargebeeRequest<UpdateSubscriptionResponse>;
-       
-      update_subscription_for_items(input:UpdateSubscriptionForItemsInputParam):ChargebeeRequest<UpdateSubscriptionForItemsResponse>;
-       
-      renewal_estimate(subscription_id:string, input?:RenewalEstimateInputParam):ChargebeeRequest<RenewalEstimateResponse>;
-       
-      advance_invoice_estimate(subscription_id:string, input?:AdvanceInvoiceEstimateInputParam):ChargebeeRequest<AdvanceInvoiceEstimateResponse>;
-       
-      regenerate_invoice_estimate(subscription_id:string, input?:RegenerateInvoiceEstimateInputParam):ChargebeeRequest<RegenerateInvoiceEstimateResponse>;
-       
-      upcoming_invoices_estimate(customer_id:string):ChargebeeRequest<UpcomingInvoicesEstimateResponse>;
-       
-      change_term_end(subscription_id:string, input:ChangeTermEndInputParam):ChargebeeRequest<ChangeTermEndResponse>;
-       
-      cancel_subscription(subscription_id:string, input?:CancelSubscriptionInputParam):ChargebeeRequest<CancelSubscriptionResponse>;
-       
-      cancel_subscription_for_items(subscription_id:string, input?:CancelSubscriptionForItemsInputParam):ChargebeeRequest<CancelSubscriptionForItemsResponse>;
-       
-      pause_subscription(subscription_id:string, input?:PauseSubscriptionInputParam):ChargebeeRequest<PauseSubscriptionResponse>;
-       
-      resume_subscription(subscription_id:string, input?:ResumeSubscriptionInputParam):ChargebeeRequest<ResumeSubscriptionResponse>;
-       
-      gift_subscription(input:GiftSubscriptionInputParam):ChargebeeRequest<GiftSubscriptionResponse>;
-       
-      gift_subscription_for_items(input:GiftSubscriptionForItemsInputParam):ChargebeeRequest<GiftSubscriptionForItemsResponse>;
-       
-      create_invoice(input?:CreateInvoiceInputParam):ChargebeeRequest<CreateInvoiceResponse>;
-       
-      create_invoice_for_items(input:CreateInvoiceForItemsInputParam):ChargebeeRequest<CreateInvoiceForItemsResponse>;
-    }
-    export interface CreateSubscriptionResponse {  
-       estimate:Estimate;
+    export class EstimateResource {
+      createSubscription(
+        input: CreateSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateSubscriptionResponse>>;
+
+      createSubItemEstimate(
+        input: CreateSubItemEstimateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateSubItemEstimateResponse>>;
+
+      createSubForCustomerEstimate(
+        customer_id: string,
+        input: CreateSubForCustomerEstimateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateSubForCustomerEstimateResponse>>;
+
+      createSubItemForCustomerEstimate(
+        customer_id: string,
+        input: CreateSubItemForCustomerEstimateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateSubItemForCustomerEstimateResponse>>;
+
+      updateSubscription(
+        input: UpdateSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateSubscriptionResponse>>;
+
+      updateSubscriptionForItems(
+        input: UpdateSubscriptionForItemsInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateSubscriptionForItemsResponse>>;
+
+      renewalEstimate(
+        subscription_id: string,
+        input?: RenewalEstimateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RenewalEstimateResponse>>;
+
+      advanceInvoiceEstimate(
+        subscription_id: string,
+        input?: AdvanceInvoiceEstimateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<AdvanceInvoiceEstimateResponse>>;
+
+      regenerateInvoiceEstimate(
+        subscription_id: string,
+        input?: RegenerateInvoiceEstimateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RegenerateInvoiceEstimateResponse>>;
+
+      upcomingInvoicesEstimate(
+        customer_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpcomingInvoicesEstimateResponse>>;
+
+      changeTermEnd(
+        subscription_id: string,
+        input: ChangeTermEndInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ChangeTermEndResponse>>;
+
+      cancelSubscription(
+        subscription_id: string,
+        input?: CancelSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CancelSubscriptionResponse>>;
+
+      cancelSubscriptionForItems(
+        subscription_id: string,
+        input?: CancelSubscriptionForItemsInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CancelSubscriptionForItemsResponse>>;
+
+      pauseSubscription(
+        subscription_id: string,
+        input?: PauseSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<PauseSubscriptionResponse>>;
+
+      resumeSubscription(
+        subscription_id: string,
+        input?: ResumeSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ResumeSubscriptionResponse>>;
+
+      giftSubscription(
+        input: GiftSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<GiftSubscriptionResponse>>;
+
+      giftSubscriptionForItems(
+        input: GiftSubscriptionForItemsInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<GiftSubscriptionForItemsResponse>>;
+
+      createInvoice(
+        input?: CreateInvoiceInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateInvoiceResponse>>;
+
+      createInvoiceForItems(
+        input: CreateInvoiceForItemsInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateInvoiceForItemsResponse>>;
     }
+
+    export interface CreateSubscriptionResponse {
+      estimate: Estimate;
+    }
+
+    export interface CreateSubItemEstimateResponse {
+      estimate: Estimate;
+    }
+
+    export interface CreateSubForCustomerEstimateResponse {
+      estimate: Estimate;
+    }
+
+    export interface CreateSubItemForCustomerEstimateResponse {
+      estimate: Estimate;
+    }
+
+    export interface UpdateSubscriptionResponse {
+      estimate: Estimate;
+    }
+
+    export interface UpdateSubscriptionForItemsResponse {
+      estimate: Estimate;
+    }
+
+    export interface RenewalEstimateResponse {
+      estimate: Estimate;
+    }
+
+    export interface AdvanceInvoiceEstimateResponse {
+      estimate: Estimate;
+    }
+
+    export interface RegenerateInvoiceEstimateResponse {
+      estimate: Estimate;
+    }
+
+    export interface UpcomingInvoicesEstimateResponse {
+      estimate: Estimate;
+    }
+
+    export interface ChangeTermEndResponse {
+      estimate: Estimate;
+    }
+
+    export interface CancelSubscriptionResponse {
+      estimate: Estimate;
+    }
+
+    export interface CancelSubscriptionForItemsResponse {
+      estimate: Estimate;
+    }
+
+    export interface PauseSubscriptionResponse {
+      estimate: Estimate;
+    }
+
+    export interface ResumeSubscriptionResponse {
+      estimate: Estimate;
+    }
+
+    export interface GiftSubscriptionResponse {
+      estimate: Estimate;
+    }
+
+    export interface GiftSubscriptionForItemsResponse {
+      estimate: Estimate;
+    }
+
+    export interface CreateInvoiceResponse {
+      estimate: Estimate;
+    }
+
+    export interface CreateInvoiceForItemsResponse {
+      estimate: Estimate;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
     export interface CreateSubscriptionInputParam {
-       
-      subscription:{contract_term_billing_cycle_on_renewal?:number,coupon?:string,free_period?:number,free_period_unit?:FreePeriodUnit,id?:string,offline_payment_method?:OfflinePaymentMethod,plan_id:string,plan_quantity?:number,plan_quantity_in_decimal?:string,plan_unit_price?:number,plan_unit_price_in_decimal?:string,setup_fee?:number,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
-       
-      billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
-       
-      shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
-       
-      customer?:{customer_type?:CustomerType,entity_code?:EntityCode,exempt_number?:string,exemption_details?:any[],registered_for_gst?:boolean,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
-       
-      contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
-       
-      addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
-       
-      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}[];
-       
-      billing_cycles?:number;
-       
-      mandatory_addons_to_remove?:string[];
-       
-      terms_to_charge?:number;
-       
-      billing_alignment_mode?:BillingAlignmentMode;
-       
-      coupon_ids?:string[];
-       
-      invoice_immediately?:boolean;
-       
-      invoice_date?:number;
-       
-      client_profile_id?:string;
-    }
-    export interface CreateSubItemEstimateResponse {  
-       estimate:Estimate;
+      billing_cycles?: number;
+      mandatory_addons_to_remove?: string[];
+      terms_to_charge?: number;
+      billing_alignment_mode?: BillingAlignmentMode;
+      coupon_ids?: string[];
+      invoice_immediately?: boolean;
+      invoice_date?: number;
+      client_profile_id?: string;
+      subscription?: SubscriptionCreateSubscriptionInputParam;
+      billing_address?: BillingAddressCreateSubscriptionInputParam;
+      shipping_address?: ShippingAddressCreateSubscriptionInputParam;
+      customer?: CustomerCreateSubscriptionInputParam;
+      contract_term?: ContractTermCreateSubscriptionInputParam;
+      addons?: AddonsCreateSubscriptionInputParam[];
+      event_based_addons?: EventBasedAddonsCreateSubscriptionInputParam[];
+      tax_providers_fields?: TaxProvidersFieldsCreateSubscriptionInputParam[];
     }
     export interface CreateSubItemEstimateInputParam {
-       
-      subscription?:{contract_term_billing_cycle_on_renewal?:number,coupon?:string,free_period?:number,free_period_unit?:FreePeriodUnit,id?:string,setup_fee?:number,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
-       
-      billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
-       
-      shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
-       
-      customer?:{customer_type?:CustomerType,entity_code?:EntityCode,exempt_number?:string,exemption_details?:any[],registered_for_gst?:boolean,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
-       
-      contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number,contract_start?:number};
-       
-      subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
-       
-      discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
-       
-      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}[];
-       
-      tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
-       
-      billing_cycles?:number;
-       
-      mandatory_items_to_remove?:string[];
-       
-      terms_to_charge?:number;
-       
-      billing_alignment_mode?:BillingAlignmentMode;
-       
-      coupon_ids?:string[];
-       
-      invoice_immediately?:boolean;
-       
-      invoice_date?:number;
-       
-      client_profile_id?:string;
-    }
-    export interface CreateSubForCustomerEstimateResponse {  
-       estimate:Estimate;
+      billing_cycles?: number;
+      mandatory_items_to_remove?: string[];
+      terms_to_charge?: number;
+      billing_alignment_mode?: BillingAlignmentMode;
+      coupon_ids?: string[];
+      invoice_immediately?: boolean;
+      invoice_date?: number;
+      client_profile_id?: string;
+      subscription?: SubscriptionCreateSubItemEstimateInputParam;
+      billing_address?: BillingAddressCreateSubItemEstimateInputParam;
+      shipping_address?: ShippingAddressCreateSubItemEstimateInputParam;
+      customer?: CustomerCreateSubItemEstimateInputParam;
+      contract_term?: ContractTermCreateSubItemEstimateInputParam;
+      subscription_items?: SubscriptionItemsCreateSubItemEstimateInputParam[];
+      discounts?: DiscountsCreateSubItemEstimateInputParam[];
+      item_tiers?: ItemTiersCreateSubItemEstimateInputParam[];
+      tax_providers_fields?: TaxProvidersFieldsCreateSubItemEstimateInputParam[];
     }
     export interface CreateSubForCustomerEstimateInputParam {
-       
-      subscription?:{contract_term_billing_cycle_on_renewal?:number,free_period?:number,free_period_unit?:FreePeriodUnit,id?:string,offline_payment_method?:OfflinePaymentMethod,plan_id:string,plan_quantity?:number,plan_quantity_in_decimal?:string,plan_unit_price?:number,plan_unit_price_in_decimal?:string,setup_fee?:number,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
-       
-      shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
-       
-      contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number};
-       
-      addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
-       
-      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}[];
-       
-      use_existing_balances?:boolean;
-       
-      invoice_immediately?:boolean;
-       
-      billing_cycles?:number;
-       
-      mandatory_addons_to_remove?:string[];
-       
-      terms_to_charge?:number;
-       
-      next_renewal_date?:number;
-       
-      charge_model?:'full_charge' | 'prorate';
-       
-      billing_alignment_mode?:'immediate' | 'delayed';
-       
-      referral_details?:string;
-       
-      invoice_date?:number;
-       
-      coupon_ids?:string[];
-       
-      allow_gift_plan?:boolean;
-    }
-    export interface CreateSubItemForCustomerEstimateResponse {  
-       estimate:Estimate;
+      use_existing_balances?: boolean;
+      invoice_immediately?: boolean;
+      billing_cycles?: number;
+      mandatory_addons_to_remove?: string[];
+      terms_to_charge?: number;
+      billing_alignment_mode?: 'immediate' | 'delayed';
+      invoice_date?: number;
+      coupon_ids?: string[];
+      subscription?: SubscriptionCreateSubForCustomerEstimateInputParam;
+      shipping_address?: ShippingAddressCreateSubForCustomerEstimateInputParam;
+      contract_term?: ContractTermCreateSubForCustomerEstimateInputParam;
+      addons?: AddonsCreateSubForCustomerEstimateInputParam[];
+      event_based_addons?: EventBasedAddonsCreateSubForCustomerEstimateInputParam[];
     }
     export interface CreateSubItemForCustomerEstimateInputParam {
-       
-      subscription?:{contract_term_billing_cycle_on_renewal?:number,free_period?:number,free_period_unit?:FreePeriodUnit,id?:string,setup_fee?:number,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
-       
-      shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
-       
-      billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
-       
-      contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number,contract_start?:number};
-       
-      subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
-       
-      discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
-       
-      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}[];
-       
-      use_existing_balances?:boolean;
-       
-      invoice_immediately?:boolean;
-       
-      billing_cycles?:number;
-       
-      mandatory_items_to_remove?:string[];
-       
-      terms_to_charge?:number;
-       
-      billing_alignment_mode?:BillingAlignmentMode;
-       
-      invoice_date?:number;
-       
-      coupon_ids?:string[];
-    }
-    export interface UpdateSubscriptionResponse {  
-       estimate:Estimate;
+      use_existing_balances?: boolean;
+      invoice_immediately?: boolean;
+      billing_cycles?: number;
+      mandatory_items_to_remove?: string[];
+      terms_to_charge?: number;
+      billing_alignment_mode?: BillingAlignmentMode;
+      invoice_date?: number;
+      coupon_ids?: string[];
+      subscription?: SubscriptionCreateSubItemForCustomerEstimateInputParam;
+      shipping_address?: ShippingAddressCreateSubItemForCustomerEstimateInputParam;
+      billing_address?: BillingAddressCreateSubItemForCustomerEstimateInputParam;
+      contract_term?: ContractTermCreateSubItemForCustomerEstimateInputParam;
+      subscription_items?: SubscriptionItemsCreateSubItemForCustomerEstimateInputParam[];
+      discounts?: DiscountsCreateSubItemForCustomerEstimateInputParam[];
+      item_tiers?: ItemTiersCreateSubItemForCustomerEstimateInputParam[];
     }
     export interface UpdateSubscriptionInputParam {
-       
-      subscription:{auto_collection?:AutoCollection,coupon?:string,free_period?:number,free_period_unit?:FreePeriodUnit,id:string,offline_payment_method?:OfflinePaymentMethod,plan_id?:string,plan_quantity?:number,plan_quantity_in_decimal?:string,plan_unit_price?:number,plan_unit_price_in_decimal?:string,setup_fee?:number,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
-       
-      billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
-       
-      shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
-       
-      customer?:{registered_for_gst?:boolean,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
-       
-      addons?:{billing_cycles?:number,id?:string,proration_type?:ProrationType,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
-       
-      changes_scheduled_at?:number;
-       
-      change_option?:ChangeOption;
-       
-      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}[];
-       
-      replace_addon_list?:boolean;
-       
-      mandatory_addons_to_remove?:string[];
-       
-      invoice_date?:number;
-       
-      billing_cycles?:number;
-       
-      terms_to_charge?:number;
-       
-      reactivate_from?:number;
-       
-      billing_alignment_mode?:BillingAlignmentMode;
-       
-      coupon_ids?:string[];
-       
-      replace_coupon_list?:boolean;
-       
-      prorate?:boolean;
-       
-      end_of_term?:boolean;
-       
-      force_term_reset?:boolean;
-       
-      reactivate?:boolean;
-       
-      include_delayed_charges?:boolean;
-       
-      use_existing_balances?:boolean;
-       
-      invoice_immediately?:boolean;
-    }
-    export interface UpdateSubscriptionForItemsResponse {  
-       estimate:Estimate;
+      changes_scheduled_at?: number;
+      change_option?: ChangeOption;
+      replace_addon_list?: boolean;
+      mandatory_addons_to_remove?: string[];
+      invoice_date?: number;
+      billing_cycles?: number;
+      terms_to_charge?: number;
+      reactivate_from?: number;
+      billing_alignment_mode?: BillingAlignmentMode;
+      coupon_ids?: string[];
+      replace_coupon_list?: boolean;
+      prorate?: boolean;
+      end_of_term?: boolean;
+      force_term_reset?: boolean;
+      reactivate?: boolean;
+      include_delayed_charges?: boolean;
+      use_existing_balances?: boolean;
+      invoice_immediately?: boolean;
+      subscription?: SubscriptionUpdateSubscriptionInputParam;
+      billing_address?: BillingAddressUpdateSubscriptionInputParam;
+      shipping_address?: ShippingAddressUpdateSubscriptionInputParam;
+      customer?: CustomerUpdateSubscriptionInputParam;
+      addons?: AddonsUpdateSubscriptionInputParam[];
+      event_based_addons?: EventBasedAddonsUpdateSubscriptionInputParam[];
     }
     export interface UpdateSubscriptionForItemsInputParam {
-       
-      subscription:{auto_collection?:AutoCollection,coupon?:string,free_period?:number,free_period_unit?:FreePeriodUnit,id:string,offline_payment_method?:OfflinePaymentMethod,setup_fee?:number,start_date?:number,trial_end?:number,trial_end_action?:TrialEndAction};
-       
-      billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
-       
-      shipping_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
-       
-      customer?:{registered_for_gst?:boolean,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
-       
-      subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,proration_type?:ProrationType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
-       
-      discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
-       
-      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}[];
-       
-      changes_scheduled_at?:number;
-       
-      change_option?:ChangeOption;
-       
-      mandatory_items_to_remove?:string[];
-       
-      replace_items_list?:boolean;
-       
-      invoice_date?:number;
-       
-      billing_cycles?:number;
-       
-      terms_to_charge?:number;
-       
-      reactivate_from?:number;
-       
-      billing_alignment_mode?:BillingAlignmentMode;
-       
-      coupon_ids?:string[];
-       
-      replace_coupon_list?:boolean;
-       
-      prorate?:boolean;
-       
-      end_of_term?:boolean;
-       
-      force_term_reset?:boolean;
-       
-      reactivate?:boolean;
-       
-      include_delayed_charges?:boolean;
-       
-      use_existing_balances?:boolean;
-       
-      invoice_immediately?:boolean;
-       
-      invoice_usages?:boolean;
-    }
-    export interface RenewalEstimateResponse {  
-       estimate:Estimate;
+      changes_scheduled_at?: number;
+      change_option?: ChangeOption;
+      mandatory_items_to_remove?: string[];
+      replace_items_list?: boolean;
+      invoice_date?: number;
+      billing_cycles?: number;
+      terms_to_charge?: number;
+      reactivate_from?: number;
+      billing_alignment_mode?: BillingAlignmentMode;
+      coupon_ids?: string[];
+      replace_coupon_list?: boolean;
+      prorate?: boolean;
+      end_of_term?: boolean;
+      force_term_reset?: boolean;
+      reactivate?: boolean;
+      include_delayed_charges?: boolean;
+      use_existing_balances?: boolean;
+      invoice_immediately?: boolean;
+      invoice_usages?: boolean;
+      subscription?: SubscriptionUpdateSubscriptionForItemsInputParam;
+      billing_address?: BillingAddressUpdateSubscriptionForItemsInputParam;
+      shipping_address?: ShippingAddressUpdateSubscriptionForItemsInputParam;
+      customer?: CustomerUpdateSubscriptionForItemsInputParam;
+      subscription_items?: SubscriptionItemsUpdateSubscriptionForItemsInputParam[];
+      discounts?: DiscountsUpdateSubscriptionForItemsInputParam[];
+      item_tiers?: ItemTiersUpdateSubscriptionForItemsInputParam[];
     }
     export interface RenewalEstimateInputParam {
-       
-      include_delayed_charges?:boolean;
-       
-      use_existing_balances?:boolean;
-       
-      ignore_scheduled_cancellation?:boolean;
-       
-      ignore_scheduled_changes?:boolean;
-    }
-    export interface AdvanceInvoiceEstimateResponse {  
-       estimate:Estimate;
+      include_delayed_charges?: boolean;
+      use_existing_balances?: boolean;
+      ignore_scheduled_cancellation?: boolean;
+      ignore_scheduled_changes?: boolean;
     }
     export interface AdvanceInvoiceEstimateInputParam {
-       
-      fixed_interval_schedule?:{days_before_renewal?:number,end_date?:number,end_schedule_on?:EndScheduleOn,number_of_occurrences?:number};
-       
-      specific_dates_schedule?:{date?:number,terms_to_charge?:number}[];
-       
-      terms_to_charge?:number;
-       
-      invoice_immediately?:boolean;
-       
-      schedule_type?:ScheduleType;
-    }
-    export interface RegenerateInvoiceEstimateResponse {  
-       estimate:Estimate;
+      terms_to_charge?: number;
+      invoice_immediately?: boolean;
+      schedule_type?: ScheduleType;
+      fixed_interval_schedule?: FixedIntervalScheduleAdvanceInvoiceEstimateInputParam;
+      specific_dates_schedule?: SpecificDatesScheduleAdvanceInvoiceEstimateInputParam[];
     }
     export interface RegenerateInvoiceEstimateInputParam {
-       
-      date_from?:number;
-       
-      date_to?:number;
-       
-      prorate?:boolean;
-       
-      invoice_immediately?:boolean;
-    }
-    export interface UpcomingInvoicesEstimateResponse {  
-       estimate:Estimate;
-    }
-    
-    export interface ChangeTermEndResponse {  
-       estimate:Estimate;
+      date_from?: number;
+      date_to?: number;
+      prorate?: boolean;
+      invoice_immediately?: boolean;
     }
     export interface ChangeTermEndInputParam {
-       
-      term_ends_at:number;
-       
-      prorate?:boolean;
-       
-      invoice_immediately?:boolean;
-    }
-    export interface CancelSubscriptionResponse {  
-       estimate:Estimate;
+      term_ends_at: number;
+      prorate?: boolean;
+      invoice_immediately?: boolean;
     }
     export interface CancelSubscriptionInputParam {
-       
-      cancel_option?:CancelOption;
-       
-      end_of_term?:boolean;
-       
-      cancel_at?:number;
-       
-      credit_option_for_current_term_charges?:CreditOptionForCurrentTermCharges;
-       
-      unbilled_charges_option?:UnbilledChargesOption;
-       
-      account_receivables_handling?:AccountReceivablesHandling;
-       
-      refundable_credits_handling?:RefundableCreditsHandling;
-       
-      contract_term_cancel_option?:ContractTermCancelOption;
-       
-      invoice_date?:number;
-       
-      event_based_addons?:{id?:string,quantity?:number,service_period_in_days?:number,unit_price?:number}[];
-       
-      cancel_reason_code?:string;
-    }
-    export interface CancelSubscriptionForItemsResponse {  
-       estimate:Estimate;
+      cancel_option?: CancelOption;
+      end_of_term?: boolean;
+      cancel_at?: number;
+      credit_option_for_current_term_charges?: CreditOptionForCurrentTermCharges;
+      unbilled_charges_option?: UnbilledChargesOption;
+      account_receivables_handling?: AccountReceivablesHandling;
+      refundable_credits_handling?: RefundableCreditsHandling;
+      contract_term_cancel_option?: ContractTermCancelOption;
+      invoice_date?: number;
+      cancel_reason_code?: string;
+      event_based_addons?: EventBasedAddonsCancelSubscriptionInputParam[];
     }
     export interface CancelSubscriptionForItemsInputParam {
-       
-      cancel_option?:CancelOption;
-       
-      end_of_term?:boolean;
-       
-      cancel_at?:number;
-       
-      credit_option_for_current_term_charges?:CreditOptionForCurrentTermCharges;
-       
-      unbilled_charges_option?:UnbilledChargesOption;
-       
-      account_receivables_handling?:AccountReceivablesHandling;
-       
-      refundable_credits_handling?:RefundableCreditsHandling;
-       
-      contract_term_cancel_option?:ContractTermCancelOption;
-       
-      invoice_date?:number;
-       
-      subscription_items?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
-       
-      cancel_reason_code?:string;
-    }
-    export interface PauseSubscriptionResponse {  
-       estimate:Estimate;
+      cancel_option?: CancelOption;
+      end_of_term?: boolean;
+      cancel_at?: number;
+      credit_option_for_current_term_charges?: CreditOptionForCurrentTermCharges;
+      unbilled_charges_option?: UnbilledChargesOption;
+      account_receivables_handling?: AccountReceivablesHandling;
+      refundable_credits_handling?: RefundableCreditsHandling;
+      contract_term_cancel_option?: ContractTermCancelOption;
+      invoice_date?: number;
+      cancel_reason_code?: string;
+      subscription_items?: SubscriptionItemsCancelSubscriptionForItemsInputParam[];
     }
     export interface PauseSubscriptionInputParam {
-       
-      subscription?:{pause_date?:number,resume_date?:number,skip_billing_cycles?:number};
-       
-      pause_option?:PauseOption;
-       
-      unbilled_charges_handling?:UnbilledChargesHandling;
-    }
-    export interface ResumeSubscriptionResponse {  
-       estimate:Estimate;
+      pause_option?: PauseOption;
+      unbilled_charges_handling?: UnbilledChargesHandling;
+      subscription?: SubscriptionPauseSubscriptionInputParam;
     }
     export interface ResumeSubscriptionInputParam {
-       
-      subscription?:{resume_date?:number};
-       
-      resume_option?:ResumeOption;
-       
-      charges_handling?:ChargesHandling;
-    }
-    export interface GiftSubscriptionResponse {  
-       estimate:Estimate;
+      resume_option?: ResumeOption;
+      charges_handling?: ChargesHandling;
+      subscription?: SubscriptionResumeSubscriptionInputParam;
     }
     export interface GiftSubscriptionInputParam {
-       
-      gift?:{auto_claim?:boolean,claim_expiry_date?:number,no_expiry?:boolean,scheduled_at?:number};
-       
-      gifter:{customer_id:string,note?:string,payment_src_id?:string,signature:string};
-       
-      gift_receiver:{customer_id:string,email:string,first_name:string,last_name: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',reference_id?:string};
-       
-      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};
-       
-      subscription:{plan_id:string,plan_quantity?:number,plan_quantity_in_decimal?:string};
-       
-      addons?:{id?:string,quantity?:number,quantity_in_decimal?:string}[];
-       
-      coupon_ids?:string[];
-    }
-    export interface GiftSubscriptionForItemsResponse {  
-       estimate:Estimate;
+      coupon_ids?: string[];
+      gift?: GiftGiftSubscriptionInputParam;
+      gifter?: GifterGiftSubscriptionInputParam;
+      gift_receiver?: GiftReceiverGiftSubscriptionInputParam;
+      payment_intent?: PaymentIntentGiftSubscriptionInputParam;
+      shipping_address?: ShippingAddressGiftSubscriptionInputParam;
+      subscription?: SubscriptionGiftSubscriptionInputParam;
+      addons?: AddonsGiftSubscriptionInputParam[];
     }
     export interface GiftSubscriptionForItemsInputParam {
-       
-      gift?:{auto_claim?:boolean,claim_expiry_date?:number,no_expiry?:boolean,scheduled_at?:number};
-       
-      gifter:{customer_id:string,note?:string,payment_src_id?:string,signature:string};
-       
-      gift_receiver:{customer_id:string,email:string,first_name:string,last_name: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',reference_id?:string};
-       
-      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};
-       
-      subscription_items?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string}[];
-       
-      coupon_ids?:string[];
-    }
-    export interface CreateInvoiceResponse {  
-       estimate:Estimate;
+      coupon_ids?: string[];
+      gift?: GiftGiftSubscriptionForItemsInputParam;
+      gifter?: GifterGiftSubscriptionForItemsInputParam;
+      gift_receiver?: GiftReceiverGiftSubscriptionForItemsInputParam;
+      payment_intent?: PaymentIntentGiftSubscriptionForItemsInputParam;
+      shipping_address?: ShippingAddressGiftSubscriptionForItemsInputParam;
+      subscription_items?: SubscriptionItemsGiftSubscriptionForItemsInputParam[];
     }
     export interface CreateInvoiceInputParam {
-       
-      invoice?:{customer_id?:string,po_number?:string,subscription_id?:string};
-       
-      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};
-       
-      addons?:{date_from?:number,date_to?:number,id?:string,quantity?:number,quantity_in_decimal?:string,unit_price?:number,unit_price_in_decimal?: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}[];
-       
-      notes_to_remove?:{entity_id?:string,entity_type?:EntityType}[];
-       
-      tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
-       
-      currency_code?:string;
-       
-      invoice_note?:string;
-       
-      remove_general_note?:boolean;
-       
-      coupon?:string;
-       
-      coupon_ids?:string[];
-       
-      authorization_transaction_id?:string;
-       
-      payment_source_id?:string;
-       
-      auto_collection?:AutoCollection;
-       
-      invoice_date?:number;
-    }
-    export interface CreateInvoiceForItemsResponse {  
-       estimate:Estimate;
+      currency_code?: string;
+      invoice_note?: string;
+      remove_general_note?: boolean /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      coupon?: string;
+      coupon_ids?: string[];
+      authorization_transaction_id?: string;
+      payment_source_id?: string;
+      auto_collection?: AutoCollection;
+      invoice_date?: number;
+      invoice?: InvoiceCreateInvoiceInputParam;
+      shipping_address?: ShippingAddressCreateInvoiceInputParam;
+      addons?: AddonsCreateInvoiceInputParam[];
+      charges?: ChargesCreateInvoiceInputParam[];
+      notes_to_remove?: NotesToRemoveCreateInvoiceInputParam[];
+      tax_providers_fields?: TaxProvidersFieldsCreateInvoiceInputParam[];
     }
     export interface CreateInvoiceForItemsInputParam {
-       
-      invoice?:{customer_id?:string,po_number?:string,subscription_id?:string};
-       
-      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};
-       
-      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}[];
-       
-      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}[];
-       
-      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}[];
-       
-      notes_to_remove?:{entity_id?:string,entity_type?:EntityType}[];
-       
-      discounts:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
-       
-      tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
-       
-      currency_code?:string;
-       
-      invoice_note?:string;
-       
-      remove_general_note?:boolean;
-       
-      coupon?:string;
-       
-      coupon_ids?:string[];
-       
-      authorization_transaction_id?:string;
-       
-      payment_source_id?:string;
-       
-      auto_collection?:AutoCollection;
-       
-      invoice_date?:number;
-    }
-    
+      currency_code?: string;
+      invoice_note?: string;
+      remove_general_note?: boolean /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      coupon?: string;
+      coupon_ids?: string[];
+      authorization_transaction_id?: string;
+      payment_source_id?: string;
+      auto_collection?: AutoCollection;
+      invoice_date?: number;
+      invoice?: InvoiceCreateInvoiceForItemsInputParam;
+      shipping_address?: ShippingAddressCreateInvoiceForItemsInputParam;
+      item_prices?: ItemPricesCreateInvoiceForItemsInputParam[];
+      item_tiers?: ItemTiersCreateInvoiceForItemsInputParam[];
+      charges?: ChargesCreateInvoiceForItemsInputParam[];
+      notes_to_remove?: NotesToRemoveCreateInvoiceForItemsInputParam[];
+      discounts?: DiscountsCreateInvoiceForItemsInputParam[];
+      tax_providers_fields?: TaxProvidersFieldsCreateInvoiceForItemsInputParam[];
+    }
+    export interface BillingAddressCreateSubscriptionInputParam {
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatus;
+    }
+    export interface CustomerCreateSubscriptionInputParam {
+      vat_number?: string;
+      vat_number_prefix?: string;
+      registered_for_gst?: boolean;
+      taxability?: Taxability;
+      entity_code?: EntityCode;
+      exempt_number?: string;
+      exemption_details?: any;
+      customer_type?: CustomerType;
+    }
+    export interface ShippingAddressCreateSubscriptionInputParam {
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatus;
+    }
+    export interface ContractTermCreateSubscriptionInputParam {
+      action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
+      cancellation_cutoff_period?: number;
+    }
+    export interface SubscriptionCreateSubscriptionInputParam {
+      id?: string;
+      plan_id: string;
+      plan_quantity?: number;
+      plan_quantity_in_decimal?: string;
+      plan_unit_price?: number;
+      plan_unit_price_in_decimal?: string;
+      setup_fee?: number;
+      trial_end?: number;
+      start_date?: number;
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      coupon?: string;
+      offline_payment_method?: OfflinePaymentMethod;
+      free_period?: number;
+      free_period_unit?: FreePeriodUnit;
+      contract_term_billing_cycle_on_renewal?: number;
+      trial_end_action?: TrialEndAction;
+    }
+
+    export interface EventBasedAddonsCreateSubscriptionInputParam {
+      id?: string;
+      quantity?: number;
+      unit_price?: number;
+      quantity_in_decimal?: string;
+      unit_price_in_decimal?: string;
+      service_period_in_days?: number;
+      on_event?: OnEvent;
+      charge_once?: boolean;
+      charge_on?: ChargeOn;
+    }
+    export interface AddonsCreateSubscriptionInputParam {
+      id?: string;
+      quantity?: number;
+      quantity_in_decimal?: string;
+      unit_price?: number;
+      unit_price_in_decimal?: string;
+      billing_cycles?: number;
+      trial_end?: number;
+    }
+    export interface TaxProvidersFieldsCreateSubscriptionInputParam {
+      provider_name?: string;
+      field_id?: string;
+      field_value?: string;
+    }
+    export interface BillingAddressCreateSubItemEstimateInputParam {
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatus;
+    }
+    export interface CustomerCreateSubItemEstimateInputParam {
+      vat_number?: string;
+      vat_number_prefix?: string;
+      registered_for_gst?: boolean;
+      taxability?: Taxability;
+      entity_code?: EntityCode;
+      exempt_number?: string;
+      exemption_details?: any;
+      customer_type?: CustomerType;
+    }
+    export interface ShippingAddressCreateSubItemEstimateInputParam {
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatus;
+    }
+    export interface ContractTermCreateSubItemEstimateInputParam {
+      action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      contract_start?: number;
+      cancellation_cutoff_period?: number;
+    }
+    export interface SubscriptionCreateSubItemEstimateInputParam {
+      id?: string;
+      trial_end?: number;
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      setup_fee?: number;
+      start_date?: number;
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      coupon?: string;
+      free_period?: number;
+      free_period_unit?: FreePeriodUnit;
+      contract_term_billing_cycle_on_renewal?: number;
+      trial_end_action?: TrialEndAction;
+    }
+
+    export interface SubscriptionItemsCreateSubItemEstimateInputParam {
+      item_price_id: string;
+      quantity?: number;
+      quantity_in_decimal?: string;
+      unit_price?: number;
+      unit_price_in_decimal?: string;
+      billing_cycles?: number;
+      trial_end?: number;
+      service_period_days?: number;
+      charge_on_event?: ChargeOnEvent;
+      charge_once?: boolean;
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      item_type?: ItemType;
+      charge_on_option?: ChargeOnOption;
+    }
+    export interface DiscountsCreateSubItemEstimateInputParam {
+      apply_on: ApplyOn;
+      duration_type: DurationType;
+      percentage?: number;
+      amount?: number;
+      period?: number;
+      period_unit?: PeriodUnit;
+      included_in_mrr?: boolean;
+      item_price_id?: string;
+    }
+    export interface ItemTiersCreateSubItemEstimateInputParam {
+      item_price_id?: string;
+      starting_unit?: number;
+      ending_unit?: number;
+      price?: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      price_in_decimal?: string;
+    }
+    export interface TaxProvidersFieldsCreateSubItemEstimateInputParam {
+      provider_name?: string;
+      field_id?: string;
+      field_value?: string;
+    }
+    export interface ShippingAddressCreateSubForCustomerEstimateInputParam {
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatus;
+    }
+    export interface ContractTermCreateSubForCustomerEstimateInputParam {
+      action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
+      cancellation_cutoff_period?: number;
+    }
+    export interface SubscriptionCreateSubForCustomerEstimateInputParam {
+      id?: string;
+      plan_id: string;
+      plan_quantity?: number;
+      plan_quantity_in_decimal?: string;
+      plan_unit_price?: number;
+      plan_unit_price_in_decimal?: string;
+      setup_fee?: number;
+      trial_end?: number;
+      start_date?: number;
+      offline_payment_method?: OfflinePaymentMethod;
+      free_period?: number;
+      free_period_unit?: FreePeriodUnit;
+      contract_term_billing_cycle_on_renewal?: number;
+      trial_end_action?: TrialEndAction;
+    }
+
+    export interface EventBasedAddonsCreateSubForCustomerEstimateInputParam {
+      id?: string;
+      quantity?: number;
+      unit_price?: number;
+      quantity_in_decimal?: string;
+      unit_price_in_decimal?: string;
+      service_period_in_days?: number;
+      on_event?: OnEvent;
+      charge_once?: boolean;
+      charge_on?: ChargeOn;
+    }
+    export interface AddonsCreateSubForCustomerEstimateInputParam {
+      id?: string;
+      quantity?: number;
+      quantity_in_decimal?: string;
+      unit_price?: number;
+      unit_price_in_decimal?: string;
+      billing_cycles?: number;
+      trial_end?: number;
+    }
+    export interface BillingAddressCreateSubItemForCustomerEstimateInputParam {
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatus;
+    }
+    export interface ShippingAddressCreateSubItemForCustomerEstimateInputParam {
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatus;
+    }
+    export interface ContractTermCreateSubItemForCustomerEstimateInputParam {
+      action_at_term_end?: 'renew' | 'evergreen' | 'cancel';
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      contract_start?: number;
+      cancellation_cutoff_period?: number;
+    }
+    export interface SubscriptionCreateSubItemForCustomerEstimateInputParam {
+      id?: string;
+      trial_end?: number;
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      setup_fee?: number;
+      start_date?: number;
+      free_period?: number;
+      free_period_unit?: FreePeriodUnit;
+      contract_term_billing_cycle_on_renewal?: number;
+      trial_end_action?: TrialEndAction;
+    }
+
+    export interface SubscriptionItemsCreateSubItemForCustomerEstimateInputParam {
+      item_price_id: string;
+      quantity?: number;
+      quantity_in_decimal?: string;
+      unit_price?: number;
+      unit_price_in_decimal?: string;
+      billing_cycles?: number;
+      trial_end?: number;
+      service_period_days?: number;
+      charge_on_event?: ChargeOnEvent;
+      charge_once?: boolean;
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      item_type?: ItemType;
+      charge_on_option?: ChargeOnOption;
+    }
+    export interface DiscountsCreateSubItemForCustomerEstimateInputParam {
+      apply_on: ApplyOn;
+      duration_type: DurationType;
+      percentage?: number;
+      amount?: number;
+      period?: number;
+      period_unit?: PeriodUnit;
+      included_in_mrr?: boolean;
+      item_price_id?: string;
+    }
+    export interface ItemTiersCreateSubItemForCustomerEstimateInputParam {
+      item_price_id?: string;
+      starting_unit?: number;
+      ending_unit?: number;
+      price?: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      price_in_decimal?: string;
+    }
+    export interface BillingAddressUpdateSubscriptionInputParam {
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatus;
+    }
+    export interface CustomerUpdateSubscriptionInputParam {
+      vat_number?: string;
+      vat_number_prefix?: string;
+      registered_for_gst?: boolean;
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      taxability?: Taxability;
+    }
+    export interface ShippingAddressUpdateSubscriptionInputParam {
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatus;
+    }
+    export interface SubscriptionUpdateSubscriptionInputParam {
+      id: string;
+      plan_id?: string;
+      plan_quantity?: number;
+      plan_unit_price?: number;
+      setup_fee?: number;
+      plan_quantity_in_decimal?: string;
+      plan_unit_price_in_decimal?: string;
+      start_date?: number;
+      trial_end?: number;
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      coupon?: string;
+      auto_collection?: AutoCollection;
+      offline_payment_method?: OfflinePaymentMethod;
+      free_period?: number;
+      free_period_unit?: FreePeriodUnit;
+      trial_end_action?: TrialEndAction;
+    }
+
+    export interface EventBasedAddonsUpdateSubscriptionInputParam {
+      id?: string;
+      quantity?: number;
+      unit_price?: number;
+      service_period_in_days?: number;
+      charge_on?: ChargeOn;
+      on_event?: OnEvent;
+      charge_once?: boolean;
+      quantity_in_decimal?: string;
+      unit_price_in_decimal?: string;
+    }
+    export interface AddonsUpdateSubscriptionInputParam {
+      id?: string;
+      quantity?: number;
+      unit_price?: number;
+      billing_cycles?: number;
+      quantity_in_decimal?: string;
+      unit_price_in_decimal?: string;
+      trial_end?: number;
+      proration_type?: ProrationType;
+    }
+    export interface BillingAddressUpdateSubscriptionForItemsInputParam {
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatus;
+    }
+    export interface CustomerUpdateSubscriptionForItemsInputParam {
+      vat_number?: string;
+      vat_number_prefix?: string;
+      registered_for_gst?: boolean;
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      taxability?: Taxability;
+    }
+    export interface ShippingAddressUpdateSubscriptionForItemsInputParam {
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatus;
+    }
+    export interface SubscriptionUpdateSubscriptionForItemsInputParam {
+      id: string;
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      setup_fee?: number;
+      start_date?: number;
+      trial_end?: number;
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      coupon?: string;
+      auto_collection?: AutoCollection;
+      offline_payment_method?: OfflinePaymentMethod;
+      free_period?: number;
+      free_period_unit?: FreePeriodUnit;
+      trial_end_action?: TrialEndAction;
+    }
+
+    export interface SubscriptionItemsUpdateSubscriptionForItemsInputParam {
+      item_price_id: string;
+      quantity?: number;
+      quantity_in_decimal?: string;
+      unit_price?: number;
+      unit_price_in_decimal?: string;
+      billing_cycles?: number;
+      trial_end?: number;
+      service_period_days?: number;
+      charge_on_event?: ChargeOnEvent;
+      charge_once?: boolean;
+      charge_on_option?: ChargeOnOption;
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      item_type?: ItemType;
+      proration_type?: ProrationType;
+    }
+    export interface DiscountsUpdateSubscriptionForItemsInputParam {
+      apply_on: ApplyOn;
+      duration_type: DurationType;
+      percentage?: number;
+      amount?: number;
+      period?: number;
+      period_unit?: PeriodUnit;
+      included_in_mrr?: boolean;
+      item_price_id?: string;
+      operation_type: OperationType;
+      id?: string;
+    }
+    export interface ItemTiersUpdateSubscriptionForItemsInputParam {
+      item_price_id?: string;
+      starting_unit?: number;
+      ending_unit?: number;
+      price?: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      price_in_decimal?: string;
+    }
+    export interface FixedIntervalScheduleAdvanceInvoiceEstimateInputParam {
+      number_of_occurrences?: number;
+      days_before_renewal?: number;
+      end_schedule_on?: EndScheduleOn;
+      end_date?: number;
+    }
+
+    export interface SpecificDatesScheduleAdvanceInvoiceEstimateInputParam {
+      terms_to_charge?: number;
+      date?: number;
+    }
+    export interface EventBasedAddonsCancelSubscriptionInputParam {
+      id?: string;
+      quantity?: number;
+      unit_price?: number;
+      service_period_in_days?: number;
+    }
+    export interface SubscriptionItemsCancelSubscriptionForItemsInputParam {
+      item_price_id?: string;
+      quantity?: number;
+      quantity_in_decimal?: string;
+      unit_price?: number;
+      unit_price_in_decimal?: string;
+      service_period_days?: number;
+    }
+    export interface SubscriptionPauseSubscriptionInputParam {
+      pause_date?: number;
+      resume_date?: number;
+      skip_billing_cycles?: number;
+    }
+
+    export interface SubscriptionResumeSubscriptionInputParam {
+      resume_date?: number;
+    }
+
+    export interface GiftGiftSubscriptionInputParam {
+      scheduled_at?: number;
+      auto_claim?: boolean;
+      no_expiry?: boolean;
+      claim_expiry_date?: number;
+    }
+    export interface GiftReceiverGiftSubscriptionInputParam {
+      customer_id: string;
+      first_name: string;
+      last_name: string;
+      email: string;
+    }
+    export interface GifterGiftSubscriptionInputParam {
+      customer_id: string;
+      signature: string;
+      note?: string;
+      payment_src_id?: string;
+    }
+    export interface ShippingAddressGiftSubscriptionInputParam {
+      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;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatus;
+    }
+    export interface PaymentIntentGiftSubscriptionInputParam {
+      id?: string;
+      gateway_account_id?: string;
+      gw_token?: 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;
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      gw_payment_method_id?: string;
+      additional_information?: any;
+    }
+    export interface SubscriptionGiftSubscriptionInputParam {
+      plan_id: string;
+      plan_quantity?: number;
+      plan_quantity_in_decimal?: string;
+    }
+
+    export interface AddonsGiftSubscriptionInputParam {
+      id?: string;
+      quantity?: number;
+      quantity_in_decimal?: string;
+    }
+    export interface GiftGiftSubscriptionForItemsInputParam {
+      scheduled_at?: number;
+      auto_claim?: boolean;
+      no_expiry?: boolean;
+      claim_expiry_date?: number;
+    }
+    export interface GiftReceiverGiftSubscriptionForItemsInputParam {
+      customer_id: string;
+      first_name: string;
+      last_name: string;
+      email: string;
+    }
+    export interface GifterGiftSubscriptionForItemsInputParam {
+      customer_id: string;
+      signature: string;
+      note?: string;
+      payment_src_id?: string;
+    }
+    export interface ShippingAddressGiftSubscriptionForItemsInputParam {
+      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;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatus;
+    }
+    export interface PaymentIntentGiftSubscriptionForItemsInputParam {
+      id?: string;
+      gateway_account_id?: string;
+      gw_token?: 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;
+      /**
+       * @deprecated Please refer API docs to use other attributes
+       */
+      gw_payment_method_id?: string;
+      additional_information?: any;
+    }
+
+    export interface SubscriptionItemsGiftSubscriptionForItemsInputParam {
+      item_price_id?: string;
+      quantity?: number;
+      quantity_in_decimal?: string;
+    }
+    export interface InvoiceCreateInvoiceInputParam {
+      customer_id?: string;
+      subscription_id?: string;
+      po_number?: string;
+    }
+    export interface ShippingAddressCreateInvoiceInputParam {
+      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;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatus;
+    }
+
+    export interface ChargesCreateInvoiceInputParam {
+      amount?: number;
+      amount_in_decimal?: string;
+      description?: string;
+      taxable?: boolean;
+      tax_profile_id?: string;
+      avalara_tax_code?: string;
+      hsn_code?: string;
+      taxjar_product_code?: string;
+      avalara_sale_type?: AvalaraSaleType;
+      avalara_transaction_type?: number;
+      avalara_service_type?: number;
+      date_from?: number;
+      date_to?: number;
+    }
+    export interface AddonsCreateInvoiceInputParam {
+      id?: string;
+      quantity?: number;
+      quantity_in_decimal?: string;
+      unit_price?: number;
+      unit_price_in_decimal?: string;
+      date_from?: number;
+      date_to?: number;
+    }
+    export interface TaxProvidersFieldsCreateInvoiceInputParam {
+      provider_name?: string;
+      field_id?: string;
+      field_value?: string;
+    }
+    export interface NotesToRemoveCreateInvoiceInputParam {
+      entity_type?: EntityType;
+      entity_id?: string;
+    }
+    export interface InvoiceCreateInvoiceForItemsInputParam {
+      customer_id?: string;
+      subscription_id?: string;
+      po_number?: string;
+    }
+    export interface ShippingAddressCreateInvoiceForItemsInputParam {
+      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;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatus;
+    }
+
+    export interface ChargesCreateInvoiceForItemsInputParam {
+      amount?: number;
+      amount_in_decimal?: string;
+      description?: string;
+      taxable?: boolean;
+      tax_profile_id?: string;
+      avalara_tax_code?: string;
+      hsn_code?: string;
+      taxjar_product_code?: string;
+      avalara_sale_type?: AvalaraSaleType;
+      avalara_transaction_type?: number;
+      avalara_service_type?: number;
+      date_from?: number;
+      date_to?: number;
+    }
+    export interface DiscountsCreateInvoiceForItemsInputParam {
+      percentage?: number;
+      amount?: number;
+      apply_on: ApplyOn;
+      item_price_id?: string;
+    }
+    export interface ItemTiersCreateInvoiceForItemsInputParam {
+      item_price_id?: string;
+      starting_unit?: number;
+      ending_unit?: number;
+      price?: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      price_in_decimal?: string;
+    }
+    export interface ItemPricesCreateInvoiceForItemsInputParam {
+      item_price_id?: string;
+      quantity?: number;
+      quantity_in_decimal?: string;
+      unit_price?: number;
+      unit_price_in_decimal?: string;
+      date_from?: number;
+      date_to?: number;
+    }
+    export interface TaxProvidersFieldsCreateInvoiceForItemsInputParam {
+      provider_name?: string;
+      field_id?: string;
+      field_value?: string;
+    }
+    export interface NotesToRemoveCreateInvoiceForItemsInputParam {
+      entity_type?: EntityType;
+      entity_id?: string;
+    }
   }
-}
+}