Release v3.26.0

[cb-alish]

v3.26.0 (2026-06-12)

New Resources:

• GrantBlock has been added.
• LedgerAccountBalance has been added.
• LedgerOperation has been added.
• PromotionalGrant has been added.

New Attributes:

• notes has been added to CreditNote.
• layout has been added to HostedPage.

New Parameters:

• sort_by has been added as query parameter to list_omnichannel_subscriptions in OmnichannelSubscription.

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 in GrantBlock.
• provisioned and overdraft have been added as new values to enum attribute account_type in GrantBlock.
• credit_unit has been added as a new value to enum attribute unit_type in GrantBlock.
• credit_unit has been added as a new value to enum attribute unit_type in LedgerAccountBalance.
• allocation, capture, authorize, release_authorization, capture_authorization, expiry, void, rollover, and adjustment have been added as new values to enum attribute type in LedgerOperation.
• credit_unit has been added as a new value to enum attribute unit_type in LedgerOperation.
• expires_at, created_at, and effective_from have been added as new values to enum query parameter sort_by.asc in list_grant_blocks of GrantBlock.
• expires_at, created_at, and effective_from have been added as new values to enum query parameter sort_by.desc in list_grant_blocks of GrantBlock.
• 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 of LedgerOperation.
• 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 of LedgerOperation.
• created_at has been added as a new value to enum query parameter sort_by.asc in list_ledger_operations of LedgerOperation.
• created_at has been added as a new value to enum query parameter sort_by.desc in list_ledger_operations of LedgerOperation.
• updated_at and created_at have been added as new values to enum query parameter sort_by.asc in list_omnichannel_subscriptions of OmnichannelSubscription.
• updated_at and created_at have been added as new values to enum query parameter sort_by.desc in list_omnichannel_subscriptions of OmnichannelSubscription.

[snyk-io]

✅ Snyk checks have passed. No issues have been found so far.

Status	Scan Engine	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues
✅	Licenses	0	0	0	0	0 issues
✅	Code Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

[hivel-marco]

PR Complexity Score: 4.1 - Moderate

View Breakdown

• Lines Changed: 479
• Files Changed: 16
• Complexity Added: 9
• Raw Score: 71.08

Overview

This PR releases version 3.26.0 of the Chargebee Node client, introducing support for new ledger and grant-related APIs and several new attributes and enums across existing resources. It wires up new API endpoints and TypeScript typings for GrantBlock, LedgerAccountBalance, LedgerOperation, and PromotionalGrant, along with enhanced querying/sorting capabilities. It also adds minor enhancements to CreditNote and HostedPage resources and updates the client version metadata.

Key Changes

• Bumps library version from 3.25.0 to 3.26.0 in metadata (VERSION, package manifests, and Environment.clientVersion).
• Adds new resources and endpoints:
  • GrantBlock: listing grant blocks with filtering/sorting, including new StatusEnum and related enums for grant source, account type, and unit type.
  • LedgerAccountBalance: listing balances per subscription/unit including provisioned and overdraft balances.
  • LedgerOperation: retrieval, listing, and mutation endpoints (capture, authorize, captureAuthorization, releaseAuthorization) with detailed type enums and balance deltas.
  • PromotionalGrant: endpoint to create promotional grants that return associated ledger_operations and grant_blocks.
• Expands existing resources:
  • CreditNote now supports a notes?: string[] attribute.
  • HostedPage now supports a layout?: LayoutEnum attribute, and the updatePaymentMethod method is marked as deprecated in the typings.
  • OmnichannelSubscription.listOmnichannelSubscriptions input now supports sort_by[asc] and sort_by[desc] query parameters.
• Adds a general StatusEnum (available, exhausted, scheduled, in_grace_period) to the core typings and wires new resource types into Content and the main chargebee resource map, enabling typed access to the new APIs.

Risks & Considerations

• Removal of 'update_payment_method' from the HostedPage.type union may cause TypeScript compilation issues for consumers still relying on that enum value.
• New methods and endpoints (ledgerOperation.capture/authorize/..., promotionalGrant.promotionalGrants, grantBlock.listGrantBlocks, ledgerAccountBalance.listLedgerAccountBalances) should be verified against the backend API for URL correctness and expected request/response shapes.
• New enums and filters (especially type and sort_by parameters on ledger/grant/omnichannel endpoints) should be checked to confirm they align exactly with backend validation rules to avoid runtime API errors.
• The new notes array on CreditNote and layout on HostedPage are optional, but downstream code may need updates to leverage them or to avoid assumptions about their absence.

