chargebee 3.4.0 → 3.6.0

package/CHANGELOG.md

@@ -1,3 +1,152 @@
+### v3.6.0 (2025-04-23)
+* * * 
+
+### New Resources:
+* OmnichannelSubscriptionItemScheduledChange has been added. 
+
+### New Attributes:
+* pricing_type has been added to DifferentialPrice#Tier.
+* package_size has been added to DifferentialPrice#Tier.
+* pricing_type has been added to ItemPrice#Tier.
+* package_size has been added to ItemPrice#Tier.
+* pricing_type has been added to Addon#Tier.
+* package_size has been added to Addon#Tier.
+* pricing_type has been added to Plan#Tier.
+* package_size has been added to Plan#Tier.
+* pricing_type has been added to CreditNote#LineItemTier.
+* package_size has been added to CreditNote#LineItemTier.
+* pricing_type has been added to CreditNoteEstimate#LineItemTier.
+* package_size has been added to CreditNoteEstimate#LineItemTier.
+* pricing_type has been added to DifferentialPrice#Tier.
+* package_size has been added to DifferentialPrice#Tier.
+* pricing_type has been added to Invoice#LineItemTier.
+* package_size has been added to Invoice#LineItemTier.
+* pricing_type has been added to InvoiceEstimate#LineItemTier.
+* package_size has been added to InvoiceEstimate#LineItemTier.
+* pricing_type has been added to Quote#LineItemTier.
+* package_size has been added to Quote#LineItemTier.
+* pricing_type has been added to QuotedCharge#LineItemTier.
+* package_size has been added to QuotedCharge#LineItemTier.
+* pricing_type has been added to QuotedSubscription#LineItemTier.
+* package_size has been added to QuotedSubscription#LineItemTier.
+* pricing_type has been added to Ramp#ItemTier.
+* package_size has been added to Ramp#ItemTier.
+* pricing_type has been added to Subscription#ItemTier.
+* package_size has been added to Subscription#ItemTier.
+* pricing_type has been added to UnbilledCharges#Tier.
+* package_size has been added to UnbilledCharges#Tier.
+* metered has been added to CreditNote#LineItem.
+* metered has been added to CreditNoteEstimate#LineItem.
+* metered has been added to Invoice#LineItem.
+* metered has been added to Quote#LineItem.
+* metered has been added to QuoteLineGroup#LineItem.
+* usage_percentage has been changed to percentage in CreditNote#LineItem.
+* usage_percentage has been changed to percentage in CreditNoteEstimate#LineItem.
+* usage_percentage has been changed to percentage in Invoice#LineItem.
+* usage_percentage has been changed to percentage in Quote#LineItem.
+* usage_percentage has been changed to percentage in QuoteLineGroup#LineItem.
+* line_item_addresses has been added to CreditNote.
+* line_item_addresses has been added to Invoices.
+* line_item_addresses has been added to InvoiceEstimate.
+* has_scheduled_changes has been added on OmnichannelSubscriptionItem.
+* item_parent_id_at_source has been added to OmnichannelSubscriptionItem.
+* auto_renew_status has been added to OmnichannelSubscriptionItem.
+* upcoming_renewal has been added to OmnichannelSubscriptionItem.
+* is_percentage_pricing has been added to Item.
+
+### New Action:
+* listOmniSubItemScheduleChanges has been added to OmnichannelSubscriptionItem.
+
+### Optional Attribute: 
+* price_currency has been made optional from requried in OmnichannelTransaction. 
+* price_units has been made optional from requried in OmnichannelTransaction.
+* price_nanos has been made optional from requried in OmnichannelTransaction.
+* transacted_at has been made optional from requried in OmnichannelTransaction.
+
+### New Input Params:
+* item_tiers[pricing_type] has been added to DifferentialPrice#CreateInputParam.
+* item_tiers[package_size] has been added to DifferentialPrice#CreateInputParam.
+* item_tiers[pricing_type] has been added to ItemPrice#CreateInputParam.
+* item_tiers[package_size] has been added to ItemPrice#CreateInputParam.
+* tiers[pricing_type] has been added to DifferentialPrice#CreateInputParam.
+* tiers[package_size] has been added to DifferentialPrice#CreateInputParam.
+* item_tiers[pricing_type] has been added to Estimate#CreateSubItemEstimateRequestInputParam.
+* item_tiers[package_size] has been added to Estimate#CreateSubItemEstimateRequestInputParam.
+* item_tiers[pricing_type] has been added to Estimate#CreateSubItemForCustomerRequestInputParam.
+* item_tiers[package_size] has been added to Estimate#CreateSubItemForCustomerRequestInputParam.
+* item_tiers[pricing_type] has been added to Estimate#UpdateSubscriptionForItemsRequestInputParam.
+* item_tiers[package_size] has been added to Estimate#UpdateSubscriptionForItemsRequestInputParam.
+* item_tiers[pricing_type] has been added to Estimate#CreateInvoiceForItemsRequestInputParam.
+* item_tiers[package_size] has been added to Estimate#CreateInvoiceForItemsRequestInputParam.
+* item_tiers[pricing_type] has been added to Estimate#CheckoutNewForItemsRequestInputParam.
+* item_tiers[package_size] has been added to Estimate#CheckoutNewForItemsRequestInputParam.
+* item_tiers[pricing_type] has been added to Estimate#CheckoutOneTimeForItemsRequestInputParam.
+* item_tiers[package_size] has been added to Estimate#CheckoutOneTimeForItemsRequestInputParam.
+* item_tiers[pricing_type] has been added to Estimate#CheckoutExistingForItemsRequestInputParam.
+* item_tiers[package_size] has been added to Estimate#CheckoutExistingForItemsRequestInputParam.
+* item_tiers[pricing_type] has been added to Invoice#CreateForChargeItemsAndChargesRequestInputParam.
+* item_tiers[package_size] has been added to Invoice#CreateForChargeItemsAndChargesRequestInputParam.
+* item_tiers[pricing_type] has been added to Invoice#CreateForChargeItemRequestInputParam.
+* item_tiers[package_size] has been added to Invoice#CreateForChargeItemRequestInputParam.
+* item_tiers[pricing_type] has been added to Invoice#AddChargeItemRequestInputParam.
+* item_tiers[package_size] has been added to Invoice#AddChargeItemRequestInputParam.
+* item_tiers[pricing_type] has been added to Quote#CreateSubItemsForCustomerQuoteRequestInputParam.
+* item_tiers[package_size] has been added to Quote#CreateSubItemsForCustomerQuoteRequestInputParam.
+* item_tiers[pricing_type] has been added to Quote#EditCreateSubCustomerQuoteForItemsRequestInputParam.
+* item_tiers[package_size] has been added to Quote#EditCreateSubCustomerQuoteForItemsRequestInputParam.
+* item_tiers[pricing_type] has been added to Quote#UpdateSubscriptionQuoteForItemsRequestInputParam.
+* item_tiers[package_size] has been added to Quote#UpdateSubscriptionQuoteForItemsRequestInputParam.
+* item_tiers[pricing_type] has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequestInputParam.
+* item_tiers[package_size] has been added to Quote#EditUpdateSubscriptionQuoteForItemsRequestInputParam.
+* item_tiers[pricing_type] has been added to Quote#CreateForChargeItemsAndChargesRequestInputParam.
+* item_tiers[package_size] has been added to Quote#CreateForChargeItemsAndChargesRequestInputParam.
+* item_tiers[pricing_type] has been added to Quote#EditForChargeItemsAndChargesRequestInputParam.
+* item_tiers[package_size] has been added to Quote#EditForChargeItemsAndChargesRequestInputParam.
+* item_tiers[pricing_type] has been added to Ramp#CreateForSubscriptionRequestInputParam.
+* item_tiers[package_size] has been added to Ramp#CreateForSubscriptionRequestInputParam.
+* item_tiers[pricing_type] has been added to Ramp#UpdateRequestInputParam.
+* item_tiers[package_size] has been added to Ramp#UpdateRequestInputParam.
+* item_tiers[pricing_type] has been added to Subscription#CreateWithItemsRequestInputParam.
+* item_tiers[package_size] has been added to Subscription#CreateWithItemsRequestInputParam.
+* item_tiers[pricing_type] has been added to Subscription#UpdateForItemsRequestInputParam.
+* item_tiers[package_size] has been added to Subscription#UpdateForItemsRequestInputParam.
+* item_tiers[pricing_type] has been added to Subscription#ImportForItemsRequestInputParam.
+* item_tiers[package_size] has been added to Subscription#ImportForItemsRequestInputParam.
+* item_tiers[pricing_type] has been added to UnbilledCharged#CreateRequestInputParam.
+* item_tiers[package_size] has been added to UnbilledCharged#CreateRequestInputParam.
+* billing_address has been added to Estimate#CreateInvoiceForItemsRequestInputParam.
+* google_play_store[purchase_token] has been added to RecordedPurchase#CreateRequestInputParam.
+* is_percentage_pricing has been added to Item#CreateRequest.
+* include_deleted has been added to PaymentSource#ListRequest.
+
+### New Enums: 
+* OMNICHANNEL_SUBSCRIPTION_ITEM_SCHEDULED_CHANGE has been added to EntityType#Enum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_CHANGE_SCHEDULED has been added to EventType#Enum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_SCHEDULED_CHANGE_REMOVED has been added to EventType#Enum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_REACTIVATED has been added to EventType#Enum.
+* GOOGLE_PLAY_STORE has been added to OminchannelSubscription#SourceEnum.
+* SPECIFIC_DATE has been added to ContractTermCancelOption.
+* END_OF_SUBSCRIPTION_BILLING_TERM has been added to ContractTermCancelOption. 
+* PAYSTACK has been added to GatewayEnum.
+* PricingType Enum has been added.
+* JP_MORGAN has been added to GatewayEnum.
+
+### Deprecated Enums: 
+* OMNICHANNEL_SUBSCRIPTION_ITEM_DOWNGRADE_SCHEDULED has been deprecated from EntityType#Enum.
+* OMNICHANNEL_SUBSCRIPTION_ITEM_SCHEDULED_DOWNGRADE_REMOVED has been deprecated from EntityType#Enum.
+* REFUNDED_DUE_TO_APP_ISSUE has been added to OmnichannelSubscriptionItem#CancellationReasonEnum. 
+* REFUNDED_FOR_OTHER_REASON has been added to OmnichannelSubscriptionItem#CancellationReasonEnum.
+
+### v3.5.0 (2025-03-06)
+* * * 
+
+### New Input Params:
+* created_at has been added to Invoice#LineItemsImportInputParams.
+* PaymentIntent has been added to Purchase#CreateInputParams.
+
+### New Enums:
+* SUBSCRIPTION_ENTITLEMENTS_UPDATED has been added to EventType#Enum.
+
 ### v3.4.0 (2025-02-10)
 * * * 
 

