chargebee 3.28.1 → 3.30.0

package/esm/schema/payment_source.schema.js

@@ -55,6 +55,13 @@ const CreateUsingTempTokenPaymentSourceBodySchema = z.looseObject({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ]),
     tmp_token: z.string().max(65000),
     issuing_country: z.string().max(50).optional(),
@@ -160,6 +167,13 @@ const CreateUsingPermanentTokenPaymentSourceBodySchema = z.looseObject({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ]),
     gateway_account_id: z.string().max(50).optional(),
     reference_id: z.string().max(200).optional(),
@@ -236,6 +250,13 @@ const CreateUsingPaymentIntentPaymentSourcePaymentIntentSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     reference_id: z.string().max(65000).optional(),
@@ -416,6 +437,13 @@ const ListPaymentSourceTypeSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     is_not: z
@@ -467,6 +495,13 @@ const ListPaymentSourceTypeSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     in: z
@@ -518,6 +553,13 @@ const ListPaymentSourceTypeSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     not_in: z
@@ -569,6 +611,13 @@ const ListPaymentSourceTypeSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
 });

package/esm/schema/purchase.schema.js

@@ -66,6 +66,13 @@ const CreatePurchasePaymentIntentSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     reference_id: z.string().max(65000).optional(),

package/esm/schema/ramp.schema.js

