chargebee 2.41.1 → 2.42.0

package/CHANGELOG.md

@@ -1,3 +1,48 @@
+### v2.42.0 (2024-09-19)
+* * *
+
+#### New Resource:
+* PaymentScheduleScheme has been added. 
+* PaymentSchedule has been added. 
+
+### New Endpoints: 
+* Invoice#ApplyPaymentScheduleScheme has been added. 
+* Invoice#PaymentSchedules has been added. 
+
+### New Attributes 
+* bundle_items[] has been added to Items. 
+* bundle_configuration has been added to Items.
+
+#### New Input parameters: 
+* bundle_configuration has been added to Items#CreateParams, Items#UpdateParams & Items#ListParams.
+* bundle_items_to_add[] has been added to Items#CreateParams & Items#UpdateParams.  
+* bundle_items_to_update[] has been added to Items#UpdateParams.
+* bundle_items_to_remove[] has been added to Items#UpdateParams.
+* payment_schedule has been added to Purchase#CreateParams.
+
+### New Enum Values:
+* payment_schedules_created has been added to EventTypeEnum.
+* payment_schedules_updated has been added to EventTypeEnum.
+* payment_schedule_scheme_created has been added to EventTypeEnum.
+* payment_schedule_scheme_deleted has been added to EventTypeEnum.
+
+### Removed Resource: 
+* Installment has been removed. 
+* InstallmentConfig has been removed.
+* InstallmentDetail has been removed.
+
+### Removed Endpoints: 
+* Invoice#Installments has been removed. 
+
+### Removed Input parameters: 
+* installment_info has been removed from Purchase#CreateParams.
+
+### Removed Enum Values: 
+* invoice_installments_created has been removed from EventTypeEnum.
+* invoice_installment_updated has been removed from EventTypeEnum.
+* installment_config_created has been removed from EventTypeEnum.
+* installment_config_deleted has been removed from EventTypeEnum.
+
 ### v2.41.1 (2024-09-02)
 * * *
 

package/lib/chargebee.js

