Release v3.26.0

CHANGELOG.md

@@ -1,3 +1,40 @@
+### v3.26.0 (2026-06-12)
+* * *
+### New Resources:
+- [`GrantBlock`](https://apidocs.chargebee.com/docs/api/grant_blocks) has been added.
+- [`LedgerAccountBalance`](https://apidocs.chargebee.com/docs/api/ledger_account_balances) has been added.
+- [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations) has been added.
+- [`PromotionalGrant`](https://apidocs.chargebee.com/docs/api/promotional_grants) has been added.
+
+
+### New Attributes:
+- [`notes`](https://apidocs.chargebee.com/docs/api/credit_notes/credit-note-object#notes) has been added to [`CreditNote`](https://apidocs.chargebee.com/docs/api/credit_notes).
+- [`layout`](https://apidocs.chargebee.com/docs/api/hosted_pages/hosted-page-object#layout) has been added to [`HostedPage`](https://apidocs.chargebee.com/docs/api/hosted_pages).
+
+
+### New Parameters:
+- [`sort_by`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#sort_by) has been added as query parameter to [`list_omnichannel_subscriptions`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions) in [`OmnichannelSubscription`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions).
+
+
+### New Enums:
+- `available`, `exhausted`, `scheduled`, and `in_grace_period` have been added as new values enum `Status`.
+- `subscription_created`, `subscription_changed`, `top_up`, `promotional_grants`, and `rollover` have been added as new values to enum attribute [`grant_source`](https://apidocs.chargebee.com/docs/api/grant_blocks/grant-block-object#grant_source) in [`GrantBlock`](https://apidocs.chargebee.com/docs/api/grant_blocks).
+- `provisioned` and `overdraft` have been added as new values to enum attribute [`account_type`](https://apidocs.chargebee.com/docs/api/grant_blocks/grant-block-object#account_type) in [`GrantBlock`](https://apidocs.chargebee.com/docs/api/grant_blocks).
+- `credit_unit` has been added as a new value to enum attribute [`unit_type`](https://apidocs.chargebee.com/docs/api/grant_blocks/grant-block-object#unit_type) in [`GrantBlock`](https://apidocs.chargebee.com/docs/api/grant_blocks).
+- `credit_unit` has been added as a new value to enum attribute [`unit_type`](https://apidocs.chargebee.com/docs/api/ledger_account_balances/ledger-account-balance-object#unit_type) in [`LedgerAccountBalance`](https://apidocs.chargebee.com/docs/api/ledger_account_balances).
+- `allocation`, `capture`, `authorize`, `release_authorization`, `capture_authorization`, `expiry`, `void`, `rollover`, and `adjustment` have been added as new values to enum attribute [`type`](https://apidocs.chargebee.com/docs/api/ledger_operations/ledger-operation-object#type) in [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations).
+- `credit_unit` has been added as a new value to enum attribute [`unit_type`](https://apidocs.chargebee.com/docs/api/ledger_operations/ledger-operation-object#unit_type) in [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations).
+- `expires_at`, `created_at`, and `effective_from` have been added as new values to enum query parameter `sort_by.asc` in [`list_grant_blocks`](https://apidocs.chargebee.com/docs/api/grant_blocks/list-grant-blocks) of [`GrantBlock`](https://apidocs.chargebee.com/docs/api/grant_blocks).
+- `expires_at`, `created_at`, and `effective_from` have been added as new values to enum query parameter `sort_by.desc` in [`list_grant_blocks`](https://apidocs.chargebee.com/docs/api/grant_blocks/list-grant-blocks) of [`GrantBlock`](https://apidocs.chargebee.com/docs/api/grant_blocks).
+- `allocation`, `release_authorization`, `void`, `capture`, `rollover`, `adjustment`, `expiry`, `authorize`, and `capture_authorization` have been added as new values to enum query parameter `type.is` in [`list_ledger_operations`](https://apidocs.chargebee.com/docs/api/ledger_operations/list-ledger-operations) of [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations).
+- `allocation`, `release_authorization`, `void`, `capture`, `rollover`, `adjustment`, `expiry`, `authorize`, and `capture_authorization` have been added as new values to enum query parameter `type.in` in [`list_ledger_operations`](https://apidocs.chargebee.com/docs/api/ledger_operations/list-ledger-operations) of [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations).
+- `created_at` has been added as a new value to enum query parameter `sort_by.asc` in [`list_ledger_operations`](https://apidocs.chargebee.com/docs/api/ledger_operations/list-ledger-operations) of [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations).
+- `created_at` has been added as a new value to enum query parameter `sort_by.desc` in [`list_ledger_operations`](https://apidocs.chargebee.com/docs/api/ledger_operations/list-ledger-operations) of [`LedgerOperation`](https://apidocs.chargebee.com/docs/api/ledger_operations).
+- `updated_at` and `created_at` have been added as new values to enum query parameter `sort_by.asc` in [`list_omnichannel_subscriptions`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions) of [`OmnichannelSubscription`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions).
+- `updated_at` and `created_at` have been added as new values to enum query parameter `sort_by.desc` in [`list_omnichannel_subscriptions`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions) of [`OmnichannelSubscription`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions).
+
+
+
 ### v3.25.0 (2026-06-08)
 * * *
 ### New Attributes:

VERSION

@@ -1 +1 @@
-3.25.0
+3.26.0

package.json

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

src/environment.ts

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

src/resources/api_endpoints.ts

@@ -111,6 +111,10 @@ interface Endpoints {
   alert: EndpointTuple[];
   filterCondition: EndpointTuple[];
   alertStatus: EndpointTuple[];
+  ledgerAccountBalance: EndpointTuple[];
+  ledgerOperation: EndpointTuple[];
+  grantBlock: EndpointTuple[];
+  promotionalGrant: EndpointTuple[];
   impactedCustomer: EndpointTuple[];
   subscriptionEntitlementsUpdatedDetail: EndpointTuple[];
   subscriptionEntitlementsCreatedDetail: EndpointTuple[];
@@ -5168,6 +5172,125 @@ export const Endpoints: Endpoints = {
       {},
     ],
   ],
+  ledgerAccountBalance: [
+    [
+      'listLedgerAccountBalances',
+      'GET',
+      '/ledger_account_balances',
+      null,
+      false,
+      null,
+      true,
+      {},
+      {},
+    ],
+  ],
+  ledgerOperation: [
+    [
+      'retrieveLedgerOperation',
+      'GET',
+      '/ledger_operations',
+      null,
+      true,
+      null,
+      false,
+      {},
+      {},
+    ],
+    [
+      'listLedgerOperations',
+      'GET',
+      '/ledger_operations',
+      null,
+      false,
+      null,
+      true,
+      {},
+      {},
+    ],
+    [
+      'capture',
+      'POST',
+      '/ledger_operations',
+      '/capture',
+      false,
+      null,
+      true,
+      {
+        metadata: 0,
+      },
+      {},
+    ],
+    [
+      'authorize',
+      'POST',
+      '/ledger_operations',
+      '/authorize',
+      false,
+      null,
+      true,
+      {
+        metadata: 0,
+      },
+      {},
+    ],
+    [
+      'captureAuthorization',
+      'POST',
+      '/ledger_operations',
+      '/capture_authorization',
+      false,
+      null,
+      true,
+      {
+        metadata: 0,
+      },
+      {},
+    ],
+    [
+      'releaseAuthorization',
+      'POST',
+      '/ledger_operations',
+      '/release_authorization',
+      false,
+      null,
+      true,
+      {
+        metadata: 0,
+      },
+      {},
+    ],
+  ],
+  grantBlock: [
+    [
+      'listGrantBlocks',
+      'GET',
+      '/grant_blocks',
+      null,
+      false,
+      null,
+      true,
+      {},
+      {},
+    ],
+  ],
+  promotionalGrant: [
+    [
+      'promotionalGrants',
+      'POST',
+      '/promotional_grants',
+      null,
+      false,
+      null,
+      true,
+      {
+        metadata: 0,
+      },
+      {
+        isIdempotent: true,
+      },
+    ],
+  ],
   impactedCustomer: [],
   subscriptionEntitlementsUpdatedDetail: [],
   subscriptionEntitlementsCreatedDetail: [],

types/core.d.ts

@@ -626,6 +626,7 @@ declare module 'chargebee' {
     | 'js_api'
     | 'migration'
     | 'external_service';
+  type StatusEnum = 'available' | 'exhausted' | 'scheduled' | 'in_grace_period';
   type TaxExemptReasonEnum =
     | 'tax_not_configured'
     | 'region_non_taxable'

types/index.d.ts

@@ -36,6 +36,7 @@
 ///<reference path='./resources/FilterCondition.d.ts' />
 ///<reference path='./resources/GatewayErrorDetail.d.ts' />
 ///<reference path='./resources/Gift.d.ts' />
+///<reference path='./resources/GrantBlock.d.ts' />
 ///<reference path='./resources/Hierarchy.d.ts' />
 ///<reference path='./resources/HostedPage.d.ts' />
 ///<reference path='./resources/ImpactedCustomer.d.ts' />
@@ -49,6 +50,8 @@
 ///<reference path='./resources/ItemEntitlement.d.ts' />
 ///<reference path='./resources/ItemFamily.d.ts' />
 ///<reference path='./resources/ItemPrice.d.ts' />
+///<reference path='./resources/LedgerAccountBalance.d.ts' />
+///<reference path='./resources/LedgerOperation.d.ts' />
 ///<reference path='./resources/Metadata.d.ts' />
 ///<reference path='./resources/NonSubscription.d.ts' />
 ///<reference path='./resources/OfferEvent.d.ts' />
@@ -74,6 +77,7 @@
 ///<reference path='./resources/PriceVariant.d.ts' />
 ///<reference path='./resources/PricingPageSession.d.ts' />
 ///<reference path='./resources/PromotionalCredit.d.ts' />
+///<reference path='./resources/PromotionalGrant.d.ts' />
 ///<reference path='./resources/Purchase.d.ts' />
 ///<reference path='./resources/Quote.d.ts' />
 ///<reference path='./resources/QuoteLineGroup.d.ts' />
@@ -209,13 +213,16 @@ declare module 'chargebee' {
     export: Export.ExportResource;
     feature: Feature.FeatureResource;
     gift: Gift.GiftResource;
+    grantBlock: GrantBlock.GrantBlockResource;
     hostedPage: HostedPage.HostedPageResource;
     inAppSubscription: InAppSubscription.InAppSubscriptionResource;
     invoice: Invoice.InvoiceResource;
     item: Item.ItemResource;
     itemEntitlement: ItemEntitlement.ItemEntitlementResource;
     itemFamily: ItemFamily.ItemFamilyResource;
     itemPrice: ItemPrice.ItemPriceResource;
+    ledgerAccountBalance: LedgerAccountBalance.LedgerAccountBalanceResource;
+    ledgerOperation: LedgerOperation.LedgerOperationResource;
     nonSubscription: NonSubscription.NonSubscriptionResource;
     offerEvent: OfferEvent.OfferEventResource;
     offerFulfillment: OfferFulfillment.OfferFulfillmentResource;
@@ -233,6 +240,7 @@ declare module 'chargebee' {
     priceVariant: PriceVariant.PriceVariantResource;
     pricingPageSession: PricingPageSession.PricingPageSessionResource;
     promotionalCredit: PromotionalCredit.PromotionalCreditResource;
+    promotionalGrant: PromotionalGrant.PromotionalGrantResource;
     purchase: Purchase.PurchaseResource;
     quote: Quote.QuoteResource;
     ramp: Ramp.RampResource;

types/resources/Content.d.ts

@@ -41,6 +41,7 @@ declare module 'chargebee' {
     filter_condition: FilterCondition;
     gateway_error_detail: GatewayErrorDetail;
     gift: Gift;
+    grant_block: GrantBlock;
     hierarchy: Hierarchy;
     hosted_page: HostedPage;
     impacted_customer: ImpactedCustomer;
@@ -54,6 +55,8 @@ declare module 'chargebee' {
     item_entitlement: ItemEntitlement;
     item_family: ItemFamily;
     item_price: ItemPrice;
+    ledger_account_balance: LedgerAccountBalance;
+    ledger_operation: LedgerOperation;
     metadata: Metadata;
     non_subscription: NonSubscription;
     offer_event: OfferEvent;
@@ -79,6 +82,7 @@ declare module 'chargebee' {
     price_variant: PriceVariant;
     pricing_page_session: PricingPageSession;
     promotional_credit: PromotionalCredit;
+    promotional_grant: PromotionalGrant;
     purchase: Purchase;
     quote: Quote;
     quote_line_group: QuoteLineGroup;

types/resources/CreditNote.d.ts

@@ -44,6 +44,7 @@ declare module 'chargebee' {
     local_currency_code?: string;
     round_off_amount?: number;
     fractional_correction?: number;
+    notes?: string[];
     line_items?: CreditNote.LineItem[];
     line_item_tiers?: CreditNote.LineItemTier[];
     line_item_discounts?: CreditNote.LineItemDiscount[];

types/resources/GrantBlock.d.ts

@@ -0,0 +1,59 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+///<reference path='./filter.d.ts'/>
+declare module 'chargebee' {
+  export interface GrantBlock {
+    id: string;
+    granted_amount: string;
+    effective_from: number;
+    expires_at: number;
+    balance: string;
+    hold_amount: string;
+    used_amount: string;
+    expired_amount: string;
+    rolled_over_amount: string;
+    voided_amount: string;
+    origin_grant_block_id?: string;
+    status: StatusEnum;
+    metadata?: string;
+    grant_source:
+      | 'subscription_created'
+      | 'subscription_changed'
+      | 'top_up'
+      | 'promotional_grants'
+      | 'rollover';
+    created_at?: number;
+    account_type?: 'provisioned' | 'overdraft';
+    unit_id?: string;
+    unit_type?: 'credit_unit';
+  }
+
+  export namespace GrantBlock {
+    export class GrantBlockResource {
+      listGrantBlocks(
+        input: ListGrantBlocksInputParam,
+        headers?: ChargebeeRequestHeader,
+      ): Promise<ChargebeeResponse<ListGrantBlocksResponse>>;
+    }
+
+    export interface ListGrantBlocksResponse {
+      list: { grant_block: GrantBlock }[];
+      next_offset?: string;
+    }
+
+    // REQUEST PARAMS
+    //---------------
+
+    export interface ListGrantBlocksInputParam {
+      limit?: number;
+      offset?: string;
+      subscription_id: filter.String;
+      unit_id?: filter.String;
+      effective_from?: filter.Timestamp;
+      expires_at?: filter.Timestamp;
+      created_at?: filter.Timestamp;
+      'sort_by[asc]'?: string;
+      'sort_by[desc]'?: string;
+    }
+  }
+}

types/resources/HostedPage.d.ts

@@ -7,7 +7,6 @@ declare module 'chargebee' {
     type?:
       | 'checkout_new'
       | 'checkout_existing'
-      | 'update_payment_method'
       | 'manage_payment_sources'
       | 'collect_now'
       | 'extend_subscription'
@@ -29,6 +28,7 @@ declare module 'chargebee' {
     embed: boolean;
     created_at?: number;
     expires_at?: number;
+    layout?: LayoutEnum;
     content: Content;
     updated_at?: number;
     resource_version?: number;
@@ -77,6 +77,10 @@ declare module 'chargebee' {
         headers?: ChargebeeRequestHeader,
       ): Promise<ChargebeeResponse<UpdateCardResponse>>;
 
+      /**
+       * @deprecated This method is deprecated and will be removed in a future version.
+       */
+
       updatePaymentMethod(
         input: UpdatePaymentMethodInputParam,
         headers?: ChargebeeRequestHeader,