chargebee 2.23.1 → 2.25.0

package/types/resources/PaymentVoucher.d.ts

@@ -0,0 +1,74 @@
+declare module 'chargebee' {
+  export interface PaymentVoucher {
+    
+    id:string;
+    id_at_gateway?:string;
+    payment_voucher_type:PaymentVoucherType;
+    expires_at?:number;
+    status?:'consumed' | 'expired' | 'failure' | 'active';
+    subscription_id?:string;
+    currency_code:string;
+    amount?:number;
+    gateway_account_id?:string;
+    payment_source_id?:string;
+    gateway:Gateway;
+    payload?:string;
+    error_code?:string;
+    error_text?:string;
+    url?:string;
+    date?:number;
+    resource_version?:number;
+    updated_at?:number;
+    customer_id:string;
+    linked_invoices?:PaymentVoucher.InvoicePaymentVoucher[];
+  }
+  export namespace PaymentVoucher {
+    export class PaymentVoucherResource {
+      payment_vouchers_for_customer(customer_id:string, input?:Payment_vouchersForCustomerInputParam):ChargebeeRequest<Payment_vouchersForCustomerResponse>;
+      payment_vouchers_for_invoice(invoice_id:string, input?:Payment_vouchersForInvoiceInputParam):ChargebeeRequest<Payment_vouchersForInvoiceResponse>;
+      retrieve(payment_voucher_id:string):ChargebeeRequest<RetrieveResponse>;
+      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
+    }
+    export interface Payment_vouchersForCustomerResponse {
+      list:{payment_voucher:PaymentVoucher}[];
+      next_offset?:string;
+    }
+    export interface Payment_vouchersForCustomerInputParam {
+      [key: string]: string | number | object | boolean;
+      limit?:number;
+      offset?:string;
+      status?:{in?:string,is?:'consumed' | 'expired' | 'failure' | 'active',is_not?:'consumed' | 'expired' | 'failure' | 'active',not_in?:string};
+      sort_by?:{asc?:'date' | 'updated_at',desc?:'date' | 'updated_at'};
+    }
+    export interface Payment_vouchersForInvoiceResponse {
+      list:{payment_voucher:PaymentVoucher}[];
+      next_offset?:string;
+    }
+    export interface Payment_vouchersForInvoiceInputParam {
+      [key: string]: string | number | object | boolean;
+      limit?:number;
+      offset?:string;
+      status?:{in?:string,is?:'consumed' | 'expired' | 'failure' | 'active',is_not?:'consumed' | 'expired' | 'failure' | 'active',not_in?:string};
+      sort_by?:{asc?:'date' | 'updated_at',desc?:'date' | 'updated_at'};
+    }
+    export interface RetrieveResponse {
+      payment_voucher:PaymentVoucher;
+    }
+    
+    export interface CreateResponse {
+      payment_voucher:PaymentVoucher;
+    }
+    export interface CreateInputParam {
+      
+      customer_id:string;
+      payment_source_id?:string;
+      voucher_payment_source?:{voucher_type:VoucherType};
+      invoice_allocations?:{invoice_id:string}[];
+    }
+    export interface InvoicePaymentVoucher {
+      invoice_id?:string;
+      txn_id?:string;
+      applied_at?:number;
+    }
+  }
+}

package/types/resources/PortalSession.d.ts

