chargebee 2.23.1 → 2.25.0

package/types/resources/QuoteLineGroup.d.ts

@@ -0,0 +1,83 @@
+declare module 'chargebee' {
+  export interface QuoteLineGroup {
+    
+    version?:number;
+    id?:string;
+    sub_total:number;
+    total?:number;
+    credits_applied?:number;
+    amount_paid?:number;
+    amount_due?:number;
+    charge_event?:'subscription_cancel' | 'immediate' | 'subscription_creation' | 'trial_start' | 'subscription_renewal' | 'subscription_change';
+    billing_cycle_number?:number;
+    line_items?:QuoteLineGroup.LineItem[];
+    discounts?:QuoteLineGroup.Discount[];
+    line_item_discounts?:QuoteLineGroup.LineItemDiscount[];
+    taxes?:QuoteLineGroup.Tax[];
+    line_item_taxes?:QuoteLineGroup.LineItemTax[];
+  }
+  export namespace QuoteLineGroup {
+    
+    
+    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;
+    }
+  }
+}

package/types/resources/QuotedCharge.d.ts

@@ -0,0 +1,57 @@
+declare module 'chargebee' {
+  export interface QuotedCharge {
+    
+    charges?:QuotedCharge.Charge[];
+    invoice_items?:QuotedCharge.ItemPrice[];
+    item_tiers?:QuotedCharge.ItemTier[];
+    coupons?:QuotedCharge.Coupon[];
+    discounts?:QuotedCharge.Discount[];
+  }
+  export namespace QuotedCharge {
+    
+    
+    export interface Charge {
+      amount?:number;
+      amount_in_decimal?:string;
+      description?:string;
+      service_period_in_days?:number;
+      avalara_sale_type?:'consumed' | 'wholesale' | 'vendor_use' | 'retail';
+      avalara_transaction_type?:number;
+      avalara_service_type?:number;
+    }
+    export interface ItemPrice {
+      item_price_id?:string;
+      quantity?:number;
+      quantity_in_decimal?:string;
+      unit_price?:number;
+      unit_price_in_decimal?:string;
+      service_period_days?:number;
+    }
+    export interface ItemTier {
+      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;
+      index?:number;
+    }
+    export interface Coupon {
+      coupon_id?:string;
+    }
+    export interface Discount {
+      id?:string;
+      invoice_name?:string;
+      type?:'fixed_amount' | 'percentage';
+      percentage?:number;
+      amount?:number;
+      currency_code?:string;
+      apply_on?:'specific_item_price' | 'invoice_amount';
+      item_price_id?:string;
+      created_at?:number;
+      coupon_id?:string;
+      index?:number;
+    }
+  }
+}

package/types/resources/QuotedSubscription.d.ts