@@ -11,7 +11,7 @@ ChargeBee._env = {
     hostSuffix: '.chargebee.com',
     apiPath: '/api/v2',
     timeout: 80000,
-    clientVersion: 'v2.41.1',
+    clientVersion: 'v2.42.0',
     port: 443,
     timemachineWaitInMillis: 3000,
     exportWaitInMillis: 3000

package/lib/resources/api_endpoints.js

@@ -917,10 +917,17 @@ var _endpoints = {
       true
     ],
     [
-      "installments",
+      "apply_payment_schedule_scheme",
       "POST",
       "/invoices",
-      "/installments",
+      "/apply_payment_schedule_scheme",
+      true
+    ],
+    [
+      "payment_schedules",
+      "GET",
+      "/invoices",
+      "/payment_schedules",
       true
     ],
     [
@@ -939,6 +946,7 @@ var _endpoints = {
     ]
   ],
   "payment_reference_number": [],
+  "payment_schedule": [],
   "tax_withheld": [],
   "credit_note": [
     [
@@ -2875,46 +2883,29 @@ var _endpoints = {
       false
     ]
   ],
-  "installment_config": [
+  "payment_schedule_scheme": [
     [
       "create",
       "POST",
-      "/installment_configs",
+      "/payment_schedule_schemes",
       null,
       false
     ],
     [
       "retrieve",
       "GET",
-      "/installment_configs",
+      "/payment_schedule_schemes",
       null,
       true
     ],
     [
       "delete",
       "POST",
-      "/installment_configs",
+      "/payment_schedule_schemes",
       "/delete",
       true
     ]
   ],
-  "installment": [
-    [
-      "retrieve",
-      "GET",
-      "/installments",
-      null,
-      true
-    ],
-    [
-      "list",
-      "GET",
-      "/installments",
-      null,
-      false
-    ]
-  ],
-  "installment_detail": [],
   "pricing_page_session": [
     [
       "create_for_new_subscription",

package/package.json

@@ -1,6 +1,6 @@
 {
    "name":"chargebee",
-   "version":"2.41.1",
+   "version":"2.42.0",
    "description":"A library for integrating with ChargeBee.",
    "keywords":[
       "payments",

package/types/core.d.ts

@@ -44,7 +44,7 @@ declare module 'chargebee' {
   type EntityCode = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'p' | 'q' | 'r' | 'med1' | 'med2'
   type EntityType = 'customer' | 'subscription' | 'coupon' | 'plan_item_price' | 'addon_item_price' | 'charge_item_price' | 'invoice' | 'quote' | 'credit_note' | 'transaction' | 'plan' | 'addon' | 'order' | 'item_family' | 'item' | 'item_price' | 'plan_item' | 'addon_item' | 'charge_item' | 'plan_price' | 'addon_price' | 'charge_price' | 'differential_price' | 'attached_item' | 'feature' | 'subscription_entitlement' | 'item_entitlement' | 'business_entity' | 'price_variant'
   type EventName = 'cancellation_page_loaded'
-  type EventType = 'coupon_created' | 'coupon_updated' | 'coupon_deleted' | 'coupon_set_created' | 'coupon_set_updated' | 'coupon_set_deleted' | 'coupon_codes_added' | 'coupon_codes_deleted' | 'coupon_codes_updated' | 'customer_created' | 'customer_changed' | 'customer_deleted' | 'customer_moved_out' | 'customer_moved_in' | 'promotional_credits_added' | 'promotional_credits_deducted' | 'subscription_created' | 'subscription_created_with_backdating' | 'subscription_started' | 'subscription_trial_end_reminder' | 'subscription_activated' | 'subscription_activated_with_backdating' | 'subscription_changed' | 'subscription_trial_extended' | 'mrr_updated' | 'subscription_changed_with_backdating' | 'subscription_cancellation_scheduled' | 'subscription_cancellation_reminder' | 'subscription_cancelled' | 'subscription_canceled_with_backdating' | 'subscription_reactivated' | 'subscription_reactivated_with_backdating' | 'subscription_renewed' | 'subscription_items_renewed' | 'subscription_scheduled_cancellation_removed' | 'subscription_changes_scheduled' | 'subscription_scheduled_changes_removed' | 'subscription_shipping_address_updated' | 'subscription_deleted' | 'subscription_paused' | 'subscription_pause_scheduled' | 'subscription_scheduled_pause_removed' | 'subscription_resumed' | 'subscription_resumption_scheduled' | 'subscription_scheduled_resumption_removed' | 'subscription_advance_invoice_schedule_added' | 'subscription_advance_invoice_schedule_updated' | 'subscription_advance_invoice_schedule_removed' | 'pending_invoice_created' | 'pending_invoice_updated' | 'invoice_generated' | 'invoice_generated_with_backdating' | 'invoice_updated' | 'invoice_deleted' | 'credit_note_created' | 'credit_note_created_with_backdating' | 'credit_note_updated' | 'credit_note_deleted' | 'invoice_installments_created' | 'invoice_installment_updated' | 'installment_config_created' | 'installment_config_deleted' | 'subscription_renewal_reminder' | 'add_usages_reminder' | 'transaction_created' | 'transaction_updated' | 'transaction_deleted' | 'payment_succeeded' | 'payment_failed' | 'payment_refunded' | 'payment_initiated' | 'refund_initiated' | 'authorization_succeeded' | 'authorization_voided' | 'card_added' | 'card_updated' | 'card_expiry_reminder' | 'card_expired' | 'card_deleted' | 'payment_source_added' | 'payment_source_updated' | 'payment_source_deleted' | 'payment_source_expiring' | 'payment_source_expired' | 'payment_source_locally_deleted' | 'virtual_bank_account_added' | 'virtual_bank_account_updated' | 'virtual_bank_account_deleted' | 'token_created' | 'token_consumed' | 'token_expired' | 'unbilled_charges_created' | 'unbilled_charges_voided' | 'unbilled_charges_deleted' | 'unbilled_charges_invoiced' | 'order_created' | 'order_updated' | 'order_cancelled' | 'order_delivered' | 'order_returned' | 'order_ready_to_process' | 'order_ready_to_ship' | 'order_deleted' | 'order_resent' | 'quote_created' | 'quote_updated' | 'quote_deleted' | 'tax_withheld_recorded' | 'tax_withheld_deleted' | 'tax_withheld_refunded' | 'gift_scheduled' | 'gift_unclaimed' | 'gift_claimed' | 'gift_expired' | 'gift_cancelled' | 'gift_updated' | 'hierarchy_created' | 'hierarchy_deleted' | 'payment_intent_created' | 'payment_intent_updated' | 'contract_term_created' | 'contract_term_renewed' | 'contract_term_terminated' | 'contract_term_completed' | 'contract_term_cancelled' | 'item_family_created' | 'item_family_updated' | 'item_family_deleted' | 'item_created' | 'item_updated' | 'item_deleted' | 'item_price_created' | 'item_price_updated' | 'item_price_deleted' | 'attached_item_created' | 'attached_item_updated' | 'attached_item_deleted' | 'differential_price_created' | 'differential_price_updated' | 'differential_price_deleted' | 'feature_created' | 'feature_updated' | 'feature_deleted' | 'feature_activated' | 'feature_reactivated' | 'feature_archived' | 'item_entitlements_updated' | 'entitlement_overrides_updated' | 'entitlement_overrides_removed' | 'item_entitlements_removed' | 'entitlement_overrides_auto_removed' | 'subscription_entitlements_created' | 'business_entity_created' | 'business_entity_updated' | 'business_entity_deleted' | 'customer_business_entity_changed' | 'subscription_business_entity_changed' | 'purchase_created' | 'voucher_created' | 'voucher_expired' | 'voucher_create_failed' | 'item_price_entitlements_updated' | 'item_price_entitlements_removed' | 'ramp_created' | 'ramp_deleted' | 'ramp_applied' | 'subscription_ramp_drafted' | 'subscription_ramp_updated' | 'price_variant_created' | 'price_variant_updated' | 'price_variant_deleted' | 'customer_entitlements_updated' | 'subscription_moved_in' | 'subscription_moved_out' | 'subscription_movement_failed' | 'plan_created' | 'plan_updated' | 'plan_deleted' | 'addon_created' | 'addon_updated' | 'addon_deleted'
+  type EventType = 'coupon_created' | 'coupon_updated' | 'coupon_deleted' | 'coupon_set_created' | 'coupon_set_updated' | 'coupon_set_deleted' | 'coupon_codes_added' | 'coupon_codes_deleted' | 'coupon_codes_updated' | 'customer_created' | 'customer_changed' | 'customer_deleted' | 'customer_moved_out' | 'customer_moved_in' | 'promotional_credits_added' | 'promotional_credits_deducted' | 'subscription_created' | 'subscription_created_with_backdating' | 'subscription_started' | 'subscription_trial_end_reminder' | 'subscription_activated' | 'subscription_activated_with_backdating' | 'subscription_changed' | 'subscription_trial_extended' | 'mrr_updated' | 'subscription_changed_with_backdating' | 'subscription_cancellation_scheduled' | 'subscription_cancellation_reminder' | 'subscription_cancelled' | 'subscription_canceled_with_backdating' | 'subscription_reactivated' | 'subscription_reactivated_with_backdating' | 'subscription_renewed' | 'subscription_items_renewed' | 'subscription_scheduled_cancellation_removed' | 'subscription_changes_scheduled' | 'subscription_scheduled_changes_removed' | 'subscription_shipping_address_updated' | 'subscription_deleted' | 'subscription_paused' | 'subscription_pause_scheduled' | 'subscription_scheduled_pause_removed' | 'subscription_resumed' | 'subscription_resumption_scheduled' | 'subscription_scheduled_resumption_removed' | 'subscription_advance_invoice_schedule_added' | 'subscription_advance_invoice_schedule_updated' | 'subscription_advance_invoice_schedule_removed' | 'pending_invoice_created' | 'pending_invoice_updated' | 'invoice_generated' | 'invoice_generated_with_backdating' | 'invoice_updated' | 'invoice_deleted' | 'credit_note_created' | 'credit_note_created_with_backdating' | 'credit_note_updated' | 'credit_note_deleted' | 'payment_schedules_created' | 'payment_schedules_updated' | 'payment_schedule_scheme_created' | 'payment_schedule_scheme_deleted' | 'subscription_renewal_reminder' | 'add_usages_reminder' | 'transaction_created' | 'transaction_updated' | 'transaction_deleted' | 'payment_succeeded' | 'payment_failed' | 'payment_refunded' | 'payment_initiated' | 'refund_initiated' | 'authorization_succeeded' | 'authorization_voided' | 'card_added' | 'card_updated' | 'card_expiry_reminder' | 'card_expired' | 'card_deleted' | 'payment_source_added' | 'payment_source_updated' | 'payment_source_deleted' | 'payment_source_expiring' | 'payment_source_expired' | 'payment_source_locally_deleted' | 'virtual_bank_account_added' | 'virtual_bank_account_updated' | 'virtual_bank_account_deleted' | 'token_created' | 'token_consumed' | 'token_expired' | 'unbilled_charges_created' | 'unbilled_charges_voided' | 'unbilled_charges_deleted' | 'unbilled_charges_invoiced' | 'order_created' | 'order_updated' | 'order_cancelled' | 'order_delivered' | 'order_returned' | 'order_ready_to_process' | 'order_ready_to_ship' | 'order_deleted' | 'order_resent' | 'quote_created' | 'quote_updated' | 'quote_deleted' | 'tax_withheld_recorded' | 'tax_withheld_deleted' | 'tax_withheld_refunded' | 'gift_scheduled' | 'gift_unclaimed' | 'gift_claimed' | 'gift_expired' | 'gift_cancelled' | 'gift_updated' | 'hierarchy_created' | 'hierarchy_deleted' | 'payment_intent_created' | 'payment_intent_updated' | 'contract_term_created' | 'contract_term_renewed' | 'contract_term_terminated' | 'contract_term_completed' | 'contract_term_cancelled' | 'item_family_created' | 'item_family_updated' | 'item_family_deleted' | 'item_created' | 'item_updated' | 'item_deleted' | 'item_price_created' | 'item_price_updated' | 'item_price_deleted' | 'attached_item_created' | 'attached_item_updated' | 'attached_item_deleted' | 'differential_price_created' | 'differential_price_updated' | 'differential_price_deleted' | 'feature_created' | 'feature_updated' | 'feature_deleted' | 'feature_activated' | 'feature_reactivated' | 'feature_archived' | 'item_entitlements_updated' | 'entitlement_overrides_updated' | 'entitlement_overrides_removed' | 'item_entitlements_removed' | 'entitlement_overrides_auto_removed' | 'subscription_entitlements_created' | 'business_entity_created' | 'business_entity_updated' | 'business_entity_deleted' | 'customer_business_entity_changed' | 'subscription_business_entity_changed' | 'purchase_created' | 'voucher_created' | 'voucher_expired' | 'voucher_create_failed' | 'item_price_entitlements_updated' | 'item_price_entitlements_removed' | 'ramp_created' | 'ramp_deleted' | 'ramp_applied' | 'subscription_ramp_drafted' | 'subscription_ramp_updated' | 'price_variant_created' | 'price_variant_updated' | 'price_variant_deleted' | 'customer_entitlements_updated' | 'subscription_moved_in' | 'subscription_moved_out' | 'subscription_movement_failed' | 'plan_created' | 'plan_updated' | 'plan_deleted' | 'addon_created' | 'addon_updated' | 'addon_deleted'
   type ExportType = 'data' | 'import_friendly_data'
   type FreePeriodUnit = 'day' | 'week' | 'month' | 'year'
   type FriendOfferType = 'none' | 'coupon' | 'coupon_code'

package/types/index.d.ts

@@ -33,9 +33,6 @@
 ///<reference path='./resources/ImpactedItemPrice.d.ts' />
 ///<reference path='./resources/ImpactedSubscription.d.ts' />
 ///<reference path='./resources/InAppSubscription.d.ts' />
-///<reference path='./resources/Installment.d.ts' />
-///<reference path='./resources/InstallmentConfig.d.ts' />
-///<reference path='./resources/InstallmentDetail.d.ts' />
 ///<reference path='./resources/Invoice.d.ts' />
 ///<reference path='./resources/InvoiceEstimate.d.ts' />
 ///<reference path='./resources/Item.d.ts' />
@@ -47,6 +44,8 @@
 ///<reference path='./resources/Order.d.ts' />
 ///<reference path='./resources/PaymentIntent.d.ts' />
 ///<reference path='./resources/PaymentReferenceNumber.d.ts' />
+///<reference path='./resources/PaymentSchedule.d.ts' />
+///<reference path='./resources/PaymentScheduleScheme.d.ts' />
 ///<reference path='./resources/PaymentSource.d.ts' />
 ///<reference path='./resources/PaymentVoucher.d.ts' />
 ///<reference path='./resources/PortalSession.d.ts' />
@@ -98,8 +97,6 @@ declare module 'chargebee' {
     static gift: Gift.GiftResource;
     static hosted_page: HostedPage.HostedPageResource;
     static in_app_subscription: InAppSubscription.InAppSubscriptionResource;
-    static installment: Installment.InstallmentResource;
-    static installment_config: InstallmentConfig.InstallmentConfigResource;
     static invoice: Invoice.InvoiceResource;
     static item: Item.ItemResource;
     static item_entitlement: ItemEntitlement.ItemEntitlementResource;
@@ -108,6 +105,7 @@ declare module 'chargebee' {
     static non_subscription: NonSubscription.NonSubscriptionResource;
     static order: Order.OrderResource;
     static payment_intent: PaymentIntent.PaymentIntentResource;
+    static payment_schedule_scheme: PaymentScheduleScheme.PaymentScheduleSchemeResource;
     static payment_source: PaymentSource.PaymentSourceResource;
     static payment_voucher: PaymentVoucher.PaymentVoucherResource;
     static portal_session: PortalSession.PortalSessionResource;

package/types/resources/Invoice.d.ts

@@ -746,13 +746,6 @@ All associated [usages](/docs/api/usages?prod_cat_ver=2) are permanently de
       
       update_details(invoice_id:string, input?:UpdateDetailsInputParam):ChargebeeRequest<UpdateDetailsResponse>;
        
-      /**
-        * @description Creates installments for an invoice, enabling the invoice to be paid in multiple, scheduled payments. **Note: The invoice must be in payment_due.**
-
-        */
-      
-      installments(invoice_id:string, input:InstallmentsInputParam):ChargebeeRequest<InstallmentsResponse>;
-       
       /**
         * @description Resend failed einvoice of an invoice to the customer using this API.
 
@@ -781,6 +774,8 @@ This endpoint schedules e-invoices manually. This operation is not allowed when
         */
       
       send_einvoice(invoice_id:string):ChargebeeRequest<SendEinvoiceResponse>;
+      apply_payment_schedule_scheme(invoice_id:string, input:ApplyPaymentScheduleSchemeInputParam):ChargebeeRequest<ApplyPaymentScheduleSchemeResponse>;
+      payment_schedules(invoice_id:string):ChargebeeRequest<PaymentSchedulesResponse>;
     }
     export interface CreateResponse {  
        invoice:Invoice;
@@ -2170,22 +2165,9 @@ Ireland** . The first two characters of the VAT number in such a case is &#x60;X
        
       statement_descriptor?:{additional_info?:string,descriptor?:string};
     }
-    export interface InstallmentsResponse {  
-       invoice:Invoice;
-    }
-    export interface InstallmentsInputParam {
-       
-      /**
-        * @description The identifier of the installment_config used to create the installments.
-
-        */
-       
-      config_id:string;
-       
-      /**
-        * @description The part of the invoice.amount_due to be distributed across the installments. If unspecified, the full invoice.amount_due is considered by default.
-
-        */
+    export interface ApplyPaymentScheduleSchemeInputParam {
+         
+      scheme_id:string;
        
       amount?:number;
     }
@@ -2196,7 +2178,12 @@ Ireland** . The first two characters of the VAT number in such a case is &#x60;X
     export interface SendEinvoiceResponse {  
        invoice:Invoice;
     }
-    
+    export interface ApplyPaymentScheduleSchemeResponse {  
+      invoice:Invoice;
+   }
+   export interface PaymentSchedulesResponse {  
+    payment_schedules:PaymentSchedule[];
+   }
     export interface LineItem {  
          /**
           * @description Uniquely identifies a line_item