Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,63 @@
### v3.25.0 (2026-06-08)
* * *
### New Attributes:
- [`purchased_at`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/omnichannel-subscription-object#purchased_at) has been added to [`OmnichannelSubscription`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions).
- [`updated_at`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/omnichannel-subscription-object#updated_at) has been added to [`OmnichannelSubscription`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions).
- [`updated_at`](https://apidocs.chargebee.com/docs/api/omnichannel_subscription_items/omnichannel-subscription-item-object#updated_at) has been added to [`OmnichannelSubscriptionItem`](https://apidocs.chargebee.com/docs/api/omnichannel_subscription_items).


### New Parameters:
- [`customer_id.in`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#customer_id_in) 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).
- [`customer_id.not_in`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#customer_id_not_in) 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).
- [`id`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#id) 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).
- [`id_at_source`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#id_at_source) 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).
- [`updated_at`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#updated_at) 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).
- [`purchased_at`](https://apidocs.chargebee.com/docs/api/omnichannel_subscriptions/list-omnichannel-subscriptions#purchased_at) 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).
- [`gift_receiver`](https://apidocs.chargebee.com/docs/api/gifts/update-a-gift#gift_receiver) has been added as request body parameter to [`update_a_gift`](https://apidocs.chargebee.com/docs/api/gifts/update-a-gift) in [`Gift`](https://apidocs.chargebee.com/docs/api/gifts).
- [`layout`](https://apidocs.chargebee.com/docs/api/hosted_pages/checkout-gift-subscription-for-items#layout) has been added as request body parameter to [`checkout_gift_subscription_for_items`](https://apidocs.chargebee.com/docs/api/hosted_pages/checkout-gift-subscription-for-items) in [`HostedPage`](https://apidocs.chargebee.com/docs/api/hosted_pages).


### Parameter Updates:
- [`scheduled_at`](https://apidocs.chargebee.com/docs/api/gifts/update-a-gift#scheduled_at) has been changed from required to optional in [`update_a_gift`](https://apidocs.chargebee.com/docs/api/gifts/update-a-gift) of [`Gift`](https://apidocs.chargebee.com/docs/api/gifts).


### New Events:
- [`omnichannel_subscription_item_updated`](https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_updated) has been added.
- [`omnichannel_subscription_item_recovered`](https://apidocs.chargebee.com/docs/api/events/webhook/omnichannel_subscription_item_recovered) has been added.


### Deleted Resources:
- QuoteEntitlement has been removed.


### Deleted Attributes:
- `entity_id` has been removed from `QuoteEntitlement`.
- `entity_type` has been removed from `QuoteEntitlement`.
- `feature_id` has been removed from `QuoteEntitlement`.
- `value` has been removed from `QuoteEntitlement`.
- `is_enabled` has been removed from `QuoteEntitlement`.
- `start_date` has been removed from `QuoteEntitlement`.
- `end_date` has been removed from `QuoteEntitlement`.
- `created_at` has been removed from `QuoteEntitlement`.
- `modified_at` has been removed from `QuoteEntitlement`.


### Deleted Parameters:
- `exclude` has been removed as query parameter from [`list_invoices`](https://apidocs.chargebee.com/docs/api/invoices/list-invoices) in [`Invoice`](https://apidocs.chargebee.com/docs/api/invoices).


### New Enums:
- `omnichannel_subscription_item_updated` and `omnichannel_subscription_item_recovered` have been added as new values enum `EventType`.
- `klarna`, `alipay_hk`, `paypay`, `gcash`, and `south_korean_cards` have been added as new values enum `PaymentMethod`.
- `klarna`, `alipay_hk`, `paypay`, `gcash`, and `south_korean_cards` have been added as new values enum `PaymentMethodType`.
- `klarna`, `alipay_hk`, `paypay`, `gcash`, and `south_korean_cards` have been added as new values enum `Type`.
- `klarna`, `alipay_hk`, `paypay`, `gcash`, and `south_korean_cards` have been added as new values to enum attribute [`payment_method_type`](https://apidocs.chargebee.com/docs/api/payment_intents/payment-intent-object#payment_method_type) in [`PaymentIntent`](https://apidocs.chargebee.com/docs/api/payment_intents).
- `klarna`, `alipay_hk`, `paypay`, `gcash`, and `south_korean_cards` have been added as new values to enum attribute [`active_payment_attempt.payment_method_type`](https://apidocs.chargebee.com/docs/api/payment_intents/payment-intent-object#active_payment_attempt_payment_method_type) in [`PaymentIntent`](https://apidocs.chargebee.com/docs/api/payment_intents).
- `klarna`, `alipay_hk`, `paypay`, `gcash`, and `south_korean_cards` have been added as new values to enum request body parameter `payment_method_type` in [`update_a_payment_intent`](https://apidocs.chargebee.com/docs/api/payment_intents/update-a-payment-intent) of [`PaymentIntent`](https://apidocs.chargebee.com/docs/api/payment_intents).
- `klarna`, `alipay_hk`, `paypay`, `gcash`, and `south_korean_cards` have been added as new values to enum request body parameter `payment_method_type` in [`create_a_payment_intent`](https://apidocs.chargebee.com/docs/api/payment_intents/create-a-payment-intent) of [`PaymentIntent`](https://apidocs.chargebee.com/docs/api/payment_intents).



### v3.24.1 (2026-06-03)
* * *
### Bug Fixes:
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.24.1
3.25.0
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "chargebee",
"version": "3.24.1",
"version": "3.25.0",
"description": "A library for integrating with Chargebee.",
"scripts": {
"prepack": "npm install && npm run build",
Expand Down
2 changes: 1 addition & 1 deletion src/environment.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export const Environment = {
hostSuffix: '.chargebee.com',
apiPath: '/api/v2',
timeout: DEFAULT_TIME_OUT,
clientVersion: 'v3.24.1',
clientVersion: 'v3.25.0',
port: DEFAULT_PORT,
timemachineWaitInMillis: DEFAULT_TIME_MACHINE_WAIT,
exportWaitInMillis: DEFAULT_EXPORT_WAIT,
Expand Down
6 changes: 2 additions & 4 deletions src/resources/api_endpoints.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ interface Endpoints {
quotedDeltaRamp: EndpointTuple[];
billingConfiguration: EndpointTuple[];
quoteLineGroup: EndpointTuple[];
quoteEntitlement: EndpointTuple[];
cpqQuoteSignature: EndpointTuple[];
plan: EndpointTuple[];
addon: EndpointTuple[];
Expand Down Expand Up @@ -92,6 +91,7 @@ interface Endpoints {
ramp: EndpointTuple[];
paymentScheduleScheme: EndpointTuple[];
pricingPageSession: EndpointTuple[];
omnichannelSubscriptionItemScheduledChange: EndpointTuple[];
omnichannelSubscription: EndpointTuple[];
omnichannelTransaction: EndpointTuple[];
omnichannelSubscriptionItem: EndpointTuple[];
Expand All @@ -100,7 +100,6 @@ interface Endpoints {
omnichannelOneTimeOrderItem: EndpointTuple[];
rule: EndpointTuple[];
usageEvent: EndpointTuple[];
omnichannelSubscriptionItemScheduledChange: EndpointTuple[];
usageFile: EndpointTuple[];
personalizedOffer: EndpointTuple[];
brand: EndpointTuple[];
Expand Down Expand Up @@ -3147,7 +3146,6 @@ export const Endpoints: Endpoints = {
quotedDeltaRamp: [],
billingConfiguration: [],
quoteLineGroup: [],
quoteEntitlement: [],
cpqQuoteSignature: [],
plan: [
[
Expand Down Expand Up @@ -4811,6 +4809,7 @@ export const Endpoints: Endpoints = {
},
],
],
omnichannelSubscriptionItemScheduledChange: [],
omnichannelSubscription: [
[
'retrieve',
Expand Down Expand Up @@ -4943,7 +4942,6 @@ export const Endpoints: Endpoints = {
{},
],
],
omnichannelSubscriptionItemScheduledChange: [],
usageFile: [
[
'uploadUrl',
Expand Down
28 changes: 24 additions & 4 deletions src/resources/webhook/content.ts
Original file line number Diff line number Diff line change
Expand Up @@ -459,8 +459,6 @@ export interface OmnichannelSubscriptionCreatedContent {

OmnichannelTransaction: import('chargebee').OmnichannelTransaction;

OmnichannelSubscriptionItemScheduledChange: import('chargebee').OmnichannelSubscriptionItemScheduledChange;

Customer: import('chargebee').Customer;
}

Expand Down Expand Up @@ -594,14 +592,22 @@ export interface OmnichannelSubscriptionItemReactivatedContent {
Customer: import('chargebee').Customer;
}

export interface OmnichannelSubscriptionItemRenewedContent {
export interface OmnichannelSubscriptionItemRecoveredContent {
OmnichannelSubscriptionItem: import('chargebee').OmnichannelSubscriptionItem;

OmnichannelSubscription: import('chargebee').OmnichannelSubscription;

OmnichannelTransaction: import('chargebee').OmnichannelTransaction;

OmnichannelSubscriptionItemScheduledChange: import('chargebee').OmnichannelSubscriptionItemScheduledChange;
Customer: import('chargebee').Customer;
}

export interface OmnichannelSubscriptionItemRenewedContent {
OmnichannelSubscriptionItem: import('chargebee').OmnichannelSubscriptionItem;

OmnichannelSubscription: import('chargebee').OmnichannelSubscription;

OmnichannelTransaction: import('chargebee').OmnichannelTransaction;

Customer: import('chargebee').Customer;
}
Expand Down Expand Up @@ -650,6 +656,16 @@ export interface OmnichannelSubscriptionItemScheduledDowngradeRemovedContent {
Customer: import('chargebee').Customer;
}

export interface OmnichannelSubscriptionItemUpdatedContent {
OmnichannelSubscriptionItem: import('chargebee').OmnichannelSubscriptionItem;

OmnichannelSubscription: import('chargebee').OmnichannelSubscription;

OmnichannelTransaction: import('chargebee').OmnichannelTransaction;

Customer: import('chargebee').Customer;
}

export interface OmnichannelSubscriptionItemUpgradedContent {
OmnichannelSubscriptionItem: import('chargebee').OmnichannelSubscriptionItem;

Expand Down Expand Up @@ -1645,6 +1661,8 @@ export type WebhookContentMap = {

[WebhookEventType.OmnichannelSubscriptionItemReactivated]: OmnichannelSubscriptionItemReactivatedContent;

[WebhookEventType.OmnichannelSubscriptionItemRecovered]: OmnichannelSubscriptionItemRecoveredContent;

[WebhookEventType.OmnichannelSubscriptionItemRenewed]: OmnichannelSubscriptionItemRenewedContent;

[WebhookEventType.OmnichannelSubscriptionItemResubscribed]: OmnichannelSubscriptionItemResubscribedContent;
Expand All @@ -1657,6 +1675,8 @@ export type WebhookContentMap = {

[WebhookEventType.OmnichannelSubscriptionItemScheduledDowngradeRemoved]: OmnichannelSubscriptionItemScheduledDowngradeRemovedContent;

[WebhookEventType.OmnichannelSubscriptionItemUpdated]: OmnichannelSubscriptionItemUpdatedContent;

[WebhookEventType.OmnichannelSubscriptionItemUpgraded]: OmnichannelSubscriptionItemUpgradedContent;

[WebhookEventType.OmnichannelSubscriptionMovedIn]: OmnichannelSubscriptionMovedInContent;
Expand Down
4 changes: 4 additions & 0 deletions src/resources/webhook/eventType.ts
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,8 @@ export enum WebhookEventType {

OmnichannelSubscriptionItemReactivated = 'omnichannel_subscription_item_reactivated',

OmnichannelSubscriptionItemRecovered = 'omnichannel_subscription_item_recovered',

OmnichannelSubscriptionItemRenewed = 'omnichannel_subscription_item_renewed',

OmnichannelSubscriptionItemResubscribed = 'omnichannel_subscription_item_resubscribed',
Expand All @@ -217,6 +219,8 @@ export enum WebhookEventType {

OmnichannelSubscriptionItemScheduledDowngradeRemoved = 'omnichannel_subscription_item_scheduled_downgrade_removed',

OmnichannelSubscriptionItemUpdated = 'omnichannel_subscription_item_updated',

OmnichannelSubscriptionItemUpgraded = 'omnichannel_subscription_item_upgraded',

OmnichannelSubscriptionMovedIn = 'omnichannel_subscription_moved_in',
Expand Down
27 changes: 23 additions & 4 deletions types/core.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,8 @@ declare module 'chargebee' {
| 'omnichannel_subscription_moved_in'
| 'omnichannel_transaction_created'
| 'alert_status_changed'
| 'omnichannel_subscription_item_updated'
| 'omnichannel_subscription_item_recovered'
| 'plan_created'
| 'plan_updated'
| 'plan_deleted'
Expand Down Expand Up @@ -530,7 +532,12 @@ declare module 'chargebee' {
| 'pay_co'
| 'after_pay'
| 'swish'
| 'payme';
| 'payme'
| 'klarna'
| 'alipay_hk'
| 'paypay'
| 'gcash'
| 'south_korean_cards';
type PaymentMethodSavePolicyEnum = 'always' | 'ask' | 'never';
type PaymentMethodTypeEnum =
| 'card'
Expand Down Expand Up @@ -567,14 +574,19 @@ declare module 'chargebee' {
| 'naver_pay'
| 'revolut_pay'
| 'cash_app_pay'
| 'pix'
| 'twint'
| 'go_pay'
| 'grab_pay'
| 'pay_co'
| 'after_pay'
| 'swish'
| 'payme';
| 'payme'
| 'pix'
| 'klarna'
| 'alipay_hk'
| 'paypay'
| 'gcash'
| 'south_korean_cards';
type PaymentVoucherTypeEnum = 'boleto';
type PeriodUnitEnum = 'day' | 'week' | 'month' | 'year';
type PriceTypeEnum = 'tax_exclusive' | 'tax_inclusive';
Expand Down Expand Up @@ -677,14 +689,19 @@ declare module 'chargebee' {
| 'naver_pay'
| 'revolut_pay'
| 'cash_app_pay'
| 'pix'
| 'twint'
| 'go_pay'
| 'grab_pay'
| 'pay_co'
| 'after_pay'
| 'swish'
| 'payme'
| 'pix'
| 'klarna'
| 'alipay_hk'
| 'paypay'
| 'gcash'
| 'south_korean_cards'
| 'free_trial'
| 'pay_up_front'
| 'pay_as_you_go'
Expand Down Expand Up @@ -915,6 +932,8 @@ declare module 'chargebee' {
| 'omnichannel_subscription_moved_in'
| 'omnichannel_transaction_created'
| 'alert_status_changed'
| 'omnichannel_subscription_item_updated'
| 'omnichannel_subscription_item_recovered'
| 'plan_created'
| 'plan_updated'
| 'plan_deleted'
Expand Down
1 change: 0 additions & 1 deletion types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,6 @@
///<reference path='./resources/PromotionalCredit.d.ts' />
///<reference path='./resources/Purchase.d.ts' />
///<reference path='./resources/Quote.d.ts' />
///<reference path='./resources/QuoteEntitlement.d.ts' />
///<reference path='./resources/QuoteLineGroup.d.ts' />
///<reference path='./resources/QuotedCharge.d.ts' />
///<reference path='./resources/QuotedDeltaRamp.d.ts' />
Expand Down
1 change: 0 additions & 1 deletion types/resources/Content.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,6 @@ declare module 'chargebee' {
promotional_credit: PromotionalCredit;
purchase: Purchase;
quote: Quote;
quote_entitlement: QuoteEntitlement;
quote_line_group: QuoteLineGroup;
quoted_charge: QuotedCharge;
quoted_delta_ramp: QuotedDeltaRamp;
Expand Down
18 changes: 14 additions & 4 deletions types/resources/Customer.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -762,14 +762,19 @@ declare module 'chargebee' {
| 'cash_app_pay'
| 'wechat_pay'
| 'alipay'
| 'pix'
| 'twint'
| 'go_pay'
| 'grab_pay'
| 'pay_co'
| 'after_pay'
| 'swish'
| 'payme';
| 'payme'
| 'pix'
| 'klarna'
| 'alipay_hk'
| 'paypay'
| 'gcash'
| 'south_korean_cards';
reference_id?: string;
/**
* @deprecated Please refer API docs to use other attributes
Expand Down Expand Up @@ -954,14 +959,19 @@ declare module 'chargebee' {
| 'cash_app_pay'
| 'wechat_pay'
| 'alipay'
| 'pix'
| 'twint'
| 'go_pay'
| 'grab_pay'
| 'pay_co'
| 'after_pay'
| 'swish'
| 'payme';
| 'payme'
| 'pix'
| 'klarna'
| 'alipay_hk'
| 'paypay'
| 'gcash'
| 'south_korean_cards';
/**
* @deprecated Please refer API docs to use other attributes
*/
Expand Down
Loading
Loading