chargebee 3.21.1 → 3.22.0

package/CHANGELOG.md

@@ -1,3 +1,32 @@
+### v3.22.0 (2026-03-02)
+* * *
+### New Resources:
+- [`UsageCharge`](https://apidocs.chargebee.com/docs/api/usage_charges) has been added.
+- [`UsageSummary`](https://apidocs.chargebee.com/docs/api/usage_summaries) has been added.
+
+
+### New Attributes:
+- [`free_period`](https://apidocs.chargebee.com/docs/api/quoted_subscriptions/quoted-subscription-object#free_period) has been added to [`QuotedSubscription`](https://apidocs.chargebee.com/docs/api/quoted_subscriptions).
+- [`free_period_unit`](https://apidocs.chargebee.com/docs/api/quoted_subscriptions/quoted-subscription-object#free_period_unit) has been added to [`QuotedSubscription`](https://apidocs.chargebee.com/docs/api/quoted_subscriptions).
+
+
+### New Parameters:
+- [`net_term_days`](https://apidocs.chargebee.com/docs/api/invoices/create-invoice-for-items-and-one-time-charges#net_term_days) has been added as request body parameter to [`create_invoice_for_items_and_one-time_charges`](https://apidocs.chargebee.com/docs/api/invoices/create-invoice-for-items-and-one-time-charges) in [`Invoice`](https://apidocs.chargebee.com/docs/api/invoices).
+- [`contract_term`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions/create-pricing-page-for-existing-subscription#contract_term) has been added as request body parameter to [`create_pricing_page_for_existing_subscription`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions/create-pricing-page-for-existing-subscription) in [`PricingPageSession`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions).
+- [`contract_term`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions/create-pricing-page-for-new-subscription#contract_term) has been added as request body parameter to [`create_pricing_page_for_new_subscription`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions/create-pricing-page-for-new-subscription) in [`PricingPageSession`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions).
+- [`subscription.free_period`](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-a-new-subscription-items#subscription_free_period) has been added as request body parameter to [`create_a_quote_for_a_new_subscription_items`](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-a-new-subscription-items) in [`Quote`](https://apidocs.chargebee.com/docs/api/quotes).
+- [`subscription.free_period_unit`](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-a-new-subscription-items#subscription_free_period_unit) has been added as request body parameter to [`create_a_quote_for_a_new_subscription_items`](https://apidocs.chargebee.com/docs/api/quotes/create-a-quote-for-a-new-subscription-items) in [`Quote`](https://apidocs.chargebee.com/docs/api/quotes).
+- [`subscription.free_period`](https://apidocs.chargebee.com/docs/api/quotes/edit-create-subscription-quote-for-items#subscription_free_period) has been added as request body parameter to [`edit_create_subscription_quote_for_items`](https://apidocs.chargebee.com/docs/api/quotes/edit-create-subscription-quote-for-items) in [`Quote`](https://apidocs.chargebee.com/docs/api/quotes).
+- [`subscription.free_period_unit`](https://apidocs.chargebee.com/docs/api/quotes/edit-create-subscription-quote-for-items#subscription_free_period_unit) has been added as request body parameter to [`edit_create_subscription_quote_for_items`](https://apidocs.chargebee.com/docs/api/quotes/edit-create-subscription-quote-for-items) in [`Quote`](https://apidocs.chargebee.com/docs/api/quotes).
+
+
+### New Enums:
+- `month`, `week`, `day`, `hour`, and `minute` have been added as new values enum `WindowSize`.
+- `cancel`, `renew_once`, `renew`, and `evergreen` have been added as new values to enum request body parameter `contract_term.action_at_term_end` in [`create_pricing_page_for_existing_subscription`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions/create-pricing-page-for-existing-subscription) of [`PricingPageSession`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions).
+- `cancel`, `renew_once`, `renew`, and `evergreen` have been added as new values to enum request body parameter `contract_term.action_at_term_end` in [`create_pricing_page_for_new_subscription`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions/create-pricing-page-for-new-subscription) of [`PricingPageSession`](https://apidocs.chargebee.com/docs/api/pricing_page_sessions).
+
+
+
 ### v3.21.1 (2026-02-20)
 * * * 
 

package/cjs/environment.js

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

package/cjs/resources/api_endpoints.js

@@ -4872,6 +4872,32 @@ exports.Endpoints = {
         ],
         ['list', 'GET', '/webhook_endpoints', null, false, null, false, {}, {}],
     ],
+    usageSummary: [
+        [
+            'retrieveUsageSummaryForSubscription',
+            'GET',
+            '/subscriptions',
+            '/usage_summary',
+            true,
+            null,
+            false,
+            {},
+            {},
+        ],
+    ],
+    usageCharge: [
+        [
+            'retrieveUsageChargesForSubscription',
+            'GET',
+            '/subscriptions',
+            '/usage_charges',
+            true,
+            null,
+            false,
+            {},
+            {},
+        ],
+    ],
     impactedCustomer: [],
     subscriptionEntitlementsUpdatedDetail: [],
     subscriptionEntitlementsCreatedDetail: [],

package/esm/environment.js

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

package/esm/resources/api_endpoints.js

@@ -4869,6 +4869,32 @@ export const Endpoints = {
         ],
         ['list', 'GET', '/webhook_endpoints', null, false, null, false, {}, {}],
     ],
+    usageSummary: [
+        [
+            'retrieveUsageSummaryForSubscription',
+            'GET',
+            '/subscriptions',
+            '/usage_summary',
+            true,
+            null,
+            false,
+            {},
+            {},
+        ],
+    ],
+    usageCharge: [
+        [
+            'retrieveUsageChargesForSubscription',
+            'GET',
+            '/subscriptions',
+            '/usage_charges',
+            true,
+            null,
+            false,
+            {},
+            {},
+        ],
+    ],
     impactedCustomer: [],
     subscriptionEntitlementsUpdatedDetail: [],
     subscriptionEntitlementsCreatedDetail: [],

package/package.json

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

package/types/core.d.ts

@@ -670,5 +670,6 @@ declare module 'chargebee' {
     | 'partially_valid'
     | 'invalid';
   type VoucherTypeEnum = 'boleto';
+  type WindowSizeEnum = 'month' | 'week' | 'day' | 'hour' | 'minute';
   type ChargeOnEnum = 'immediately' | 'on_event';
 }

package/types/index.d.ts

@@ -94,8 +94,10 @@
 ///<reference path='./resources/Transaction.d.ts' />
 ///<reference path='./resources/UnbilledCharge.d.ts' />
 ///<reference path='./resources/Usage.d.ts' />
+///<reference path='./resources/UsageCharge.d.ts' />
 ///<reference path='./resources/UsageEvent.d.ts' />
 ///<reference path='./resources/UsageFile.d.ts' />
+///<reference path='./resources/UsageSummary.d.ts' />
 ///<reference path='./resources/VirtualBankAccount.d.ts' />
 ///<reference path='./resources/WebhookEndpoint.d.ts' />
 ///<reference path='./resources/Content.d.ts' />
@@ -238,8 +240,10 @@ declare module 'chargebee' {
     transaction: Transaction.TransactionResource;
     unbilledCharge: UnbilledCharge.UnbilledChargeResource;
     usage: Usage.UsageResource;
+    usageCharge: UsageCharge.UsageChargeResource;
     usageEvent: UsageEvent.UsageEventResource;
     usageFile: UsageFile.UsageFileResource;
+    usageSummary: UsageSummary.UsageSummaryResource;
     virtualBankAccount: VirtualBankAccount.VirtualBankAccountResource;
     webhookEndpoint: WebhookEndpoint.WebhookEndpointResource;
 

package/types/resources/Content.d.ts

@@ -99,8 +99,10 @@ declare module 'chargebee' {
     transaction: Transaction;
     unbilled_charge: UnbilledCharge;
     usage: Usage;
+    usage_charge: UsageCharge;
     usage_event: UsageEvent;
     usage_file: UsageFile;
+    usage_summary: UsageSummary;
     virtual_bank_account: VirtualBankAccount;
     webhook_endpoint: WebhookEndpoint;
   }

package/types/resources/Invoice.d.ts

@@ -907,6 +907,7 @@ declare module 'chargebee' {
       authorization_transaction_id?: string;
       payment_source_id?: string;
       auto_collection?: AutoCollectionEnum;
+      net_term_days?: number;
       invoice_date?: number;
       token_id?: string;
       replace_primary_payment_source?: boolean;

package/types/resources/ItemEntitlement.d.ts

@@ -52,11 +52,11 @@ declare module 'chargebee' {
     }
 
     export interface AddItemEntitlementsResponse {
-      item_entitlement: ItemEntitlement;
+      list: { item_entitlement: ItemEntitlement }[];
     }
 
     export interface UpsertOrRemoveItemEntitlementsForItemResponse {
-      item_entitlement: ItemEntitlement;
+      list: { item_entitlement: ItemEntitlement }[];
     }
 
     // REQUEST PARAMS

package/types/resources/PricingPageSession.d.ts

@@ -43,6 +43,7 @@ declare module 'chargebee' {
       customer?: CustomerCreateForNewSubscriptionInputParam;
       billing_address?: BillingAddressCreateForNewSubscriptionInputParam;
       shipping_address?: ShippingAddressCreateForNewSubscriptionInputParam;
+      contract_term?: ContractTermCreateForNewSubscriptionInputParam;
       discounts?: DiscountsCreateForNewSubscriptionInputParam[];
     }
     export interface CreateForExistingSubscriptionInputParam {
@@ -50,6 +51,7 @@ declare module 'chargebee' {
       custom?: any;
       pricing_page?: PricingPageCreateForExistingSubscriptionInputParam;
       subscription?: SubscriptionCreateForExistingSubscriptionInputParam;
+      contract_term?: ContractTermCreateForExistingSubscriptionInputParam;
       discounts?: DiscountsCreateForExistingSubscriptionInputParam[];
     }
     export interface BillingAddressCreateForNewSubscriptionInputParam {
@@ -96,6 +98,10 @@ declare module 'chargebee' {
       country?: string;
       validation_status?: ValidationStatusEnum;
     }
+    export interface ContractTermCreateForNewSubscriptionInputParam {
+      action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
+      cancellation_cutoff_period?: number;
+    }
     export interface SubscriptionCreateForNewSubscriptionInputParam {
       id?: string;
     }
@@ -115,6 +121,10 @@ declare module 'chargebee' {
     export interface PricingPageCreateForExistingSubscriptionInputParam {
       id?: string;
     }
+    export interface ContractTermCreateForExistingSubscriptionInputParam {
+      action_at_term_end?: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
+      cancellation_cutoff_period?: number;
+    }
     export interface SubscriptionCreateForExistingSubscriptionInputParam {
       id: string;
     }

package/types/resources/Quote.d.ts

@@ -1120,6 +1120,8 @@ declare module 'chargebee' {
       start_date?: number;
       offline_payment_method?: OfflinePaymentMethodEnum;
       contract_term_billing_cycle_on_renewal?: number;
+      free_period?: number;
+      free_period_unit?: FreePeriodUnitEnum;
     }
 
     export interface SubscriptionItemsCreateSubItemsForCustomerQuoteInputParam {
@@ -1219,6 +1221,8 @@ declare module 'chargebee' {
       start_date?: number;
       offline_payment_method?: OfflinePaymentMethodEnum;
       contract_term_billing_cycle_on_renewal?: number;
+      free_period?: number;
+      free_period_unit?: FreePeriodUnitEnum;
     }
 
     export interface SubscriptionItemsEditCreateSubCustomerQuoteForItemsInputParam {

package/types/resources/QuotedSubscription.d.ts

@@ -19,6 +19,8 @@ declare module 'chargebee' {
     plan_unit_price_in_decimal?: string;
     changes_scheduled_at?: number;
     change_option?: 'end_of_term' | 'specific_date' | 'immediately';
+    free_period?: number;
+    free_period_unit?: FreePeriodUnitEnum;
     contract_term_billing_cycle_on_renewal?: number;
     addons?: QuotedSubscription.Addon[];
     event_based_addons?: QuotedSubscription.EventBasedAddon[];

package/types/resources/UsageCharge.d.ts

@@ -0,0 +1,47 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface UsageCharge {
+    subscription_id: string;
+    feature_id: string;
+    included_usage?: string;
+    total_usage?: string;
+    on_demand_usage?: string;
+    metered_item_price_id?: string;
+    amount?: string;
+    currency_code?: string;
+    usage_from: number;
+    usage_to: number;
+  }
+
+  export namespace UsageCharge {
+    export class UsageChargeResource {
+      /**
+       * @deprecated This method is deprecated and will be removed in a future version.
+       */
+
+      retrieveUsageChargesForSubscription(
+        subscription_id: string,
+        input?: RetrieveUsageChargesForSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<
+        ChargebeeResponse<RetrieveUsageChargesForSubscriptionResponse>
+      >;
+    }
+
+    export interface RetrieveUsageChargesForSubscriptionResponse {
+      list: { usage_charge: UsageCharge }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface RetrieveUsageChargesForSubscriptionInputParam {
+      limit?: number;
+      offset?: string;
+      feature_id?: filter.String;
+    }
+  }
+}

package/types/resources/UsageSummary.d.ts

@@ -0,0 +1,45 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface UsageSummary {
+    subscription_id: string;
+    feature_id: string;
+    aggregated_value: string;
+    aggregated_from: number;
+    aggregated_to: number;
+  }
+
+  export namespace UsageSummary {
+    export class UsageSummaryResource {
+      /**
+       * @deprecated This method is deprecated and will be removed in a future version.
+       */
+
+      retrieveUsageSummaryForSubscription(
+        subscription_id: string,
+        input: RetrieveUsageSummaryForSubscriptionInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<
+        ChargebeeResponse<RetrieveUsageSummaryForSubscriptionResponse>
+      >;
+    }
+
+    export interface RetrieveUsageSummaryForSubscriptionResponse {
+      list: { usage_summary: UsageSummary }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface RetrieveUsageSummaryForSubscriptionInputParam {
+      limit?: number;
+      offset?: string;
+      feature_id: string;
+      window_size?: 'month' | 'week' | 'day' | 'hour' | 'minute';
+      timeframe_start?: number;
+      timeframe_end?: number;
+    }
+  }
+}