@@ -0,0 +1,57 @@
+declare module 'chargebee' {
+  export interface PortalSession {
+    
+    id:string;
+    token:string;
+    access_url:string;
+    redirect_url?:string;
+    status:'not_yet_activated' | 'created' | 'logged_in' | 'logged_out' | 'activated';
+    created_at:number;
+    expires_at?:number;
+    customer_id:string;
+    login_at?:number;
+    logout_at?:number;
+    login_ipaddress?:string;
+    logout_ipaddress?:string;
+    linked_customers?:PortalSession.LinkedCustomer[];
+  }
+  export namespace PortalSession {
+    export class PortalSessionResource {
+      create(input?:CreateInputParam):ChargebeeRequest<CreateResponse>;
+      activate(portal_session_id:string, input:ActivateInputParam):ChargebeeRequest<ActivateResponse>;
+      logout(portal_session_id:string):ChargebeeRequest<LogoutResponse>;
+      retrieve(portal_session_id:string):ChargebeeRequest<RetrieveResponse>;
+    }
+    export interface CreateResponse {
+      portal_session:PortalSession;
+    }
+    export interface CreateInputParam {
+      
+      redirect_url?:string;
+      forward_url?:string;
+      customer?:{id:string};
+    }
+    export interface ActivateResponse {
+      portal_session:PortalSession;
+    }
+    export interface ActivateInputParam {
+      
+      token:string;
+    }
+    export interface LogoutResponse {
+      portal_session:PortalSession;
+    }
+    
+    export interface RetrieveResponse {
+      portal_session:PortalSession;
+    }
+    
+    export interface LinkedCustomer {
+      customer_id?:string;
+      email?:string;
+      has_billing_address?:boolean;
+      has_payment_method?:boolean;
+      has_active_subscription?:boolean;
+    }
+  }
+}

package/types/resources/PromotionalCredit.d.ts

@@ -0,0 +1,86 @@
+declare module 'chargebee' {
+  export interface PromotionalCredit {
+    
+    id:string;
+    customer_id:string;
+    type:'decrement' | 'increment';
+    amount_in_decimal?:string;
+    amount:number;
+    currency_code:string;
+    description:string;
+    credit_type:CreditType;
+    reference?:string;
+    closing_balance:number;
+    done_by?:string;
+    created_at:number;
+  }
+  export namespace PromotionalCredit {
+    export class PromotionalCreditResource {
+      retrieve(account_credit_id:string):ChargebeeRequest<RetrieveResponse>;
+      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+      deduct(input:DeductInputParam):ChargebeeRequest<DeductResponse>;
+      set(input:SetInputParam):ChargebeeRequest<SetResponse>;
+      add(input:AddInputParam):ChargebeeRequest<AddResponse>;
+    }
+    export interface RetrieveResponse {
+      promotional_credit:PromotionalCredit;
+    }
+    
+    export interface ListResponse {
+      list:{promotional_credit:PromotionalCredit}[];
+      next_offset?:string;
+    }
+    export interface ListInputParam {
+      [key: string]: string | number | object | boolean;
+      limit?:number;
+      offset?:string;
+      id?:{is?:string,is_not?:string,starts_with?:string};
+      created_at?:{after?:string,before?:string,between?:string,on?:string};
+      type?:{in?:string,is?:'decrement' | 'increment',is_not?:'decrement' | 'increment',not_in?:string};
+      customer_id?:{is?:string,is_not?:string,starts_with?:string};
+    }
+    export interface DeductResponse {
+      customer:Customer;
+      promotional_credit:PromotionalCredit;
+    }
+    export interface DeductInputParam {
+      
+      customer_id:string;
+      amount?:number;
+      amount_in_decimal?:string;
+      currency_code?:string;
+      description:string;
+      credit_type?:CreditType;
+      reference?:string;
+    }
+    export interface SetResponse {
+      customer:Customer;
+      promotional_credit:PromotionalCredit;
+    }
+    export interface SetInputParam {
+      
+      customer_id:string;
+      amount?:number;
+      amount_in_decimal?:string;
+      currency_code?:string;
+      description:string;
+      credit_type?:CreditType;
+      reference?:string;
+    }
+    export interface AddResponse {
+      customer:Customer;
+      promotional_credit:PromotionalCredit;
+    }
+    export interface AddInputParam {
+      
+      customer_id:string;
+      amount?:number;
+      amount_in_decimal?:string;
+      currency_code?:string;
+      description:string;
+      credit_type?:CreditType;
+      reference?:string;
+    }
+    
+  }
+}

package/types/resources/Purchase.d.ts