@@ -82,6 +82,7 @@ const CreateForSubscriptionRampDiscountsToAddSchema = z.object({
     duration_type: z.array(z.enum(['one_time', 'forever', 'limited_period']).optional()),
     percentage: z.array(z.number().min(0.01).max(100).optional()).optional(),
     amount: z.array(z.number().int().min(0).optional()).optional(),
+    quantity: z.array(z.number().int().min(1).optional()).optional(),
     period: z.array(z.number().int().min(1).optional()).optional(),
     period_unit: z
         .array(z.enum(['day', 'week', 'month', 'year']).optional())
@@ -183,6 +184,7 @@ const UpdateRampDiscountsToAddSchema = z.object({
     duration_type: z.array(z.enum(['one_time', 'forever', 'limited_period']).optional()),
     percentage: z.array(z.number().min(0.01).max(100).optional()).optional(),
     amount: z.array(z.number().int().min(0).optional()).optional(),
+    quantity: z.array(z.number().int().min(1).optional()).optional(),
     period: z.array(z.number().int().min(1).optional()).optional(),
     period_unit: z
         .array(z.enum(['day', 'week', 'month', 'year']).optional())
@@ -206,12 +208,12 @@ const UpdateRampBodySchema = z.looseObject({
 export { UpdateRampBodySchema };
 //Ramp.list
 const ListRampStatusSchema = z.object({
-    is: z.enum(['scheduled', 'succeeded', 'failed', 'draft']).optional(),
     in: z.enum(['scheduled', 'succeeded', 'failed', 'draft']).optional(),
+    is: z.enum(['scheduled', 'succeeded', 'failed', 'draft']).optional(),
 });
 const ListRampSubscriptionIdSchema = z.object({
-    is: z.string().min(1).optional(),
     in: z.string().regex(RegExp('^\\[(.*)(,.*)*\\]$')).optional(),
+    is: z.string().min(1).optional(),
 });
 const ListRampEffectiveFromSchema = z.object({
     after: z.string().regex(RegExp('^\\d{10}$')).optional(),

package/esm/schema/recorded_purchase.schema.js

@@ -5,6 +5,9 @@ import { z } from 'zod';
 //RecordedPurchase.create
 const CreateRecordedPurchaseCustomerSchema = z.object({
     id: z.string().max(50),
+    email: z.string().email().max(70).optional(),
+    first_name: z.string().max(150).optional(),
+    last_name: z.string().max(150).optional(),
 });
 const CreateRecordedPurchaseAppleAppStoreSchema = z.object({
     transaction_id: z.string().max(100).optional(),

package/esm/schema/subscription.schema.js

@@ -232,6 +232,13 @@ const CreateSubscriptionPaymentMethodSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     gateway: z
@@ -354,6 +361,13 @@ const CreateSubscriptionPaymentIntentSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     reference_id: z.string().max(65000).optional(),
@@ -585,6 +599,13 @@ const CreateForCustomerSubscriptionPaymentIntentSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     reference_id: z.string().max(65000).optional(),
@@ -776,6 +797,13 @@ const CreateWithItemsSubscriptionPaymentIntentSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     reference_id: z.string().max(65000).optional(),
@@ -1186,6 +1214,9 @@ const ListSubscriptionChannelSchema = z.object({
     in: z.enum(['web', 'app_store', 'play_store']).optional(),
     not_in: z.enum(['web', 'app_store', 'play_store']).optional(),
 });
+const ListSubscriptionDecommissionedSchema = z.object({
+    is: z.enum(['true', 'false']).optional(),
+});
 const ListSubscriptionPlanIdSchema = z.object({
     is: z.string().min(1).optional(),
     is_not: z.string().min(1).optional(),
@@ -1217,6 +1248,7 @@ const ListSubscriptionBodySchema = z.looseObject({
     sort_by: ListSubscriptionSortBySchema.optional(),
     business_entity_id: ListSubscriptionBusinessEntityIdSchema.optional(),
     channel: ListSubscriptionChannelSchema.optional(),
+    decommissioned: ListSubscriptionDecommissionedSchema.optional(),
     plan_id: ListSubscriptionPlanIdSchema.optional(),
 });
 export { ListSubscriptionBodySchema };
@@ -1402,6 +1434,13 @@ const UpdateSubscriptionPaymentMethodSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     gateway: z
@@ -1524,6 +1563,13 @@ const UpdateSubscriptionPaymentIntentSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     reference_id: z.string().max(65000).optional(),
@@ -1844,6 +1890,13 @@ const UpdateForItemsSubscriptionPaymentMethodSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     gateway: z
@@ -1966,6 +2019,13 @@ const UpdateForItemsSubscriptionPaymentIntentSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     reference_id: z.string().max(65000).optional(),
@@ -2249,6 +2309,13 @@ const ReactivateSubscriptionPaymentIntentSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     reference_id: z.string().max(65000).optional(),
@@ -2555,6 +2622,13 @@ const ImportSubscriptionSubscriptionPaymentMethodSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     gateway: z
@@ -2672,6 +2746,10 @@ const ImportSubscriptionSubscriptionTransactionSchema = z.object({
         'app_store',
         'play_store',
         'custom',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     reference_number: z.string().max(100).optional(),
@@ -2795,6 +2873,10 @@ const ImportForCustomerSubscriptionTransactionSchema = z.object({
         'app_store',
         'play_store',
         'custom',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     reference_number: z.string().max(100).optional(),
@@ -3019,6 +3101,10 @@ const ImportForItemsSubscriptionTransactionSchema = z.object({
         'app_store',
         'play_store',
         'custom',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     reference_number: z.string().max(100).optional(),
@@ -3256,6 +3342,7 @@ const CancelForItemsSubscriptionBodySchema = z.looseObject({
     ])
         .optional(),
     invoice_date: z.number().int().optional(),
+    include_cancellation_day_in_billing: z.boolean().optional(),
     cancel_reason_code: z.string().max(100).optional(),
     decommissioned: z.boolean().default(false).optional(),
     subscription_items: CancelForItemsSubscriptionSubscriptionItemsSchema.optional(),
@@ -3314,6 +3401,13 @@ const ResumeSubscriptionPaymentIntentSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     reference_id: z.string().max(65000).optional(),

package/esm/schema/transaction.schema.js

@@ -22,6 +22,10 @@ const RecordRefundTransactionBodySchema = z.looseObject({
         'app_store',
         'play_store',
         'custom',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ]),
     date: z.number().int(),
     reference_number: z.string().max(100).optional(),
@@ -134,6 +138,13 @@ const ListTransactionPaymentMethodSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     is_not: z
@@ -195,6 +206,13 @@ const ListTransactionPaymentMethodSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     in: z
@@ -256,6 +274,13 @@ const ListTransactionPaymentMethodSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
     not_in: z
@@ -317,6 +342,13 @@ const ListTransactionPaymentMethodSchema = z.object({
         'paypay',
         'gcash',
         'south_korean_cards',
+        'paynow',
+        'bizum',
+        'promptpay',
+        'dana',
+        'touch_n_go',
+        'tamara',
+        'qpay',
     ])
         .optional(),
 });

package/esm/schema/webhook_endpoint.schema.js

@@ -179,6 +179,7 @@ const CreateWebhookEndpointBodySchema = z.looseObject({
         'business_entity_deleted',
         'customer_business_entity_changed',
         'subscription_business_entity_changed',
+        'payment_source_business_entity_changed',
         'purchase_created',
         'voucher_created',
         'voucher_expired',
@@ -240,6 +241,10 @@ const CreateWebhookEndpointBodySchema = z.looseObject({
         'alert_status_changed',
         'omnichannel_subscription_item_updated',
         'omnichannel_subscription_item_recovered',
+        'ledger_account_balance_updated',
+        'grant_blocks_created',
+        'grant_blocks_updated',
+        'ledger_updated',
         'plan_created',
         'plan_updated',
         'plan_deleted',
@@ -425,6 +430,7 @@ const UpdateWebhookEndpointBodySchema = z.looseObject({
         'business_entity_deleted',
         'customer_business_entity_changed',
         'subscription_business_entity_changed',
+        'payment_source_business_entity_changed',
         'purchase_created',
         'voucher_created',
         'voucher_expired',
@@ -486,6 +492,10 @@ const UpdateWebhookEndpointBodySchema = z.looseObject({
         'alert_status_changed',
         'omnichannel_subscription_item_updated',
         'omnichannel_subscription_item_recovered',
+        'ledger_account_balance_updated',
+        'grant_blocks_created',
+        'grant_blocks_updated',
+        'ledger_updated',
         'plan_created',
         'plan_updated',
         'plan_deleted',

package/esm/telemetry/TelemetryAdapter.js

@@ -57,16 +57,16 @@ export function buildRequestEndSpanAttributes(result) {
         [TelemetryAttributeKeys.HTTP_RESPONSE_STATUS_CODE]: result.httpStatusCode,
     };
     if (result.error) {
-        // error.type is the status code on failed requests
-        attributes[TelemetryAttributeKeys.ERROR_TYPE] = String(result.httpStatusCode);
-        if (result.error.chargebeeErrorCode) {
-            attributes[TelemetryAttributeKeys.CHARGEBEE_ERROR_CODE] =
-                result.error.chargebeeErrorCode;
-        }
         if (result.error.chargebeeApiErrorType) {
+            attributes[TelemetryAttributeKeys.ERROR_TYPE] =
+                result.error.chargebeeApiErrorType;
             attributes[TelemetryAttributeKeys.CHARGEBEE_ERROR_TYPE] =
                 result.error.chargebeeApiErrorType;
         }
+        if (result.error.chargebeeErrorCode) {
+            attributes[TelemetryAttributeKeys.CHARGEBEE_ERROR_CODE] =
+                result.error.chargebeeErrorCode;
+        }
         if (result.error.chargebeeErrorParam) {
             attributes[TelemetryAttributeKeys.CHARGEBEE_ERROR_PARAM] =
                 result.error.chargebeeErrorParam;
@@ -94,12 +94,17 @@ export function buildRequestTelemetryResult(result) {
 }
 export function extractRequestTelemetryError(err) {
     if (err == null || typeof err !== 'object') {
+        if (err instanceof Error) {
+            return { message: err.message };
+        }
         return undefined;
     }
     const errorObj = err;
     const message = typeof errorObj.message === 'string'
         ? errorObj.message
-        : 'Chargebee API request failed';
+        : err instanceof Error
+            ? err.message
+            : 'Chargebee API request failed';
     const result = { message };
     if (typeof errorObj.api_error_code === 'string') {
         result.chargebeeErrorCode = errorObj.api_error_code;

package/package.json

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

package/types/core.d.ts

@@ -86,7 +86,11 @@ declare module 'chargebee' {
     | 'not_applicable';
   type DiscountTypeEnum = 'fixed_amount' | 'percentage' | 'price';
   type DispositionTypeEnum = 'attachment' | 'inline';
-  type DunningTypeEnum = 'auto_collect' | 'offline' | 'direct_debit';
+  type DunningTypeEnum =
+    | 'auto_collect'
+    | 'offline'
+    | 'direct_debit'
+    | 'real_time_payments';
   type DurationTypeEnum = 'one_time' | 'forever' | 'limited_period';
   type EcheckTypeEnum = 'web' | 'ppd' | 'ccd';
   type EinvoicingMethodEnum = 'automatic' | 'manual' | 'site_default';
@@ -319,6 +323,7 @@ declare module 'chargebee' {
     | 'business_entity_deleted'
     | 'customer_business_entity_changed'
     | 'subscription_business_entity_changed'
+    | 'payment_source_business_entity_changed'
     | 'purchase_created'
     | 'voucher_created'
     | 'voucher_expired'
@@ -372,6 +377,10 @@ declare module 'chargebee' {
     | 'alert_status_changed'
     | 'omnichannel_subscription_item_updated'
     | 'omnichannel_subscription_item_recovered'
+    | 'ledger_account_balance_updated'
+    | 'grant_blocks_created'
+    | 'grant_blocks_updated'
+    | 'ledger_updated'
     | 'plan_created'
     | 'plan_updated'
     | 'plan_deleted'
@@ -490,6 +499,10 @@ declare module 'chargebee' {
     | 'bank_transfer'
     | 'other'
     | 'custom'
+    | 'dana'
+    | 'touch_n_go'
+    | 'tamara'
+    | 'qpay'
     | 'chargeback'
     | 'card'
     | 'amazon_payments'
@@ -539,7 +552,10 @@ declare module 'chargebee' {
     | 'alipay_hk'
     | 'paypay'
     | 'gcash'
-    | 'south_korean_cards';
+    | 'south_korean_cards'
+    | 'paynow'
+    | 'bizum'
+    | 'promptpay';
   type PaymentMethodSavePolicyEnum = 'always' | 'ask' | 'never';
   type PaymentMethodTypeEnum =
     | 'card'
@@ -588,7 +604,14 @@ declare module 'chargebee' {
     | 'alipay_hk'
     | 'paypay'
     | 'gcash'
-    | 'south_korean_cards';
+    | 'south_korean_cards'
+    | 'paynow'
+    | 'bizum'
+    | 'promptpay'
+    | 'dana'
+    | 'touch_n_go'
+    | 'tamara'
+    | 'qpay';
   type PaymentVoucherTypeEnum = 'boleto';
   type PeriodUnitEnum = 'day' | 'week' | 'month' | 'year';
   type PriceTypeEnum = 'tax_exclusive' | 'tax_inclusive';
@@ -628,7 +651,14 @@ declare module 'chargebee' {
     | 'js_api'
     | 'migration'
     | 'external_service';
-  type StatusEnum = 'available' | 'exhausted' | 'scheduled' | 'in_grace_period';
+  type StatusEnum =
+    | 'active'
+    | 'archived'
+    | 'deleted'
+    | 'available'
+    | 'exhausted'
+    | 'scheduled'
+    | 'in_grace_period';
   type TaxExemptReasonEnum =
     | 'tax_not_configured'
     | 'region_non_taxable'
@@ -649,7 +679,16 @@ declare module 'chargebee' {
     | 'special'
     | 'unincorporated'
     | 'other';
-  type TaxOverrideReasonEnum = 'id_exempt' | 'customer_exempt' | 'export';
+  type TaxOverrideReasonEnum =
+    | 'zero_rated'
+    | 'id_exempt'
+    | 'customer_exempt'
+    | 'region_non_taxable'
+    | 'product_exempt'
+    | 'export'
+    | 'high_value_physical_goods'
+    | 'zero_value_item'
+    | 'tax_not_configured_external_provider';
   type TaxabilityEnum = 'taxable' | 'exempt';
   type TaxjarExemptionCategoryEnum = 'wholesale' | 'government' | 'other';
   type TrialEndActionEnum =
@@ -705,10 +744,25 @@ declare module 'chargebee' {
     | 'paypay'
     | 'gcash'
     | 'south_korean_cards'
+    | 'paynow'
+    | 'bizum'
+    | 'promptpay'
+    | 'dana'
+    | 'touch_n_go'
+    | 'tamara'
+    | 'qpay'
     | 'free_trial'
     | 'pay_up_front'
     | 'pay_as_you_go'
-    | 'usage_exceeded';
+    | 'simple'
+    | 'compound'
+    | 'usage_exceeded'
+    | 'spend_exceeded'
+    | 'credit_balance_dropped'
+    | 'credit'
+    | 'debit'
+    | 'hold'
+    | 'unhold';
   type UnbilledChargesHandlingEnum = 'no_action' | 'invoice';
   type UnbilledChargesOptionEnum = 'invoice' | 'delete';
   type UnpaidInvoicesHandlingEnum = 'no_action' | 'schedule_payment_collection';
@@ -884,6 +938,7 @@ declare module 'chargebee' {
     | 'business_entity_deleted'
     | 'customer_business_entity_changed'
     | 'subscription_business_entity_changed'
+    | 'payment_source_business_entity_changed'
     | 'purchase_created'
     | 'voucher_created'
     | 'voucher_expired'
@@ -937,6 +992,10 @@ declare module 'chargebee' {
     | 'alert_status_changed'
     | 'omnichannel_subscription_item_updated'
     | 'omnichannel_subscription_item_recovered'
+    | 'ledger_account_balance_updated'
+    | 'grant_blocks_created'
+    | 'grant_blocks_updated'
+    | 'ledger_updated'
     | 'plan_created'
     | 'plan_updated'
     | 'plan_deleted'