chargebee 3.4.0 → 3.6.0

package/types/resources/Comment.d.ts

@@ -80,6 +80,8 @@ declare module 'chargebee' {
         | 'omnichannel_subscription_item'
         | 'omnichannel_transaction'
         | 'recorded_purchase'
+        | 'omnichannel_subscription_item_scheduled_change'
+        | 'sales_order'
         | 'item_family'
         | 'item'
         | 'item_price'

package/types/resources/CreditNote.d.ts

@@ -61,6 +61,7 @@ declare module 'chargebee' {
     billing_address?: CreditNote.BillingAddress;
     site_details_at_creation?: CreditNote.SiteDetailsAtCreation;
     tax_origin?: CreditNote.TaxOrigin;
+    line_item_addresses?: CreditNote.LineItemAddress[];
   }
 
   export namespace CreditNote {
@@ -238,7 +239,8 @@ declare module 'chargebee' {
       amount_in_decimal?: string;
       discount_amount?: number;
       item_level_discount_amount?: number;
-      usage_percentage?: string;
+      metered?: boolean;
+      percentage?: string;
       reference_line_item_id?: string;
       description: string;
       entity_description?: string;
@@ -301,6 +303,8 @@ declare module 'chargebee' {
       ending_unit_in_decimal?: string;
       quantity_used_in_decimal?: string;
       unit_amount_in_decimal?: string;
+      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
+      package_size?: number;
     }
     export interface Tax {
       name: string;
@@ -403,6 +407,27 @@ declare module 'chargebee' {
       country?: string;
       registration_number?: string;
     }
+    export interface LineItemAddress {
+      line_item_id?: string;
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      state?: string;
+      country?: string;
+      zip?: string;
+      validation_status?:
+        | 'not_validated'
+        | 'valid'
+        | 'partially_valid'
+        | 'invalid';
+    }
     // REQUEST PARAMS
     //---------------
 

package/types/resources/CreditNoteEstimate.d.ts

@@ -44,7 +44,8 @@ declare module 'chargebee' {
       amount_in_decimal?: string;
       discount_amount?: number;
       item_level_discount_amount?: number;
-      usage_percentage?: string;
+      metered?: boolean;
+      percentage?: string;
       reference_line_item_id?: string;
       description: string;
       entity_description?: string;
@@ -137,6 +138,8 @@ declare module 'chargebee' {
       ending_unit_in_decimal?: string;
       quantity_used_in_decimal?: string;
       unit_amount_in_decimal?: string;
+      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
+      package_size?: number;
     }
     // REQUEST PARAMS
     //---------------

package/types/resources/DifferentialPrice.d.ts

@@ -80,6 +80,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
+      package_size?: number;
     }
     export interface ParentPeriod {
       period_unit: 'day' | 'week' | 'month' | 'year';
@@ -124,6 +126,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface ParentPeriodsCreateInputParam {
       period_unit: 'day' | 'week' | 'month' | 'year';
@@ -136,6 +140,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface ParentPeriodsUpdateInputParam {
       period_unit: 'day' | 'week' | 'month' | 'year';

package/types/resources/Estimate.d.ts

@@ -447,6 +447,7 @@ declare module 'chargebee' {
       invoice_date?: number;
       invoice?: InvoiceCreateInvoiceForItemsInputParam;
       shipping_address?: ShippingAddressCreateInvoiceForItemsInputParam;
+      billing_address?: BillingAddressCreateInvoiceForItemsInputParam;
       item_prices?: ItemPricesCreateInvoiceForItemsInputParam[];
       item_tiers?: ItemTiersCreateInvoiceForItemsInputParam[];
       charges?: ChargesCreateInvoiceForItemsInputParam[];
@@ -631,6 +632,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface TaxProvidersFieldsCreateSubItemEstimateInputParam {
       provider_name?: string;
@@ -765,6 +768,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface BillingAddressUpdateSubscriptionInputParam {
       line1?: string;
@@ -923,6 +928,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface FixedIntervalScheduleAdvanceInvoiceEstimateInputParam {
       number_of_occurrences?: number;
@@ -1163,6 +1170,16 @@ declare module 'chargebee' {
       entity_type?: EntityTypeEnum;
       entity_id?: string;
     }
+    export interface BillingAddressCreateInvoiceForItemsInputParam {
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      zip?: string;
+      country?: string;
+      validation_status?: ValidationStatusEnum;
+    }
     export interface InvoiceCreateInvoiceForItemsInputParam {
       customer_id?: string;
       subscription_id?: string;
@@ -1214,6 +1231,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface ItemPricesCreateInvoiceForItemsInputParam {
       item_price_id?: string;

package/types/resources/HostedPage.d.ts

@@ -738,6 +738,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface ItemPricesCheckoutOneTimeForItemsInputParam {
       item_price_id?: string;
@@ -864,6 +866,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface CustomerCheckoutExistingInputParam {
       vat_number?: string;
@@ -999,6 +1003,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface CustomerUpdateCardInputParam {
       id: string;

package/types/resources/Invoice.d.ts

@@ -76,6 +76,7 @@ declare module 'chargebee' {
     business_entity_id?: string;
     site_details_at_creation?: Invoice.SiteDetailsAtCreation;
     tax_origin?: Invoice.TaxOrigin;
+    line_item_addresses?: Invoice.LineItemAddress[];
   }
 
   export namespace Invoice {
@@ -484,7 +485,8 @@ declare module 'chargebee' {
       amount_in_decimal?: string;
       discount_amount?: number;
       item_level_discount_amount?: number;
-      usage_percentage?: string;
+      metered?: boolean;
+      percentage?: string;
       reference_line_item_id?: string;
       description: string;
       entity_description?: string;
@@ -582,6 +584,8 @@ declare module 'chargebee' {
       ending_unit_in_decimal?: string;
       quantity_used_in_decimal?: string;
       unit_amount_in_decimal?: string;
+      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
+      package_size?: number;
     }
     export interface LinkedPayment {
       txn_id: string;
@@ -768,6 +772,27 @@ declare module 'chargebee' {
       country?: string;
       registration_number?: string;
     }
+    export interface LineItemAddress {
+      line_item_id?: string;
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      state?: string;
+      country?: string;
+      zip?: string;
+      validation_status?:
+        | 'not_validated'
+        | 'valid'
+        | 'partially_valid'
+        | 'invalid';
+    }
     // REQUEST PARAMS
     //---------------
 
@@ -1373,6 +1398,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface ItemPricesCreateForChargeItemsAndChargesInputParam {
       item_price_id?: string;
@@ -1414,6 +1441,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface BillingAddressImportInvoiceInputParam {
       first_name?: string;
@@ -1552,6 +1581,7 @@ declare module 'chargebee' {
       tax9_amount?: number;
       tax10_name?: string;
       tax10_amount?: number;
+      created_at?: number;
     }
     export interface TransactionsApplyPaymentsInputParam {
       id?: string;
@@ -1598,6 +1628,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface NotesToRemoveCloseInputParam {
       entity_type?: EntityTypeEnum;

package/types/resources/InvoiceEstimate.d.ts

@@ -20,6 +20,7 @@ declare module 'chargebee' {
     line_item_discounts?: InvoiceEstimate.LineItemDiscount[];
     round_off_amount?: number;
     customer_id?: string;
+    line_item_addresses?: InvoiceEstimate.LineItemAddress[];
   }
 
   export namespace InvoiceEstimate {
@@ -45,7 +46,8 @@ declare module 'chargebee' {
       amount_in_decimal?: string;
       discount_amount?: number;
       item_level_discount_amount?: number;
-      usage_percentage?: string;
+      metered?: boolean;
+      percentage?: string;
       reference_line_item_id?: string;
       description: string;
       entity_description?: string;
@@ -125,6 +127,8 @@ declare module 'chargebee' {
       ending_unit_in_decimal?: string;
       quantity_used_in_decimal?: string;
       unit_amount_in_decimal?: string;
+      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
+      package_size?: number;
     }
     export interface LineItemCredit {
       cn_id: string;
@@ -144,6 +148,27 @@ declare module 'chargebee' {
       entity_id?: string;
       discount_amount: number;
     }
+    export interface LineItemAddress {
+      line_item_id?: string;
+      first_name?: string;
+      last_name?: string;
+      email?: string;
+      company?: string;
+      phone?: string;
+      line1?: string;
+      line2?: string;
+      line3?: string;
+      city?: string;
+      state_code?: string;
+      state?: string;
+      country?: string;
+      zip?: string;
+      validation_status?:
+        | 'not_validated'
+        | 'valid'
+        | 'partially_valid'
+        | 'invalid';
+    }
     // REQUEST PARAMS
     //---------------
   }

package/types/resources/Item.d.ts

@@ -24,6 +24,7 @@ declare module 'chargebee' {
     unit?: string;
     metered: boolean;
     usage_calculation?: 'sum_of_usages' | 'last_usage' | 'max_usage';
+    is_percentage_pricing: boolean;
     archived_at?: number;
     channel?: ChannelEnum;
     applicable_items?: Item.ApplicableItem[];
@@ -120,6 +121,7 @@ declare module 'chargebee' {
       usage_calculation?: 'sum_of_usages' | 'last_usage' | 'max_usage';
       metadata?: any;
       business_entity_id?: string;
+      is_percentage_pricing?: boolean;
       bundle_configuration?: BundleConfigurationCreateInputParam;
       bundle_items_to_add?: BundleItemsToAddCreateInputParam[];
       [key: `cf_${string}`]: unknown;

package/types/resources/ItemPrice.d.ts

@@ -131,6 +131,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: 'per_unit' | 'flat_fee' | 'package';
+      package_size?: number;
     }
     export interface TaxDetail {
       tax_profile_id?: string;
@@ -292,6 +294,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface TaxProvidersFieldsCreateInputParam {
       provider_name: string;
@@ -323,6 +327,8 @@ declare module 'chargebee' {
       starting_unit_in_decimal?: string;
       ending_unit_in_decimal?: string;
       price_in_decimal?: string;
+      pricing_type?: PricingTypeEnum;
+      package_size?: number;
     }
     export interface TaxProvidersFieldsUpdateInputParam {
       provider_name: string;

package/types/resources/OmnichannelSubscription.d.ts

@@ -6,7 +6,7 @@ declare module 'chargebee' {
     id: string;
     id_at_source: string;
     app_id: string;
-    source: 'apple_app_store';
+    source: 'apple_app_store' | 'google_play_store';
     customer_id?: string;
     created_at: number;
     resource_version?: number;
@@ -53,11 +53,11 @@ declare module 'chargebee' {
       id: string;
       id_at_source: string;
       app_id: string;
-      price_currency: string;
-      price_units: number;
-      price_nanos: number;
+      price_currency?: string;
+      price_units?: number;
+      price_nanos?: number;
       type: 'purchase' | 'renewal';
-      transacted_at: number;
+      transacted_at?: number;
       created_at: number;
       resource_version?: number;
     }

package/types/resources/OmnichannelSubscriptionItem.d.ts

@@ -1,16 +1,18 @@
 ///<reference path='./../core.d.ts'/>
 ///<reference path='./../index.d.ts'/>
-
+///<reference path='./filter.d.ts'/>
 declare module 'chargebee' {
   export interface OmnichannelSubscriptionItem {
     id: string;
     item_id_at_source: string;
+    item_parent_id_at_source?: string;
     status:
       | 'active'
       | 'expired'
       | 'cancelled'
       | 'in_dunning'
       | 'in_grace_period';
+    auto_renew_status?: 'off' | 'on';
     current_term_start?: number;
     current_term_end?: number;
     expired_at?: number;
@@ -18,8 +20,42 @@ declare module 'chargebee' {
     cancelled_at?: number;
     cancellation_reason?:
       | 'customer_cancelled'
-      | 'customer_did_not_consent_to_price_increase';
+      | 'customer_did_not_consent_to_price_increase'
+      | 'refunded_due_to_app_issue'
+      | 'refunded_for_other_reason';
     grace_period_expires_at?: number;
+    has_scheduled_changes: boolean;
     resource_version?: number;
+    upcoming_renewal?: OmnichannelSubscriptionItem.UpcomingRenewal;
+  }
+
+  export namespace OmnichannelSubscriptionItem {
+    export class OmnichannelSubscriptionItemResource {
+      listOmniSubItemScheduleChanges(
+        omnichannel_subscription_item_id: string,
+        input?: ListOmniSubItemScheduleChangesInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListOmniSubItemScheduleChangesResponse>>;
+    }
+
+    export interface ListOmniSubItemScheduleChangesResponse {
+      list: {
+        omnichannel_subscription_item_scheduled_change: OmnichannelSubscriptionItemScheduledChange;
+      }[];
+      next_offset?: string;
+    }
+
+    export interface UpcomingRenewal {
+      price_currency?: string;
+      price_units?: number;
+      price_nanos?: number;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListOmniSubItemScheduleChangesInputParam {
+      limit?: number;
+      offset?: string;
+    }
   }
 }

package/types/resources/OmnichannelSubscriptionItemScheduledChange.d.ts

@@ -0,0 +1,27 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
+declare module 'chargebee' {
+  export interface OmnichannelSubscriptionItemScheduledChange {
+    id?: string;
+    omnichannel_subscription_item_id?: string;
+    scheduled_at: number;
+    change_type: 'downgrade';
+    created_at: number;
+    modified_at: number;
+    resource_version?: number;
+    current_state?: OmnichannelSubscriptionItemScheduledChange.CurrentState;
+    scheduled_state?: OmnichannelSubscriptionItemScheduledChange.ScheduledState;
+  }
+
+  export namespace OmnichannelSubscriptionItemScheduledChange {
+    export interface CurrentState {
+      item_id_at_source?: string;
+    }
+    export interface ScheduledState {
+      item_id_at_source?: string;
+    }
+    // REQUEST PARAMS
+    //---------------
+  }
+}

package/types/resources/OmnichannelTransaction.d.ts

@@ -6,11 +6,11 @@ declare module 'chargebee' {
     id: string;
     id_at_source: string;
     app_id: string;
-    price_currency: string;
-    price_units: number;
-    price_nanos: number;
+    price_currency?: string;
+    price_units?: number;
+    price_nanos?: number;
     type: 'purchase' | 'renewal';
-    transacted_at: number;
+    transacted_at?: number;
     created_at: number;
     resource_version?: number;
   }

package/types/resources/PaymentSource.d.ts

@@ -370,6 +370,7 @@ declare module 'chargebee' {
       limit?: number;
       offset?: string;
       subscription_id?: string;
+      include_deleted?: boolean;
       customer_id?: filter.String;
       type?: filter.Enum;
       status?: filter.Enum;