@@ -0,0 +1,46 @@
+declare module 'chargebee' {
+  export interface Purchase {
+    
+    id?:string;
+    customer_id:string;
+    created_at?:number;
+    modified_at?:number;
+    subscription_ids?:string[];
+    invoice_ids?:string[];
+  }
+  export namespace Purchase {
+    export class PurchaseResource {
+      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
+      estimate(input?:EstimateInputParam):ChargebeeRequest<EstimateResponse>;
+    }
+    export interface CreateResponse {
+      purchase:Purchase;
+    }
+    export interface CreateInputParam {
+      
+      customer_id:string;
+      invoice_info?:{notes?:string,po_number?:string};
+      purchase_items?:{index:number,item_price_id:string,quantity?:number,quantity_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
+      item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,index:number,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
+      shipping_addresses?:{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}[];
+      discounts?:{amount?:number,coupon_id?:string,included_in_mrr?:boolean,index?:number,percentage?:number}[];
+      subscription_info?:{billing_cycles?:number,index:number,meta_data?:object,subscription_id?:string}[];
+    }
+    export interface EstimateResponse {
+      estimate:Estimate;
+    }
+    export interface EstimateInputParam {
+      
+      client_profile_id?:string;
+      customer_id?: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};
+      billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
+      purchase_items?:{index:number,item_price_id:string,quantity?:number,quantity_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
+      item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,index:number,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
+      shipping_addresses?:{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}[];
+      discounts?:{amount?:number,coupon_id?:string,included_in_mrr?:boolean,index?:number,percentage?:number}[];
+      subscription_info?:{billing_cycles?:number,index:number,subscription_id?:string}[];
+    }
+    
+  }
+}

package/types/resources/Quote.d.ts

@@ -0,0 +1,388 @@
+declare module 'chargebee' {
+  export interface Quote {
+    
+    id:string;
+    name?:string;
+    po_number?:string;
+    customer_id:string;
+    subscription_id?:string;
+    invoice_id?:string;
+    status:'declined' | 'invoiced' | 'accepted' | 'closed' | 'open';
+    operation_type:'onetime_invoice' | 'change_subscription' | 'create_subscription_for_customer';
+    vat_number?:string;
+    price_type:PriceType;
+    valid_till:number;
+    date:number;
+    total_payable?:number;
+    charge_on_acceptance?:number;
+    sub_total:number;
+    total?:number;
+    credits_applied?:number;
+    amount_paid?:number;
+    amount_due?:number;
+    version?:number;
+    resource_version?:number;
+    updated_at?:number;
+    vat_number_prefix?:string;
+    tax_category?:string;
+    currency_code:string;
+    notes?:any[];
+    contract_term_start?:number;
+    contract_term_end?:number;
+    contract_term_termination_fee?:number;
+    business_entity_id:string;
+    line_items?:Quote.LineItem[];
+    discounts?:Quote.Discount[];
+    line_item_discounts?:Quote.LineItemDiscount[];
+    taxes?:Quote.Tax[];
+    line_item_taxes?:Quote.LineItemTax[];
+    line_item_tiers?:Quote.LineItemTier[];
+    shipping_address?:Quote.ShippingAddress;
+    billing_address?:Quote.BillingAddress;
+  }
+  export namespace Quote {
+    export class QuoteResource {
+      create_sub_items_for_customer_quote(customer_id:string, input?:CreateSubItemsForCustomerQuoteInputParam):ChargebeeRequest<CreateSubItemsForCustomerQuoteResponse>;
+      retrieve(quote_id:string):ChargebeeRequest<RetrieveResponse>;
+      edit_create_sub_customer_quote_for_items(quote_id:string, input?:EditCreateSubCustomerQuoteForItemsInputParam):ChargebeeRequest<EditCreateSubCustomerQuoteForItemsResponse>;
+      update_status(quote_id:string, input:UpdateStatusInputParam):ChargebeeRequest<UpdateStatusResponse>;
+      update_subscription_quote_for_items(input?:UpdateSubscriptionQuoteForItemsInputParam):ChargebeeRequest<UpdateSubscriptionQuoteForItemsResponse>;
+      quote_line_groups_for_quote(quote_id:string, input?:QuoteLineGroupsForQuoteInputParam):ChargebeeRequest<QuoteLineGroupsForQuoteResponse>;
+      extend_expiry_date(quote_id:string, input:ExtendExpiryDateInputParam):ChargebeeRequest<ExtendExpiryDateResponse>;
+      edit_for_charge_items_and_charges(quote_id:string, input?:EditForChargeItemsAndChargesInputParam):ChargebeeRequest<EditForChargeItemsAndChargesResponse>;
+      edit_update_subscription_quote_for_items(quote_id:string, input?:EditUpdateSubscriptionQuoteForItemsInputParam):ChargebeeRequest<EditUpdateSubscriptionQuoteForItemsResponse>;
+      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+      pdf(quote_id:string, input?:PdfInputParam):ChargebeeRequest<PdfResponse>;
+      convert(quote_id:string, input?:ConvertInputParam):ChargebeeRequest<ConvertResponse>;
+      create_for_charge_items_and_charges(input:CreateForChargeItemsAndChargesInputParam):ChargebeeRequest<CreateForChargeItemsAndChargesResponse>;
+      delete(quote_id:string, input?:DeleteInputParam):ChargebeeRequest<DeleteResponse>;
+    }
+    export interface CreateSubItemsForCustomerQuoteResponse {
+      quote:Quote;
+      quoted_subscription?:QuotedSubscription;
+    }
+    export interface CreateSubItemsForCustomerQuoteInputParam {
+      
+      name?:string;
+      notes?:string;
+      expires_at?:number;
+      billing_cycles?:number;
+      mandatory_items_to_remove?:string[];
+      terms_to_charge?:number;
+      billing_alignment_mode?:BillingAlignmentMode;
+      coupon_ids?:string[];
+      subscription?:{contract_term_billing_cycle_on_renewal?:number,id?:string,po_number?:string,start_date?:number,trial_end?:number};
+      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};
+      contract_term?:{action_at_term_end?:'cancel' | 'renew' | 'evergreen',cancellation_cutoff_period?:number};
+      subscription_items?:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,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}[];
+    }
+    export interface RetrieveResponse {
+      quote:Quote;
+      quoted_subscription?:QuotedSubscription;
+      quoted_charge?:QuotedCharge;
+    }
+    
+    export interface EditCreateSubCustomerQuoteForItemsResponse {
+      quote:Quote;
+      quoted_subscription?:QuotedSubscription;
+    }
+    export interface EditCreateSubCustomerQuoteForItemsInputParam {
+      
+      notes?:string;
+      expires_at?:number;
+      billing_cycles?:number;
+      mandatory_items_to_remove?:string[];
+      terms_to_charge?:number;
+      billing_alignment_mode?:BillingAlignmentMode;
+      coupon_ids?:string[];
+      subscription?:{contract_term_billing_cycle_on_renewal?:number,id?:string,start_date?:number,trial_end?:number};
+      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};
+      contract_term?:{action_at_term_end?:'cancel' | 'renew' | 'evergreen',cancellation_cutoff_period?:number};
+      subscription_items?:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,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}[];
+    }
+    export interface UpdateStatusResponse {
+      quote:Quote;
+      quoted_subscription?:QuotedSubscription;
+      quoted_charge?:QuotedCharge;
+    }
+    export interface UpdateStatusInputParam {
+      
+      status:'declined' | 'accepted' | 'closed';
+      comment?:string;
+    }
+    export interface UpdateSubscriptionQuoteForItemsResponse {
+      quote:Quote;
+      quoted_subscription?:QuotedSubscription;
+    }
+    export interface UpdateSubscriptionQuoteForItemsInputParam {
+      
+      name?:string;
+      notes?:string;
+      expires_at?:number;
+      mandatory_items_to_remove?:string[];
+      replace_items_list?:boolean;
+      billing_cycles?:number;
+      terms_to_charge?:number;
+      reactivate_from?:number;
+      billing_alignment_mode?:BillingAlignmentMode;
+      coupon_ids?:string[];
+      replace_coupon_list?:boolean;
+      change_option?:ChangeOption;
+      changes_scheduled_at?:number;
+      force_term_reset?:boolean;
+      reactivate?:boolean;
+      subscription?:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,id:string,offline_payment_method?:OfflinePaymentMethod,start_date?:number,trial_end?:number};
+      billing_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};
+      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};
+      customer?:{registered_for_gst?:boolean,vat_number?:string,vat_number_prefix?:string};
+      contract_term?:{action_at_term_end?:'cancel' | 'renew_once' | 'renew' | 'evergreen',cancellation_cutoff_period?:number};
+      subscription_items?:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,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}[];
+    }
+    export interface QuoteLineGroupsForQuoteResponse {
+      list:{quote_line_group:QuoteLineGroup}[];
+      next_offset?:string;
+    }
+    export interface QuoteLineGroupsForQuoteInputParam {
+      [key: string]: string | number | object | boolean;
+      limit?:number;
+      offset?:string;
+    }
+    export interface ExtendExpiryDateResponse {
+      quote:Quote;
+      quoted_subscription?:QuotedSubscription;
+      quoted_charge?:QuotedCharge;
+    }
+    export interface ExtendExpiryDateInputParam {
+      
+      valid_till:number;
+    }
+    export interface EditForChargeItemsAndChargesResponse {
+      quote:Quote;
+      quoted_charge?:QuotedCharge;
+    }
+    export interface EditForChargeItemsAndChargesInputParam {
+      
+      po_number?:string;
+      notes?:string;
+      expires_at?:number;
+      currency_code?:string;
+      coupon?:string;
+      coupon_ids?: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?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,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_transaction_type?:number,description?:string,service_period?:number}[];
+      discounts?:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
+    }
+    export interface EditUpdateSubscriptionQuoteForItemsResponse {
+      quote:Quote;
+      quoted_subscription?:QuotedSubscription;
+    }
+    export interface EditUpdateSubscriptionQuoteForItemsInputParam {
+      
+      notes?:string;
+      expires_at?:number;
+      mandatory_items_to_remove?:string[];
+      replace_items_list?:boolean;
+      billing_cycles?:number;
+      terms_to_charge?:number;
+      reactivate_from?:number;
+      billing_alignment_mode?:BillingAlignmentMode;
+      coupon_ids?:string[];
+      replace_coupon_list?:boolean;
+      change_option?:ChangeOption;
+      changes_scheduled_at?:number;
+      force_term_reset?:boolean;
+      reactivate?:boolean;
+      subscription?:{auto_collection?:AutoCollection,contract_term_billing_cycle_on_renewal?:number,offline_payment_method?:OfflinePaymentMethod,start_date?:number,trial_end?:number};
+      billing_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};
+      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};
+      customer?:{registered_for_gst?:boolean,vat_number?:string,vat_number_prefix?:string};
+      contract_term?:{action_at_term_end?:'cancel' | 'renew_once' | 'renew' | 'evergreen',cancellation_cutoff_period?:number};
+      subscription_items?:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,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}[];
+    }
+    export interface ListResponse {
+      list:{quote:Quote,quoted_subscription?:QuotedSubscription}[];
+      next_offset?:string;
+    }
+    export interface ListInputParam {
+      [key: string]: string | number | object | boolean;
+      limit?:number;
+      offset?:string;
+      include_deleted?:boolean;
+      id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+      customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+      subscription_id?:{in?:string,is?:string,is_not?:string,is_present?:'true' | 'false',not_in?:string,starts_with?:string};
+      status?:{in?:string,is?:'declined' | 'invoiced' | 'accepted' | 'closed' | 'open',is_not?:'declined' | 'invoiced' | 'accepted' | 'closed' | 'open',not_in?:string};
+      date?:{after?:string,before?:string,between?:string,on?:string};
+      updated_at?:{after?:string,before?:string,between?:string,on?:string};
+      sort_by?:{asc?:'date',desc?:'date'};
+    }
+    export interface PdfResponse {
+      download:Download;
+    }
+    export interface PdfInputParam {
+      
+      consolidated_view?:boolean;
+      disposition_type?:DispositionType;
+    }
+    export interface ConvertResponse {
+      quote:Quote;
+      quoted_subscription?:QuotedSubscription;
+      quoted_charge?:QuotedCharge;
+      customer:Customer;
+      subscription?:Subscription;
+      invoice?:Invoice;
+      credit_note?:CreditNote;
+      unbilled_charges?:UnbilledCharge[];
+    }
+    export interface ConvertInputParam {
+      
+      invoice_date?:number;
+      create_pending_invoices?:boolean;
+      first_invoice_pending?:boolean;
+      subscription?:{auto_close_invoices?:boolean,auto_collection?:AutoCollection,id?:string,po_number?:string};
+    }
+    export interface CreateForChargeItemsAndChargesResponse {
+      quote:Quote;
+      quoted_charge?:QuotedCharge;
+    }
+    export interface CreateForChargeItemsAndChargesInputParam {
+      
+      name?:string;
+      customer_id:string;
+      po_number?:string;
+      notes?:string;
+      expires_at?:number;
+      currency_code?:string;
+      coupon?:string;
+      coupon_ids?: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?:{item_price_id?:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,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_transaction_type?:number,description?:string,service_period?:number}[];
+      discounts?:{amount?:number,apply_on:ApplyOn,item_price_id?:string,percentage?:number}[];
+    }
+    export interface DeleteResponse {
+      quote:Quote;
+      quoted_subscription?:QuotedSubscription;
+      quoted_charge?:QuotedCharge;
+    }
+    export interface DeleteInputParam {
+      
+      comment?:string;
+    }
+    export interface LineItem {
+      id?:string;
+      subscription_id?:string;
+      date_from?:number;
+      date_to?:number;
+      unit_amount?:number;
+      quantity?:number;
+      amount?:number;
+      pricing_model?:'volume' | 'per_unit' | 'tiered' | 'flat_fee' | 'stairstep';
+      is_taxed?:boolean;
+      tax_amount?:number;
+      tax_rate?:number;
+      unit_amount_in_decimal?:string;
+      quantity_in_decimal?:string;
+      amount_in_decimal?:string;
+      discount_amount?:number;
+      item_level_discount_amount?:number;
+      reference_line_item_id?:string;
+      description?:string;
+      entity_description?:string;
+      entity_type?:'addon_item_price' | 'plan_item_price' | 'charge_item_price' | 'adhoc';
+      tax_exempt_reason?:'high_value_physical_goods' | 'tax_not_configured' | 'reverse_charge' | 'zero_rated' | 'customer_exempt' | 'region_non_taxable' | 'zero_value_item' | 'export' | 'product_exempt';
+      entity_id?:string;
+      customer_id?:string;
+    }
+    export interface Discount {
+      amount?:number;
+      description?:string;
+      line_item_id?:string;
+      entity_type?:'item_level_coupon' | 'promotional_credits' | 'item_level_discount' | 'prorated_credits' | 'document_level_discount' | 'document_level_coupon';
+      discount_type?:'fixed_amount' | 'percentage';
+      entity_id?:string;
+      coupon_set_code?:string;
+    }
+    export interface LineItemDiscount {
+      line_item_id?:string;
+      discount_type?:'item_level_coupon' | 'promotional_credits' | 'item_level_discount' | 'prorated_credits' | 'document_level_discount' | 'document_level_coupon';
+      coupon_id?:string;
+      entity_id?:string;
+      discount_amount?:number;
+    }
+    export interface Tax {
+      name?:string;
+      amount?:number;
+      description?:string;
+    }
+    export interface LineItemTax {
+      line_item_id?:string;
+      tax_name?:string;
+      tax_rate?:number;
+      is_partial_tax_applied?:boolean;
+      is_non_compliance_tax?:boolean;
+      taxable_amount?:number;
+      tax_amount?:number;
+      tax_juris_type?:'special' | 'country' | 'unincorporated' | 'other' | 'city' | 'federal' | 'county' | 'state';
+      tax_juris_name?:string;
+      tax_juris_code?:string;
+      tax_amount_in_local_currency?:number;
+      local_currency_code?:string;
+    }
+    export interface LineItemTier {
+      line_item_id?:string;
+      starting_unit?:number;
+      ending_unit?:number;
+      quantity_used?:number;
+      unit_amount?:number;
+      starting_unit_in_decimal?:string;
+      ending_unit_in_decimal?:string;
+      quantity_used_in_decimal?:string;
+      unit_amount_in_decimal?:string;
+    }
+    export interface ShippingAddress {
+      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?:ValidationStatus;
+      index?:number;
+    }
+    export interface BillingAddress {
+      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?:ValidationStatus;
+    }
+  }
+}