@@ -0,0 +1,82 @@
+declare module 'chargebee' {
+  export interface QuotedSubscription {
+    
+    id:string;
+    start_date?:number;
+    trial_end?:number;
+    remaining_billing_cycles?:number;
+    po_number?:string;
+    plan_quantity_in_decimal?:string;
+    plan_unit_price_in_decimal?:string;
+    changes_scheduled_at?:number;
+    change_option?:'end_of_term' | 'immediately' | 'specific_date';
+    contract_term_billing_cycle_on_renewal?:number;
+    coupons?:QuotedSubscription.Coupon[];
+    discounts?:QuotedSubscription.Discount[];
+    subscription_items?:QuotedSubscription.SubscriptionItem[];
+    item_tiers?:QuotedSubscription.ItemTier[];
+    quoted_contract_term?:QuotedSubscription.QuotedContractTerm;
+  }
+  export namespace QuotedSubscription {
+    
+    
+    export interface Coupon {
+      coupon_id?:string;
+    }
+    export interface Discount {
+      id?:string;
+      invoice_name?:string;
+      type?:'fixed_amount' | 'percentage';
+      percentage?:number;
+      amount?:number;
+      currency_code?:string;
+      duration_type?:'limited_period' | 'one_time' | 'forever';
+      period?:number;
+      period_unit?:'week' | 'month' | 'year' | 'day';
+      included_in_mrr?:boolean;
+      apply_on?:'specific_item_price' | 'invoice_amount';
+      item_price_id?:string;
+      created_at?:number;
+      apply_till?:number;
+      applied_count?:number;
+      coupon_id?:string;
+      index?:number;
+    }
+    export interface SubscriptionItem {
+      item_price_id?:string;
+      item_type?:'charge' | 'addon' | 'plan';
+      quantity?:number;
+      quantity_in_decimal?:string;
+      unit_price?:number;
+      unit_price_in_decimal?:string;
+      amount?:number;
+      amount_in_decimal?:string;
+      free_quantity?:number;
+      free_quantity_in_decimal?:string;
+      trial_end?:number;
+      billing_cycles?:number;
+      service_period_days?:number;
+      charge_on_event?:'subscription_creation' | 'subscription_activation' | 'subscription_trial_start' | 'contract_termination' | 'plan_activation';
+      charge_once?:boolean;
+      charge_on_option?:'on_event' | 'immediately';
+    }
+    export interface ItemTier {
+      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;
+      index?:number;
+    }
+    export interface QuotedContractTerm {
+      contract_start?:number;
+      contract_end?:number;
+      billing_cycle?:number;
+      action_at_term_end?:'cancel' | 'renew_once' | 'renew' | 'evergreen';
+      total_contract_value?:number;
+      cancellation_cutoff_period?:number;
+    }
+  }
+}

package/types/resources/ResourceMigration.d.ts

@@ -0,0 +1,27 @@
+declare module 'chargebee' {
+  export interface ResourceMigration {
+    
+    from_site:string;
+    entity_type:'customer';
+    entity_id:string;
+    status:'scheduled' | 'failed' | 'succeeded';
+    errors?:string;
+    created_at:number;
+    updated_at:number;
+  }
+  export namespace ResourceMigration {
+    export class ResourceMigrationResource {
+      retrieve_latest(input:RetrieveLatestInputParam):ChargebeeRequest<RetrieveLatestResponse>;
+    }
+    export interface RetrieveLatestResponse {
+      resource_migration:ResourceMigration;
+    }
+    export interface RetrieveLatestInputParam {
+      
+      from_site:string;
+      entity_type:'customer';
+      entity_id:string;
+    }
+    
+  }
+}

package/types/resources/SiteMigrationDetail.d.ts

@@ -0,0 +1,31 @@
+declare module 'chargebee' {
+  export interface SiteMigrationDetail {
+    
+    entity_id:string;
+    other_site_name:string;
+    entity_id_at_other_site:string;
+    migrated_at:number;
+    entity_type:'credit_note' | 'subscription' | 'invoice' | 'transaction' | 'customer' | 'order';
+    status:'moving_out' | 'moved_in' | 'moved_out';
+  }
+  export namespace SiteMigrationDetail {
+    export class SiteMigrationDetailResource {
+      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+    }
+    export interface ListResponse {
+      list:{site_migration_detail:SiteMigrationDetail}[];
+      next_offset?:string;
+    }
+    export interface ListInputParam {
+      [key: string]: string | number | object | boolean;
+      limit?:number;
+      offset?:string;
+      entity_id_at_other_site?:{is?:string,is_not?:string,starts_with?:string};
+      other_site_name?:{is?:string,is_not?:string,starts_with?:string};
+      entity_id?:{is?:string,is_not?:string,starts_with?:string};
+      entity_type?:{in?:string,is?:'credit_note' | 'subscription' | 'invoice' | 'transaction' | 'customer' | 'order',is_not?:'credit_note' | 'subscription' | 'invoice' | 'transaction' | 'customer' | 'order',not_in?:string};
+      status?:{in?:string,is?:'moving_out' | 'moved_in' | 'moved_out',is_not?:'moving_out' | 'moved_in' | 'moved_out',not_in?:string};
+    }
+    
+  }
+}