File-level change summary

File	Change summary
CHANGELOG.md	Adds v3.26.0 release notes describing new resources, attributes, parameters, and enum values.
VERSION	Bumps library version from 3.25.0 to 3.26.0.
package-lock.json	Updates package version metadata to 3.26.0 in the lockfile.
package.json	Updates NPM package version from 3.25.0 to 3.26.0.
src/environment.ts	Updates Environment.clientVersion from v3.25.0 to v3.26.0.
src/resources/api_endpoints.ts	Registers new API endpoints for ledger account balances, ledger operations (including capture/authorize flows), grant blocks, and promotional grants.
types/core.d.ts	Introduces a new StatusEnum union type for grant block status values.
types/index.d.ts	Adds references and exported resource handles for GrantBlock, LedgerAccountBalance, LedgerOperation, and PromotionalGrant.
types/resources/Content.d.ts	Extends the content map to include grant_block, ledger_account_balance, ledger_operation, and promotional_grant resource types.
types/resources/CreditNote.d.ts	Adds an optional notes?: string[] field to the CreditNote interface.
types/resources/GrantBlock.d.ts	Introduces the GrantBlock interface and GrantBlockResource with a typed listGrantBlocks method and input/response contracts.
types/resources/HostedPage.d.ts	Removes update_payment_method from the type union, adds optional layout attribute, and marks updatePaymentMethod as deprecated via JSDoc.
types/resources/LedgerAccountBalance.d.ts	Adds LedgerAccountBalance interfaces and LedgerAccountBalanceResource with a typed listLedgerAccountBalances method.
types/resources/LedgerOperation.d.ts	Adds LedgerOperation interfaces and LedgerOperationResource with retrieval, listing, and capture/authorize-related methods and their input/response types.
types/resources/OmnichannelSubscription.d.ts	Extends list input params to support sort_by[asc] and sort_by[desc] for omnichannel subscriptions.
types/resources/PromotionalGrant.d.ts	Adds PromotionalGrant interfaces and PromotionalGrantResource with a promotionalGrants method and corresponding input/response types.

[hivel-marco]

PR Complexity Score: 1.3 - Trivial

View Breakdown

• Lines Changed: 125
• Files Changed: 1
• Complexity Added: 0
• Raw Score: 5.5

Overview

This PR extends the API endpoint configuration to support new ledger-related and promotional grant resources, and adjusts an existing endpoint flag.
It primarily modifies src/resources/api_endpoints.ts by adding endpoint definitions for ledger account balances, ledger operations, grant blocks, and promotional grants, and by tweaking the configuration of an existing endpoint in the grow group.

Key Changes

• Added ledgerAccountBalance endpoint group with a listLedgerAccountBalances GET endpoint for retrieving ledger account balance data.
• Added ledgerOperation endpoint group, including retrieval, listing, and multiple POST operations (capture, authorize, captureAuthorization, releaseAuthorization) with metadata support for managing ledger operations.
• Added grantBlock endpoint group with a listGrantBlocks GET endpoint to fetch grant block records.
• Added promotionalGrant endpoint group with a promotionalGrants POST endpoint that accepts metadata and is marked as idempotent.
• Changed an existing grow-scoped endpoint configuration flag from true to false, altering its behavior (e.g., around pagination, authentication, or feature gating, depending on how this flag is interpreted in the codebase).

Risks & Considerations

• New endpoints must align with backend API contracts (paths, HTTP methods, and expected metadata fields) to avoid runtime errors.
• The toggled grow endpoint flag may change behavior such as feature availability, request handling, or validation, and should be regression-tested against existing consumers.
• Idempotency configuration for promotionalGrants should be verified to ensure repeat submissions are safely handled by the backend.
• Metadata-enabled endpoints (capture, authorize, captureAuthorization, releaseAuthorization, promotionalGrants) should be validated to ensure correct serialization and schema compatibility.

File-level change summary

File	Change summary
src/resources/api_endpoints.ts	Added new endpoint groups for ledger account balances, ledger operations, grant blocks, and promotional grants, and changed a configuration flag from true to false on an existing grow-scoped endpoint.