package/README.md

@@ -1,8 +1,11 @@
-# Chargebee Node.js / TypeScript client library
+# Chargebee Node.js / TypeScript Client Library
 
-This is the [Node.js](http://nodejs.org/) library for integrating with Chargebee. Sign up for a Chargebee account [here](https://www.chargebee.com).
+This is the official [Node.js](http://nodejs.org/) library for integrating with Chargebee.
 
-Please refer to the [migration guide](https://github.com/chargebee/chargebee-node/wiki/Migration-guide-for-v3) if you are migrating from the older versions of [chargebee-typescript](https://www.npmjs.com/package/chargebee-typescript) or [chargebee](https://www.npmjs.com/package/chargebee/v/2.40.0).
+- 📘 For a complete reference of available APIs, check out our [API Documentation](https://apidocs.chargebee.com/docs/api/?lang=node).  
+- 🧪 To explore and test API capabilities interactively, head over to our [API Explorer](https://api-explorer.chargebee.com).
+
+If you're upgrading from an older version of [`chargebee-typescript`](https://www.npmjs.com/package/chargebee-typescript) or [`chargebee`](https://www.npmjs.com/package/chargebee/v/2.40.0), please refer to the [Migration Guide](https://github.com/chargebee/chargebee-node/wiki/Migration-guide-for-v3).
 
 ## Requirements
 

package/cjs/environment.js

@@ -11,7 +11,7 @@ exports.Environment = {
     hostSuffix: '.chargebee.com',
     apiPath: '/api/v2',
     timeout: DEFAULT_TIME_OUT,
-    clientVersion: 'v3.4.0',
+    clientVersion: 'v3.6.0',
     port: DEFAULT_PORT,
     timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
     exportWaitInMillis: DEFAULT_EXPORT_WAIT,

package/cjs/resources/api_endpoints.js

@@ -2655,6 +2655,7 @@ exports.Endpoints = {
             null,
             false,
             {
+                additional_information: 1,
                 meta_data: 1,
             },
         ],
@@ -2815,7 +2816,18 @@ exports.Endpoints = {
         ],
     ],
     omnichannelTransaction: [],
-    omnichannelSubscriptionItem: [],
+    omnichannelSubscriptionItem: [
+        [
+            'listOmniSubItemScheduleChanges',
+            'GET',
+            '/omnichannel_subscription_items',
+            '/scheduled_changes',
+            true,
+            null,
+            false,
+            {},
+        ],
+    ],
     recordedPurchase: [
         ['create', 'POST', '/recorded_purchases', null, false, null, false, {}],
         ['retrieve', 'GET', '/recorded_purchases', null, true, null, false, {}],
@@ -2847,4 +2859,5 @@ exports.Endpoints = {
             },
         ],
     ],
+    omnichannelSubscriptionItemScheduledChange: [],
 };

package/esm/environment.js

@@ -8,7 +8,7 @@ export const Environment = {
     hostSuffix: '.chargebee.com',
     apiPath: '/api/v2',
     timeout: DEFAULT_TIME_OUT,
-    clientVersion: 'v3.4.0',
+    clientVersion: 'v3.6.0',
     port: DEFAULT_PORT,
     timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
     exportWaitInMillis: DEFAULT_EXPORT_WAIT,

package/esm/resources/api_endpoints.js

@@ -2652,6 +2652,7 @@ export const Endpoints = {
             null,
             false,
             {
+                additional_information: 1,
                 meta_data: 1,
             },
         ],
@@ -2812,7 +2813,18 @@ export const Endpoints = {
         ],
     ],
     omnichannelTransaction: [],
-    omnichannelSubscriptionItem: [],
+    omnichannelSubscriptionItem: [
+        [
+            'listOmniSubItemScheduleChanges',
+            'GET',
+            '/omnichannel_subscription_items',
+            '/scheduled_changes',
+            true,
+            null,
+            false,
+            {},
+        ],
+    ],
     recordedPurchase: [
         ['create', 'POST', '/recorded_purchases', null, false, null, false, {}],
         ['retrieve', 'GET', '/recorded_purchases', null, true, null, false, {}],
@@ -2844,4 +2856,5 @@ export const Endpoints = {
             },
         ],
     ],
+    omnichannelSubscriptionItemScheduledChange: [],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chargebee",
-  "version": "3.4.0",
+  "version": "3.6.0",
   "description": "A library for integrating with Chargebee.",
   "scripts": {
     "prepack": "npm install && npm run build",

package/types/core.d.ts

@@ -57,7 +57,9 @@ declare module 'chargebee' {
   type ChargesHandlingEnum = 'invoice_immediately' | 'add_to_unbilled_charges';
   type ContractTermCancelOptionEnum =
     | 'terminate_immediately'
-    | 'end_of_contract_term';
+    | 'end_of_contract_term'
+    | 'specific_date'
+    | 'end_of_subscription_billing_term';
   type CreditOptionForCurrentTermChargesEnum = 'none' | 'prorate' | 'full';
   type CreditTypeEnum = 'loyalty_credits' | 'referral_rewards' | 'general';
   type CustomerTypeEnum =
@@ -137,7 +139,9 @@ declare module 'chargebee' {
     | 'omnichannel_subscription'
     | 'omnichannel_subscription_item'
     | 'omnichannel_transaction'
-    | 'recorded_purchase';
+    | 'recorded_purchase'
+    | 'omnichannel_subscription_item_scheduled_change'
+    | 'sales_order';
   type EventNameEnum = 'cancellation_page_loaded';
   type EventTypeEnum =
     | 'coupon_created'
@@ -292,6 +296,7 @@ declare module 'chargebee' {
     | 'item_entitlements_removed'
     | 'entitlement_overrides_auto_removed'
     | 'subscription_entitlements_created'
+    | 'subscription_entitlements_updated'
     | 'business_entity_created'
     | 'business_entity_updated'
     | 'business_entity_deleted'
@@ -317,8 +322,6 @@ declare module 'chargebee' {
     | 'subscription_movement_failed'
     | 'omnichannel_subscription_created'
     | 'omnichannel_subscription_item_renewed'
-    | 'omnichannel_subscription_item_downgrade_scheduled'
-    | 'omnichannel_subscription_item_scheduled_downgrade_removed'
     | 'omnichannel_subscription_item_downgraded'
     | 'omnichannel_subscription_item_expired'
     | 'omnichannel_subscription_item_cancellation_scheduled'
@@ -335,6 +338,12 @@ declare module 'chargebee' {
     | 'rule_updated'
     | 'rule_deleted'
     | 'record_purchase_failed'
+    | 'omnichannel_subscription_item_change_scheduled'
+    | 'omnichannel_subscription_item_scheduled_change_removed'
+    | 'omnichannel_subscription_item_reactivated'
+    | 'sales_order_created'
+    | 'sales_order_updated'
+    | 'omnichannel_subscription_item_changed'
     | 'plan_created'
     | 'plan_updated'
     | 'plan_deleted'
@@ -347,6 +356,7 @@ declare module 'chargebee' {
   type GatewayEnum =
     | 'chargebee'
     | 'chargebee_payments'
+    | 'adyen'
     | 'stripe'
     | 'wepay'
     | 'braintree'
@@ -372,7 +382,6 @@ declare module 'chargebee' {
     | 'wirecard'
     | 'amazon_payments'
     | 'paypal_express_checkout'
-    | 'adyen'
     | 'orbital'
     | 'moneris_us'
     | 'moneris'
@@ -395,6 +404,8 @@ declare module 'chargebee' {
     | 'ebanx'
     | 'dlocal'
     | 'nuvei'
+    | 'paystack'
+    | 'jp_morgan'
     | 'gocardless'
     | 'not_applicable';
   type HierarchyOperationTypeEnum =
@@ -503,6 +514,7 @@ declare module 'chargebee' {
     | 'tiered'
     | 'volume'
     | 'stairstep';
+  type PricingTypeEnum = 'per_unit' | 'flat_fee' | 'package';
   type ProductCatalogVersionEnum = 'v1' | 'v2';
   type ProrationTypeEnum = 'full_term' | 'partial_term' | 'none';
   type ReferralSystemEnum =

package/types/index.d.ts

@@ -1,3 +1,4 @@
+///<reference path='./resources/Addon.d.ts' />
 ///<reference path='./resources/Address.d.ts' />
 ///<reference path='./resources/AdvanceInvoiceSchedule.d.ts' />
 ///<reference path='./resources/AttachedItem.d.ts' />
@@ -44,6 +45,7 @@
 ///<reference path='./resources/NonSubscription.d.ts' />
 ///<reference path='./resources/OmnichannelSubscription.d.ts' />
 ///<reference path='./resources/OmnichannelSubscriptionItem.d.ts' />
+///<reference path='./resources/OmnichannelSubscriptionItemScheduledChange.d.ts' />
 ///<reference path='./resources/OmnichannelTransaction.d.ts' />
 ///<reference path='./resources/Order.d.ts' />
 ///<reference path='./resources/PaymentIntent.d.ts' />
@@ -53,6 +55,7 @@
 ///<reference path='./resources/PaymentScheduleScheme.d.ts' />
 ///<reference path='./resources/PaymentSource.d.ts' />
 ///<reference path='./resources/PaymentVoucher.d.ts' />
+///<reference path='./resources/Plan.d.ts' />
 ///<reference path='./resources/PortalSession.d.ts' />
 ///<reference path='./resources/PriceVariant.d.ts' />
 ///<reference path='./resources/PricingPageSession.d.ts' />
@@ -121,6 +124,7 @@ export type Config = {
 declare module 'chargebee' {
   export default class Chargebee {
     constructor(config: Config);
+    addon: Addon.AddonResource;
     address: Address.AddressResource;
     attachedItem: AttachedItem.AttachedItemResource;
     businessEntity: BusinessEntity.BusinessEntityResource;
@@ -151,11 +155,13 @@ declare module 'chargebee' {
     itemPrice: ItemPrice.ItemPriceResource;
     nonSubscription: NonSubscription.NonSubscriptionResource;
     omnichannelSubscription: OmnichannelSubscription.OmnichannelSubscriptionResource;
+    omnichannelSubscriptionItem: OmnichannelSubscriptionItem.OmnichannelSubscriptionItemResource;
     order: Order.OrderResource;
     paymentIntent: PaymentIntent.PaymentIntentResource;
     paymentScheduleScheme: PaymentScheduleScheme.PaymentScheduleSchemeResource;
     paymentSource: PaymentSource.PaymentSourceResource;
     paymentVoucher: PaymentVoucher.PaymentVoucherResource;
+    plan: Plan.PlanResource;
     portalSession: PortalSession.PortalSessionResource;
     priceVariant: PriceVariant.PriceVariantResource;
     pricingPageSession: PricingPageSession.PricingPageSessionResource;

package/types/resources/Addon.d.ts

@@ -0,0 +1,283 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface Addon {
+    [key: string]: unknown;
+    id: string;
+    name: string;
+    invoice_name?: string;
+    description?: string;
+    pricing_model: PricingModelEnum;
+    type: 'on_off' | 'quantity' | 'tiered' | 'volume' | 'stairstep';
+    charge_type: 'recurring' | 'non_recurring';
+    price?: number;
+    currency_code: string;
+    period?: number;
+    period_unit: 'day' | 'week' | 'month' | 'year' | 'not_applicable';
+    unit?: string;
+    status: 'active' | 'archived' | 'deleted';
+    archived_at?: number;
+    enabled_in_portal: boolean;
+    tax_code?: string;
+    hsn_code?: string;
+    taxjar_product_code?: string;
+    avalara_sale_type?: AvalaraSaleTypeEnum;
+    avalara_transaction_type?: number;
+    avalara_service_type?: number;
+    sku?: string;
+    accounting_code?: string;
+    accounting_category1?: string;
+    accounting_category2?: string;
+    accounting_category3?: string;
+    accounting_category4?: string;
+    is_shippable?: boolean;
+    shipping_frequency_period?: number;
+    shipping_frequency_period_unit?: 'year' | 'month' | 'week' | 'day';
+    resource_version?: number;
+    updated_at?: number;
+    price_in_decimal?: string;
+    included_in_mrr?: boolean;
+    channel?: ChannelEnum;
+    proration_type?: 'site_default' | 'partial_term' | 'full_term';
+    invoice_notes?: string;
+    taxable?: boolean;
+    tax_profile_id?: string;
+    meta_data?: any;
+    tiers?: Addon.Tier[];
+    tax_providers_fields?: Addon.TaxProvidersField[];
+    show_description_in_invoices?: boolean;
+    show_description_in_quotes?: boolean;
+  }
+
+  export namespace Addon {
+    export class AddonResource {
+      create(
+        input: CreateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CreateResponse>>;
+
+      update(
+        addon_id: string,
+        input: UpdateInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UpdateResponse>>;
+
+      list(
+        input?: ListInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListResponse>>;
+
+      retrieve(
+        addon_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<RetrieveResponse>>;
+
+      delete(
+        addon_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<DeleteResponse>>;
+
+      copy(
+        input: CopyInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<CopyResponse>>;
+
+      unarchive(
+        addon_id: string,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<UnarchiveResponse>>;
+    }
+
+    export interface CreateResponse {
+      addon: Addon;
+    }
+
+    export interface UpdateResponse {
+      addon: Addon;
+    }
+
+    export interface ListResponse {
+      list: { addon: Addon }[];
+      next_offset?: string;
+    }
+
+    export interface RetrieveResponse {
+      addon: Addon;
+    }
+
+    export interface DeleteResponse {
+      addon: Addon;
+    }
+
+    export interface CopyResponse {
+      addon: Addon;
+    }
+
+    export interface UnarchiveResponse {
+      addon: Addon;
+    }
+
+    export interface Tier {
+      starting_unit: number;
+      ending_unit?: number;
+      price: number;
+      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 TaxProvidersField {
+      provider_name: string;
+      field_id: string;
+      field_value: string;
+    }
+    // REQUEST PARAMS
+    //---------------
+
+    export interface CreateInputParam {
+      id: string;
+      name: string;
+      invoice_name?: string;
+      description?: string;
+      charge_type: 'recurring' | 'non_recurring';
+      price?: number;
+      currency_code?: string;
+      period?: number;
+      period_unit?: 'day' | 'week' | 'month' | 'year' | 'not_applicable';
+      pricing_model?: PricingModelEnum /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      type?: 'on_off' | 'quantity' | 'tiered' | 'volume' | 'stairstep';
+      unit?: string;
+      enabled_in_portal?: boolean;
+      taxable?: boolean;
+      tax_profile_id?: string;
+      avalara_sale_type?: AvalaraSaleTypeEnum;
+      avalara_transaction_type?: number;
+      avalara_service_type?: number;
+      tax_code?: string;
+      hsn_code?: string;
+      taxjar_product_code?: string;
+      invoice_notes?: string;
+      meta_data?: any;
+      sku?: string;
+      accounting_code?: string;
+      accounting_category1?: string;
+      accounting_category2?: string;
+      accounting_category3?: string;
+      accounting_category4?: string;
+      is_shippable?: boolean;
+      shipping_frequency_period?: number;
+      shipping_frequency_period_unit?: 'year' | 'month' | 'week' | 'day';
+      included_in_mrr?: boolean;
+      show_description_in_invoices?: boolean;
+      show_description_in_quotes?: boolean;
+      price_in_decimal?: string;
+      proration_type?: 'site_default' | 'partial_term' | 'full_term';
+      status?: 'active' | 'archived';
+      tiers?: TiersCreateInputParam[];
+      tax_providers_fields?: TaxProvidersFieldsCreateInputParam[];
+      [key: `cf_${string}`]: unknown;
+    }
+    export interface UpdateInputParam {
+      name?: string;
+      invoice_name?: string;
+      description?: string;
+      charge_type?: 'recurring' | 'non_recurring';
+      price?: number;
+      currency_code?: string;
+      period?: number;
+      period_unit?: 'day' | 'week' | 'month' | 'year' | 'not_applicable';
+      pricing_model?: PricingModelEnum /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      type?: 'on_off' | 'quantity' | 'tiered' | 'volume' | 'stairstep';
+      unit?: string;
+      enabled_in_portal?: boolean;
+      taxable?: boolean;
+      tax_profile_id?: string;
+      avalara_sale_type?: AvalaraSaleTypeEnum;
+      avalara_transaction_type?: number;
+      avalara_service_type?: number;
+      tax_code?: string;
+      hsn_code?: string;
+      taxjar_product_code?: string;
+      invoice_notes?: string;
+      meta_data?: any;
+      sku?: string;
+      accounting_code?: string;
+      accounting_category1?: string;
+      accounting_category2?: string;
+      accounting_category3?: string;
+      accounting_category4?: string;
+      is_shippable?: boolean;
+      shipping_frequency_period?: number;
+      shipping_frequency_period_unit?: 'year' | 'month' | 'week' | 'day';
+      included_in_mrr?: boolean;
+      show_description_in_invoices?: boolean;
+      show_description_in_quotes?: boolean;
+      price_in_decimal?: string;
+      proration_type?: 'site_default' | 'partial_term' | 'full_term';
+      tiers?: TiersUpdateInputParam[];
+      tax_providers_fields?: TaxProvidersFieldsUpdateInputParam[];
+      [key: `cf_${string}`]: unknown;
+    }
+    export interface ListInputParam {
+      limit?: number;
+      offset?: string;
+      id?: filter.String;
+      name?: filter.String;
+      pricing_model?: filter.Enum /**
+       * @deprecated Please refer API docs to use other attributes
+       */;
+
+      type?: filter.Enum;
+      charge_type?: filter.Enum;
+      price?: filter.Number;
+      period?: filter.Number;
+      period_unit?: filter.Enum;
+      status?: filter.Enum;
+      updated_at?: filter.Timestamp;
+      currency_code?: filter.String;
+      channel?: filter.Enum;
+      include_deleted?: boolean;
+      [key: `cf_${string}`]: unknown;
+    }
+    export interface CopyInputParam {
+      from_site: string;
+      id_at_from_site: string;
+      id?: string;
+      for_site_merging?: boolean;
+    }
+    export interface TiersCreateInputParam {
+      starting_unit?: number;
+      ending_unit?: number;
+      price?: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      price_in_decimal?: string;
+    }
+    export interface TaxProvidersFieldsCreateInputParam {
+      provider_name: string;
+      field_id: string;
+      field_value: string;
+    }
+    export interface TiersUpdateInputParam {
+      starting_unit?: number;
+      ending_unit?: number;
+      price?: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      price_in_decimal?: string;
+    }
+    export interface TaxProvidersFieldsUpdateInputParam {
+      provider_name: string;
+      field_id: string;
+      field_value: string;
+    }
+  }
+}