chargebee 3.30.0 → 3.31.0

package/esm/schema/export.schema.js

@@ -1,5 +1,5 @@
 // Generated Zod schemas: Export
-// Actions: revenueRecognition, deferredRevenue, plans, addons, coupons, customers, subscriptions, invoices, creditNotes, transactions, orders, itemFamilies, items, itemPrices, attachedItems, differentialPrices, priceVariants
+// Actions: revenueRecognition, deferredRevenue, plans, addons, coupons, customers, subscriptions, invoices, creditNotes, transactions, orders, itemFamilies, items, itemPrices, attachedItems, differentialPrices, priceVariants, ramps
 // Do not edit manually – regenerate via sdk-generator
 import { z } from 'zod';
 //Export.revenueRecognition
@@ -1099,8 +1099,8 @@ const CouponsExportCurrencyCodeSchema = z.object({
     not_in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
 });
 const CouponsExportApplicableItemPriceIdsSchema = z.object({
-    in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
     is: z.string().min(1).optional(),
+    in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
 });
 const CouponsExportIdSchema = z.object({
     is: z.string().min(1).optional(),
@@ -3412,3 +3412,35 @@ const PriceVariantsExportBodySchema = z.looseObject({
         .optional(),
 });
 export { PriceVariantsExportBodySchema };
+//Export.ramps
+const RampsExportStatusSchema = z.object({
+    is: z.enum(['scheduled', 'succeeded', 'failed', 'draft']).optional(),
+    in: z.enum(['scheduled', 'succeeded', 'failed', 'draft']).optional(),
+});
+const RampsExportSubscriptionIdSchema = z.object({
+    is: z.string().min(1).optional(),
+    in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
+});
+const RampsExportEffectiveFromSchema = z.object({
+    after: z.string().regex(RegExp('^\\d{10}$')).optional(),
+    before: z.string().regex(RegExp('^\\d{10}$')).optional(),
+    on: z.string().regex(RegExp('^\\d{10}$')).optional(),
+    between: z.string().regex(RegExp('^\\[\\d{10},\\d{10}\\]$')).optional(),
+});
+const RampsExportUpdatedAtSchema = z.object({
+    after: z.string().regex(RegExp('^\\d{10}$')).optional(),
+    before: z.string().regex(RegExp('^\\d{10}$')).optional(),
+    on: z.string().regex(RegExp('^\\d{10}$')).optional(),
+    between: z.string().regex(RegExp('^\\[\\d{10},\\d{10}\\]$')).optional(),
+});
+const RampsExportRampItemSchema = z.object({
+    status: RampsExportStatusSchema.optional(),
+    subscription_id: RampsExportSubscriptionIdSchema.optional(),
+    effective_from: RampsExportEffectiveFromSchema.optional(),
+    updated_at: RampsExportUpdatedAtSchema.optional(),
+});
+const RampsExportBodySchema = z.looseObject({
+    export_type: z.enum(['data', 'import_friendly_data']).optional(),
+    ramp: z.array(RampsExportRampItemSchema.optional()).optional(),
+});
+export { RampsExportBodySchema };

package/esm/schema/hosted_page.schema.js

@@ -1749,6 +1749,7 @@ const PreCancelHostedPageBodySchema = z.looseObject({
     pass_thru_content: z.string().max(2048).optional(),
     cancel_url: z.string().max(250).optional(),
     redirect_url: z.string().max(250).optional(),
+    locale: z.string().max(50).optional(),
     subscription: PreCancelHostedPageSubscriptionSchema.optional(),
 });
 export { PreCancelHostedPageBodySchema };

package/esm/schema/index.js

@@ -55,6 +55,7 @@ export * from './promotional_credit.schema.js';
 export * from './promotional_grant.schema.js';
 export * from './purchase.schema.js';
 export * from './quote.schema.js';
+export * from './quote_entitlement.schema.js';
 export * from './ramp.schema.js';
 export * from './recorded_purchase.schema.js';
 export * from './resource_migration.schema.js';

package/esm/schema/invoice.schema.js

@@ -1,5 +1,5 @@
 // Generated Zod schemas: Invoice
-// Actions: create, createForChargeItemsAndCharges, charge, chargeAddon, createForChargeItem, stopDunning, pauseDunning, resumeDunning, importInvoice, applyPayments, deleteLineItems, applyCredits, list, invoicesForCustomer, invoicesForSubscription, retrieve, pdf, listPaymentReferenceNumbers, addCharge, addAddonCharge, addChargeItem, close, collectPayment, recordPayment, recordTaxWithheld, removeTaxWithheld, refund, recordRefund, removePayment, removeCreditNote, voidInvoice, writeOff, delete, updateDetails, applyPaymentScheduleScheme
+// Actions: create, createForChargeItemsAndCharges, charge, chargeAddon, createForChargeItem, stopDunning, pauseDunning, resumeDunning, importInvoice, applyPayments, deleteLineItems, applyCredits, list, invoicesForCustomer, invoicesForSubscription, retrieve, pdf, listPaymentReferenceNumbers, addCharge, addAddonCharge, addChargeItem, close, collectPayment, recordPayment, recordTaxWithheld, removeTaxWithheld, refund, recordRefund, removePayment, removeCreditNote, voidInvoice, writeOff, voidBeforeCapture, delete, updateDetails, applyPaymentScheduleScheme
 // Do not edit manually – regenerate via sdk-generator
 import { z } from 'zod';
 //Invoice.create
@@ -1421,12 +1421,12 @@ const PdfInvoiceBodySchema = z.looseObject({
 export { PdfInvoiceBodySchema };
 //Invoice.listPaymentReferenceNumbers
 const ListPaymentReferenceNumbersInvoiceIdSchema = z.object({
-    in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
     is: z.string().min(1).optional(),
+    in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
 });
 const ListPaymentReferenceNumbersInvoiceNumberSchema = z.object({
-    in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
     is: z.string().min(1).optional(),
+    in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
 });
 const ListPaymentReferenceNumbersInvoicePaymentReferenceNumberItemSchema = z.object({
     number: ListPaymentReferenceNumbersInvoiceNumberSchema.optional(),
@@ -1679,6 +1679,13 @@ const WriteOffInvoiceBodySchema = z.looseObject({
     comment: z.string().max(300).optional(),
 });
 export { WriteOffInvoiceBodySchema };
+//Invoice.voidBeforeCapture
+const VoidBeforeCaptureInvoiceBodySchema = z.looseObject({
+    comment: z.string().max(300).optional(),
+    void_reason_code: z.string().max(100).optional(),
+    invoice_action: z.enum(['void', 'write_off']).optional(),
+});
+export { VoidBeforeCaptureInvoiceBodySchema };
 //Invoice.delete
 const DeleteInvoiceBodySchema = z.looseObject({
     comment: z.string().max(300).optional(),

package/esm/schema/ledger_operation.schema.js

@@ -16,7 +16,7 @@ const ListLedgerOperationsLedgerOperationCreatedAtSchema = z.object({
     between: z.string().regex(RegExp('^\\[\\d{10},\\d{10}\\]$')).optional(),
 });
 const ListLedgerOperationsLedgerOperationTypeSchema = z.object({
-    in: z
+    is: z
         .enum([
         'allocation',
         'capture',
@@ -29,7 +29,7 @@ const ListLedgerOperationsLedgerOperationTypeSchema = z.object({
         'adjustment',
     ])
         .optional(),
-    is: z
+    in: z
         .enum([
         'allocation',
         'capture',

package/esm/schema/meter.schema.js

@@ -4,8 +4,8 @@
 import { z } from 'zod';
 //Meter.list
 const ListMeterNameSchema = z.object({
-    starts_with: z.string().min(1).optional(),
     is: z.string().min(1).optional(),
+    starts_with: z.string().min(1).optional(),
 });
 const ListMeterSortBySchema = z.looseObject({
     asc: z.enum(['id', 'name', 'created_at', 'updated_at']).optional(),

package/esm/schema/omnichannel_subscription.schema.js

@@ -31,12 +31,16 @@ const ListOmnichannelSubscriptionIdAtSourceSchema = z.object({
     not_in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
 });
 const ListOmnichannelSubscriptionUpdatedAtSchema = z.object({
-    before: z.string().regex(RegExp('^\\d{10}$')).optional(),
     after: z.string().regex(RegExp('^\\d{10}$')).optional(),
+    on: z.string().regex(RegExp('^\\d{10}$')).optional(),
+    before: z.string().regex(RegExp('^\\d{10}$')).optional(),
+    between: z.string().regex(RegExp('^\\[\\d{10},\\d{10}\\]$')).optional(),
 });
 const ListOmnichannelSubscriptionPurchasedAtSchema = z.object({
-    before: z.string().regex(RegExp('^\\d{10}$')).optional(),
     after: z.string().regex(RegExp('^\\d{10}$')).optional(),
+    on: z.string().regex(RegExp('^\\d{10}$')).optional(),
+    before: z.string().regex(RegExp('^\\d{10}$')).optional(),
+    between: z.string().regex(RegExp('^\\[\\d{10},\\d{10}\\]$')).optional(),
 });
 const ListOmnichannelSubscriptionSortBySchema = z.looseObject({
     asc: z.enum(['created_at', 'updated_at']).optional(),

package/esm/schema/payment_intent.schema.js

@@ -3,6 +3,7 @@
 // Do not edit manually – regenerate via sdk-generator
 import { z } from 'zod';
 //PaymentIntent.create
+const CreatePaymentIntentPaymentMethodOptionsSchema = z.looseObject({});
 const CreatePaymentIntentBodySchema = z.looseObject({
     business_entity_id: z.string().max(50).optional(),
     customer_id: z.string().max(50).optional(),
@@ -69,9 +70,11 @@ const CreatePaymentIntentBodySchema = z.looseObject({
         .optional(),
     success_url: z.string().max(250).optional(),
     failure_url: z.string().max(250).optional(),
+    payment_method_options: CreatePaymentIntentPaymentMethodOptionsSchema.optional(),
 });
 export { CreatePaymentIntentBodySchema };
 //PaymentIntent.update
+const UpdatePaymentIntentPaymentMethodOptionsSchema = z.looseObject({});
 const UpdatePaymentIntentBodySchema = z.looseObject({
     amount: z.number().int().min(0).optional(),
     currency_code: z.string().max(3).optional(),
@@ -134,5 +137,6 @@ const UpdatePaymentIntentBodySchema = z.looseObject({
         .optional(),
     success_url: z.string().max(250).optional(),
     failure_url: z.string().max(250).optional(),
+    payment_method_options: UpdatePaymentIntentPaymentMethodOptionsSchema.optional(),
 });
 export { UpdatePaymentIntentBodySchema };

package/esm/schema/payment_source.schema.js

@@ -1,5 +1,5 @@
 // Generated Zod schemas: PaymentSource
-// Actions: createUsingTempToken, createUsingPermanentToken, createUsingToken, createUsingPaymentIntent, createVoucherPaymentSource, createCard, createBankAccount, updateCard, updateBankAccount, verifyBankAccount, list, switchGatewayAccount, exportPaymentSource
+// Actions: createUsingTempToken, createUsingPermanentToken, createUsingToken, createUsingPaymentIntent, createVoucherPaymentSource, createCard, createBankAccount, updateCard, updateBankAccount, verifyBankAccount, listGatewayTokensForPaymentSource, list, switchGatewayAccount, exportPaymentSource
 // Do not edit manually – regenerate via sdk-generator
 import { z } from 'zod';
 //PaymentSource.createUsingTempToken
@@ -379,6 +379,13 @@ const VerifyBankAccountPaymentSourceBodySchema = z.looseObject({
     amount2: z.number().int().min(0),
 });
 export { VerifyBankAccountPaymentSourceBodySchema };
+//PaymentSource.listGatewayTokensForPaymentSource
+const ListGatewayTokensForPaymentSourcePaymentSourceBodySchema = z.looseObject({
+    limit: z.number().int().min(1).max(100).optional(),
+    offset: z.string().max(1000).optional(),
+    include_deleted: z.boolean().default(false).optional(),
+});
+export { ListGatewayTokensForPaymentSourcePaymentSourceBodySchema };
 //PaymentSource.list
 const ListPaymentSourceCustomerIdSchema = z.object({
     is: z.string().min(1).optional(),

package/esm/schema/pricing_page_session.schema.js

@@ -5,7 +5,7 @@ import { z } from 'zod';
 //PricingPageSession.createForNewSubscription
 const CreateForNewSubscriptionPricingPageSessionCustomSchema = z.looseObject({});
 const CreateForNewSubscriptionPricingPageSessionPricingPageSchema = z.object({
-    id: z.string().max(50),
+    id: z.string().max(50).optional(),
 });
 const CreateForNewSubscriptionPricingPageSessionSubscriptionSchema = z.looseObject({
     id: z.string().max(50).optional(),

package/esm/schema/quote.schema.js

@@ -717,6 +717,7 @@ const CreateSubItemsForCustomerQuoteQuoteSubscriptionItemsSchema = z.object({
         .optional(),
     start_date: z.array(z.number().int().optional()).optional(),
     end_date: z.array(z.number().int().optional()).optional(),
+    description: z.array(z.string().max(2000).optional()).optional(),
     ramp_tier_id: z.array(z.string().max(105).optional()).optional(),
 });
 const CreateSubItemsForCustomerQuoteQuoteDiscountsSchema = z.object({
@@ -755,6 +756,19 @@ const CreateSubItemsForCustomerQuoteQuoteCouponsSchema = z.object({
     start_date: z.array(z.number().int().optional()).optional(),
     end_date: z.array(z.number().int().optional()).optional(),
 });
+const CreateSubItemsForCustomerQuoteQuoteEntitlementOverridesSchema = z.object({
+    feature_id: z.array(z.string().max(50).optional()).optional(),
+    entity_id: z.array(z.string().max(100).optional()).optional(),
+    entity_type: z
+        .array(z
+        .enum(['plan_price', 'addon_price', 'charge_price', 'charge'])
+        .optional())
+        .optional(),
+    value: z.array(z.string().max(50).optional()).optional(),
+    is_enabled: z.array(z.boolean().optional()).optional(),
+    start_date: z.array(z.number().int().optional()).optional(),
+    end_date: z.array(z.number().int().optional()).optional(),
+});
 const CreateSubItemsForCustomerQuoteQuoteBodySchema = z.looseObject({
     name: z.string().max(100).optional(),
     notes: z.string().max(10000).optional(),
@@ -774,6 +788,7 @@ const CreateSubItemsForCustomerQuoteQuoteBodySchema = z.looseObject({
     discounts: CreateSubItemsForCustomerQuoteQuoteDiscountsSchema.optional(),
     item_tiers: CreateSubItemsForCustomerQuoteQuoteItemTiersSchema.optional(),
     coupons: CreateSubItemsForCustomerQuoteQuoteCouponsSchema.optional(),
+    entitlement_overrides: CreateSubItemsForCustomerQuoteQuoteEntitlementOverridesSchema.optional(),
 });
 export { CreateSubItemsForCustomerQuoteQuoteBodySchema };
 //Quote.editCreateSubCustomerQuoteForItems
@@ -880,6 +895,7 @@ const EditCreateSubCustomerQuoteForItemsQuoteSubscriptionItemsSchema = z.object(
         .optional(),
     start_date: z.array(z.number().int().optional()).optional(),
     end_date: z.array(z.number().int().optional()).optional(),
+    description: z.array(z.string().max(2000).optional()).optional(),
     ramp_tier_id: z.array(z.string().max(105).optional()).optional(),
 });
 const EditCreateSubCustomerQuoteForItemsQuoteDiscountsSchema = z.object({
@@ -918,6 +934,19 @@ const EditCreateSubCustomerQuoteForItemsQuoteCouponsSchema = z.object({
     start_date: z.array(z.number().int().optional()).optional(),
     end_date: z.array(z.number().int().optional()).optional(),
 });
+const EditCreateSubCustomerQuoteForItemsQuoteEntitlementOverridesSchema = z.object({
+    feature_id: z.array(z.string().max(50).optional()).optional(),
+    entity_id: z.array(z.string().max(100).optional()).optional(),
+    entity_type: z
+        .array(z
+        .enum(['plan_price', 'addon_price', 'charge_price', 'charge'])
+        .optional())
+        .optional(),
+    value: z.array(z.string().max(50).optional()).optional(),
+    is_enabled: z.array(z.boolean().optional()).optional(),
+    start_date: z.array(z.number().int().optional()).optional(),
+    end_date: z.array(z.number().int().optional()).optional(),
+});
 const EditCreateSubCustomerQuoteForItemsQuoteBodySchema = z.looseObject({
     notes: z.string().max(10000).optional(),
     expires_at: z.number().int().optional(),
@@ -936,6 +965,7 @@ const EditCreateSubCustomerQuoteForItemsQuoteBodySchema = z.looseObject({
     discounts: EditCreateSubCustomerQuoteForItemsQuoteDiscountsSchema.optional(),
     item_tiers: EditCreateSubCustomerQuoteForItemsQuoteItemTiersSchema.optional(),
     coupons: EditCreateSubCustomerQuoteForItemsQuoteCouponsSchema.optional(),
+    entitlement_overrides: EditCreateSubCustomerQuoteForItemsQuoteEntitlementOverridesSchema.optional(),
 });
 export { EditCreateSubCustomerQuoteForItemsQuoteBodySchema };
 //Quote.updateSubscriptionQuoteForItems
@@ -1046,6 +1076,7 @@ const UpdateSubscriptionQuoteForItemsQuoteSubscriptionItemsSchema = z.object({
     item_type: z.array(z.enum(['plan', 'addon', 'charge']).optional()).optional(),
     start_date: z.array(z.number().int().optional()).optional(),
     end_date: z.array(z.number().int().optional()).optional(),
+    description: z.array(z.string().max(2000).optional()).optional(),
     ramp_tier_id: z.array(z.string().max(105).optional()).optional(),
 });
 const UpdateSubscriptionQuoteForItemsQuoteDiscountsSchema = z.object({
@@ -1086,6 +1117,19 @@ const UpdateSubscriptionQuoteForItemsQuoteCouponsSchema = z.object({
     start_date: z.array(z.number().int().optional()).optional(),
     end_date: z.array(z.number().int().optional()).optional(),
 });
+const UpdateSubscriptionQuoteForItemsQuoteEntitlementOverridesSchema = z.object({
+    feature_id: z.array(z.string().max(50).optional()).optional(),
+    entity_id: z.array(z.string().max(100).optional()).optional(),
+    entity_type: z
+        .array(z
+        .enum(['plan_price', 'addon_price', 'charge_price', 'charge'])
+        .optional())
+        .optional(),
+    value: z.array(z.string().max(50).optional()).optional(),
+    is_enabled: z.array(z.boolean().optional()).optional(),
+    start_date: z.array(z.number().int().optional()).optional(),
+    end_date: z.array(z.number().int().optional()).optional(),
+});
 const UpdateSubscriptionQuoteForItemsQuoteBodySchema = z.looseObject({
     name: z.string().max(100).optional(),
     notes: z.string().max(10000).optional(),
@@ -1112,6 +1156,7 @@ const UpdateSubscriptionQuoteForItemsQuoteBodySchema = z.looseObject({
     discounts: UpdateSubscriptionQuoteForItemsQuoteDiscountsSchema.optional(),
     item_tiers: UpdateSubscriptionQuoteForItemsQuoteItemTiersSchema.optional(),
     coupons: UpdateSubscriptionQuoteForItemsQuoteCouponsSchema.optional(),
+    entitlement_overrides: UpdateSubscriptionQuoteForItemsQuoteEntitlementOverridesSchema.optional(),
 });
 export { UpdateSubscriptionQuoteForItemsQuoteBodySchema };
 //Quote.editUpdateSubscriptionQuoteForItems
@@ -1223,6 +1268,7 @@ const EditUpdateSubscriptionQuoteForItemsQuoteSubscriptionItemsSchema = z.object
         .optional(),
     start_date: z.array(z.number().int().optional()).optional(),
     end_date: z.array(z.number().int().optional()).optional(),
+    description: z.array(z.string().max(2000).optional()).optional(),
     ramp_tier_id: z.array(z.string().max(105).optional()).optional(),
 });
 const EditUpdateSubscriptionQuoteForItemsQuoteDiscountsSchema = z.object({
@@ -1263,6 +1309,19 @@ const EditUpdateSubscriptionQuoteForItemsQuoteCouponsSchema = z.object({
     start_date: z.array(z.number().int().optional()).optional(),
     end_date: z.array(z.number().int().optional()).optional(),
 });
+const EditUpdateSubscriptionQuoteForItemsQuoteEntitlementOverridesSchema = z.object({
+    feature_id: z.array(z.string().max(50).optional()).optional(),
+    entity_id: z.array(z.string().max(100).optional()).optional(),
+    entity_type: z
+        .array(z
+        .enum(['plan_price', 'addon_price', 'charge_price', 'charge'])
+        .optional())
+        .optional(),
+    value: z.array(z.string().max(50).optional()).optional(),
+    is_enabled: z.array(z.boolean().optional()).optional(),
+    start_date: z.array(z.number().int().optional()).optional(),
+    end_date: z.array(z.number().int().optional()).optional(),
+});
 const EditUpdateSubscriptionQuoteForItemsQuoteBodySchema = z.looseObject({
     notes: z.string().max(10000).optional(),
     expires_at: z.number().int().optional(),
@@ -1288,6 +1347,7 @@ const EditUpdateSubscriptionQuoteForItemsQuoteBodySchema = z.looseObject({
     discounts: EditUpdateSubscriptionQuoteForItemsQuoteDiscountsSchema.optional(),
     item_tiers: EditUpdateSubscriptionQuoteForItemsQuoteItemTiersSchema.optional(),
     coupons: EditUpdateSubscriptionQuoteForItemsQuoteCouponsSchema.optional(),
+    entitlement_overrides: EditUpdateSubscriptionQuoteForItemsQuoteEntitlementOverridesSchema.optional(),
 });
 export { EditUpdateSubscriptionQuoteForItemsQuoteBodySchema };
 //Quote.createForChargeItemsAndCharges

package/esm/schema/quote_entitlement.schema.js

@@ -0,0 +1,22 @@
+// Generated Zod schemas: QuoteEntitlement
+// Actions: listQuoteEntitlements
+// Do not edit manually – regenerate via sdk-generator
+import { z } from 'zod';
+//QuoteEntitlement.listQuoteEntitlements
+const ListQuoteEntitlementsQuoteEntitlementEntityIdSchema = z.object({
+    is: z.string().min(1).optional(),
+});
+const ListQuoteEntitlementsQuoteEntitlementStartDateSchema = z.object({
+    on: z.string().regex(RegExp('^\\d{10}$')).optional(),
+});
+const ListQuoteEntitlementsQuoteEntitlementEndDateSchema = z.object({
+    on: z.string().regex(RegExp('^\\d{10}$')).optional(),
+});
+const ListQuoteEntitlementsQuoteEntitlementBodySchema = z.looseObject({
+    limit: z.number().int().min(1).max(100).optional(),
+    offset: z.string().max(1000).optional(),
+    entity_id: ListQuoteEntitlementsQuoteEntitlementEntityIdSchema.optional(),
+    start_date: ListQuoteEntitlementsQuoteEntitlementStartDateSchema.optional(),
+    end_date: ListQuoteEntitlementsQuoteEntitlementEndDateSchema.optional(),
+});
+export { ListQuoteEntitlementsQuoteEntitlementBodySchema };

package/esm/schema/ramp.schema.js

@@ -208,12 +208,12 @@ const UpdateRampBodySchema = z.looseObject({
 export { UpdateRampBodySchema };
 //Ramp.list
 const ListRampStatusSchema = z.object({
-    in: z.enum(['scheduled', 'succeeded', 'failed', 'draft']).optional(),
     is: z.enum(['scheduled', 'succeeded', 'failed', 'draft']).optional(),
+    in: z.enum(['scheduled', 'succeeded', 'failed', 'draft']).optional(),
 });
 const ListRampSubscriptionIdSchema = z.object({
-    in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
     is: z.string().min(1).optional(),
+    in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
 });
 const ListRampEffectiveFromSchema = z.object({
     after: z.string().regex(RegExp('^\\d{10}$')).optional(),

package/esm/schema/subscription.schema.js

@@ -3279,7 +3279,7 @@ const CancelSubscriptionBodySchema = z.looseObject({
     end_of_term: z.boolean().default(false).optional(),
     cancel_at: z.number().int().optional(),
     credit_option_for_current_term_charges: z
-        .enum(['none', 'prorate', 'full'])
+        .enum(['none', 'prorate', 'full', 'consumption_based'])
         .optional(),
     unbilled_charges_option: z.enum(['invoice', 'delete']).optional(),
     account_receivables_handling: z
@@ -3324,7 +3324,7 @@ const CancelForItemsSubscriptionBodySchema = z.looseObject({
     end_of_term: z.boolean().default(false).optional(),
     cancel_at: z.number().int().optional(),
     credit_option_for_current_term_charges: z
-        .enum(['none', 'prorate', 'full'])
+        .enum(['none', 'prorate', 'full', 'consumption_based'])
         .optional(),
     unbilled_charges_option: z.enum(['invoice', 'delete']).optional(),
     account_receivables_handling: z

package/esm/schema/webhook_endpoint.schema.js

@@ -241,10 +241,14 @@ const CreateWebhookEndpointBodySchema = z.looseObject({
         'alert_status_changed',
         'omnichannel_subscription_item_updated',
         'omnichannel_subscription_item_recovered',
+        'omnichannel_subscription_item_mrr_updated',
         'ledger_account_balance_updated',
         'grant_blocks_created',
         'grant_blocks_updated',
         'ledger_updated',
+        'vault_token_created',
+        'vault_token_updated',
+        'vault_token_deleted',
         'plan_created',
         'plan_updated',
         'plan_deleted',
@@ -492,10 +496,14 @@ const UpdateWebhookEndpointBodySchema = z.looseObject({
         'alert_status_changed',
         'omnichannel_subscription_item_updated',
         'omnichannel_subscription_item_recovered',
+        'omnichannel_subscription_item_mrr_updated',
         'ledger_account_balance_updated',
         'grant_blocks_created',
         'grant_blocks_updated',
         'ledger_updated',
+        'vault_token_created',
+        'vault_token_updated',
+        'vault_token_deleted',
         'plan_created',
         'plan_updated',
         'plan_deleted',

package/esm/util.js

@@ -106,9 +106,11 @@ export function getApiURL(env, urlPrefix, urlSuffix, urlIdParam) {
             : '') +
         (urlSuffix !== null ? urlSuffix : ''));
 }
+// Filter operators whose value is the whole array, sent as a single field
+// (e.g. updated_at[between]=[1704067200,1717199999]).
+const arrayOperators = ['in', 'not_in', 'between'];
 export function serialize(paramObj) {
     let key, value;
-    let array_ops = ['in', 'not_in', 'between'];
     for (key in paramObj) {
         value = paramObj[key];
         if (typeof value === 'object' && isObject(value)) {
@@ -117,7 +119,7 @@ export function serialize(paramObj) {
             for (child_key in value) {
                 key = key + '[' + child_key + ']';
                 paramObj[key] = value[child_key];
-                if (array_ops.includes(child_key)) {
+                if (arrayOperators.includes(child_key)) {
                     paramObj[key] = JSON.stringify(value[child_key]);
                 }
             }
@@ -172,6 +174,14 @@ export function encodeParams(paramObj, serialized, scope, index, jsonKeys, level
             }
             serialized.push(encodeURIComponent(key) + '=' + attrVal);
         }
+        else if (isArray(value) && arrayOperators.includes(originalKey)) {
+            // An empty filter is not a filter, so leave it out of the request.
+            if (value.length > 0) {
+                serialized.push(encodeURIComponent(key) +
+                    '=' +
+                    encodeURIComponent(JSON.stringify(value)));
+            }
+        }
         else if (isArray(value) &&
             !(jsonKeys && jsonKeys[originalKey] === level)) {
             for (let arrIdx = 0; arrIdx < value.length; arrIdx++) {

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "chargebee",
-  "version": "3.30.0",
+  "version": "3.31.0",
   "description": "A library for integrating with Chargebee.",
   "scripts": {
-    "prepack": "npm install && npm run build",
+    "prepack": "npm ci && npm run build",
     "test": "TS_NODE_PROJECT=./tsconfig.test.json mocha -r ts-node/register 'test/**/*.test.ts'",
     "build": "npm run build-esm && npm run build-cjs",
     "build-esm": "rm -rf esm && mkdir -p esm && tsc -p tsconfig.esm.json && echo '{\"type\":\"module\"}' > esm/package.json",

package/types/core.d.ts

@@ -67,7 +67,11 @@ declare module 'chargebee' {
     | 'end_of_contract_term'
     | 'specific_date'
     | 'end_of_subscription_billing_term';
-  type CreditOptionForCurrentTermChargesEnum = 'none' | 'prorate' | 'full';
+  type CreditOptionForCurrentTermChargesEnum =
+    | 'none'
+    | 'prorate'
+    | 'full'
+    | 'consumption_based';
   type CreditTypeEnum = 'loyalty_credits' | 'referral_rewards' | 'general';
   type CustomerTypeEnum =
     | 'residential'
@@ -128,7 +132,6 @@ declare module 'chargebee' {
     | 'plan_price'
     | 'addon_price'
     | 'charge_price'
-    | 'charge'
     | 'invoice'
     | 'quote'
     | 'credit_note'
@@ -160,7 +163,8 @@ declare module 'chargebee' {
     | 'usage_file'
     | 'business_rule'
     | 'ruleset'
-    | 'alert_status';
+    | 'alert_status'
+    | 'omnichannel_subscription_item_metric';
   type EventNameEnum = 'cancellation_page_loaded';
   type EventTypeEnum =
     | 'coupon_created'
@@ -377,10 +381,14 @@ declare module 'chargebee' {
     | 'alert_status_changed'
     | 'omnichannel_subscription_item_updated'
     | 'omnichannel_subscription_item_recovered'
+    | 'omnichannel_subscription_item_mrr_updated'
     | 'ledger_account_balance_updated'
     | 'grant_blocks_created'
     | 'grant_blocks_updated'
     | 'ledger_updated'
+    | 'vault_token_created'
+    | 'vault_token_updated'
+    | 'vault_token_deleted'
     | 'plan_created'
     | 'plan_updated'
     | 'plan_deleted'
@@ -453,10 +461,73 @@ declare module 'chargebee' {
     | 'payway'
     | 'gocardless'
     | 'not_applicable';
+  type GatewayNameEnum =
+    | 'chargebee'
+    | 'chargebee_payments'
+    | 'adyen'
+    | 'stripe'
+    | 'wepay'
+    | 'braintree'
+    | 'authorize_net'
+    | 'paypal_pro'
+    | 'pin'
+    | 'eway'
+    | 'eway_rapid'
+    | 'worldpay'
+    | 'balanced_payments'
+    | 'beanstream'
+    | 'bluepay'
+    | 'elavon'
+    | 'first_data_global'
+    | 'hdfc'
+    | 'migs'
+    | 'nmi'
+    | 'ogone'
+    | 'paymill'
+    | 'paypal_payflow_pro'
+    | 'sage_pay'
+    | 'tco'
+    | 'wirecard'
+    | 'amazon_payments'
+    | 'paypal_express_checkout'
+    | 'gocardless'
+    | 'orbital'
+    | 'moneris_us'
+    | 'moneris'
+    | 'bluesnap'
+    | 'cybersource'
+    | 'vantiv'
+    | 'checkout_com'
+    | 'paypal'
+    | 'ingenico_direct'
+    | 'exact'
+    | 'mollie'
+    | 'quickbooks'
+    | 'razorpay'
+    | 'global_payments'
+    | 'bank_of_america'
+    | 'ecentric'
+    | 'metrics_global'
+    | 'windcave'
+    | 'pay_com'
+    | 'ebanx'
+    | 'dlocal'
+    | 'nuvei'
+    | 'solidgate'
+    | 'paystack'
+    | 'jp_morgan'
+    | 'deutsche_bank'
+    | 'ezidebit'
+    | 'twikey'
+    | 'tempus'
+    | 'moyasar'
+    | 'payway'
+    | 'not_applicable';
   type HierarchyOperationTypeEnum =
     | 'complete_hierarchy'
     | 'subordinates'
     | 'path_to_root';
+  type InvoiceActionEnum = 'void' | 'write_off';
   type InvoiceDunningHandlingEnum = 'continue' | 'stop';
   type ItemTypeEnum = 'plan' | 'addon' | 'charge';
   type LayoutEnum = 'in_app' | 'full_page';
@@ -992,10 +1063,14 @@ declare module 'chargebee' {
     | 'alert_status_changed'
     | 'omnichannel_subscription_item_updated'
     | 'omnichannel_subscription_item_recovered'
+    | 'omnichannel_subscription_item_mrr_updated'
     | 'ledger_account_balance_updated'
     | 'grant_blocks_created'
     | 'grant_blocks_updated'
     | 'ledger_updated'
+    | 'vault_token_created'
+    | 'vault_token_updated'
+    | 'vault_token_deleted'
     | 'plan_created'
     | 'plan_updated'
     | 'plan_deleted'