chargebee 2.41.1 → 2.43.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,71 @@
1
+ ### v2.43.0 (2024-10-17)
2
+ * * *
3
+
4
+ #### New Resource:
5
+ * PaymentScheduleEstimate has been added.
6
+
7
+ ### New Attributes:
8
+ * payment_schedule_estimates has been added to Estimate.
9
+ * usage_accumulation_reset_frequency has been added to ItemPrice.
10
+ * name has been added to PaymentScheduleScheme.
11
+ * usage_accumulation_reset_frequency has been added to QuotedSubscription#SubscriptionItem.
12
+ * usage_accumulation_reset_frequency has been added to Subscription#SubscriptionItem.
13
+
14
+ ### New Endpoints:
15
+ * Estimate#PaymentSchedule has been added.
16
+
17
+ ### New Input Params:
18
+ * usage_accumulation_reset_frequency has been added to ItemPrice#CreateParams.
19
+ * usage_accumulation_reset_frequency has been added to ItemPrice#UpdateParams.
20
+ * discounts has been added to PricingPageSession#CreateForNewSubscriptionParams.
21
+ * discounts has been added to PricingPageSession#CreateForExistingSubscriptionParams.
22
+ * invoice_immediately has been added to Quote#ConvertParams.
23
+
24
+ ### v2.42.0 (2024-09-19)
25
+ * * *
26
+
27
+ #### New Resource:
28
+ * PaymentScheduleScheme has been added.
29
+ * PaymentSchedule has been added.
30
+
31
+ ### New Endpoints:
32
+ * Invoice#ApplyPaymentScheduleScheme has been added.
33
+ * Invoice#PaymentSchedules has been added.
34
+
35
+ ### New Attributes
36
+ * bundle_items[] has been added to Items.
37
+ * bundle_configuration has been added to Items.
38
+
39
+ #### New Input parameters:
40
+ * bundle_configuration has been added to Items#CreateParams, Items#UpdateParams & Items#ListParams.
41
+ * bundle_items_to_add[] has been added to Items#CreateParams & Items#UpdateParams.
42
+ * bundle_items_to_update[] has been added to Items#UpdateParams.
43
+ * bundle_items_to_remove[] has been added to Items#UpdateParams.
44
+ * payment_schedule has been added to Purchase#CreateParams.
45
+
46
+ ### New Enum Values:
47
+ * payment_schedules_created has been added to EventTypeEnum.
48
+ * payment_schedules_updated has been added to EventTypeEnum.
49
+ * payment_schedule_scheme_created has been added to EventTypeEnum.
50
+ * payment_schedule_scheme_deleted has been added to EventTypeEnum.
51
+
52
+ ### Removed Resource:
53
+ * Installment has been removed.
54
+ * InstallmentConfig has been removed.
55
+ * InstallmentDetail has been removed.
56
+
57
+ ### Removed Endpoints:
58
+ * Invoice#Installments has been removed.
59
+
60
+ ### Removed Input parameters:
61
+ * installment_info has been removed from Purchase#CreateParams.
62
+
63
+ ### Removed Enum Values:
64
+ * invoice_installments_created has been removed from EventTypeEnum.
65
+ * invoice_installment_updated has been removed from EventTypeEnum.
66
+ * installment_config_created has been removed from EventTypeEnum.
67
+ * installment_config_deleted has been removed from EventTypeEnum.
68
+
1
69
  ### v2.41.1 (2024-09-02)
2
70
  * * *
3
71
 
package/lib/chargebee.js CHANGED
@@ -11,7 +11,7 @@ ChargeBee._env = {
11
11
  hostSuffix: '.chargebee.com',
12
12
  apiPath: '/api/v2',
13
13
  timeout: 80000,
14
- clientVersion: 'v2.41.1',
14
+ clientVersion: 'v2.43.0',
15
15
  port: 443,
16
16
  timemachineWaitInMillis: 3000,
17
17
  exportWaitInMillis: 3000
@@ -917,10 +917,17 @@ var _endpoints = {
917
917
  true
918
918
  ],
919
919
  [
920
- "installments",
920
+ "apply_payment_schedule_scheme",
921
921
  "POST",
922
922
  "/invoices",
923
- "/installments",
923
+ "/apply_payment_schedule_scheme",
924
+ true
925
+ ],
926
+ [
927
+ "payment_schedules",
928
+ "GET",
929
+ "/invoices",
930
+ "/payment_schedules",
924
931
  true
925
932
  ],
926
933
  [
@@ -939,6 +946,7 @@ var _endpoints = {
939
946
  ]
940
947
  ],
941
948
  "payment_reference_number": [],
949
+ "payment_schedule": [],
942
950
  "tax_withheld": [],
943
951
  "credit_note": [
944
952
  [
@@ -1589,6 +1597,13 @@ var _endpoints = {
1589
1597
  "/estimates",
1590
1598
  "/create_invoice_for_items",
1591
1599
  false
1600
+ ],
1601
+ [
1602
+ "payment_schedules",
1603
+ "POST",
1604
+ "/estimates",
1605
+ "/payment_schedules",
1606
+ false
1592
1607
  ]
1593
1608
  ],
1594
1609
  "quote": [
@@ -2875,46 +2890,29 @@ var _endpoints = {
2875
2890
  false
2876
2891
  ]
2877
2892
  ],
2878
- "installment_config": [
2893
+ "payment_schedule_scheme": [
2879
2894
  [
2880
2895
  "create",
2881
2896
  "POST",
2882
- "/installment_configs",
2897
+ "/payment_schedule_schemes",
2883
2898
  null,
2884
2899
  false
2885
2900
  ],
2886
2901
  [
2887
2902
  "retrieve",
2888
2903
  "GET",
2889
- "/installment_configs",
2904
+ "/payment_schedule_schemes",
2890
2905
  null,
2891
2906
  true
2892
2907
  ],
2893
2908
  [
2894
2909
  "delete",
2895
2910
  "POST",
2896
- "/installment_configs",
2911
+ "/payment_schedule_schemes",
2897
2912
  "/delete",
2898
2913
  true
2899
2914
  ]
2900
2915
  ],
2901
- "installment": [
2902
- [
2903
- "retrieve",
2904
- "GET",
2905
- "/installments",
2906
- null,
2907
- true
2908
- ],
2909
- [
2910
- "list",
2911
- "GET",
2912
- "/installments",
2913
- null,
2914
- false
2915
- ]
2916
- ],
2917
- "installment_detail": [],
2918
2916
  "pricing_page_session": [
2919
2917
  [
2920
2918
  "create_for_new_subscription",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name":"chargebee",
3
- "version":"2.41.1",
3
+ "version":"2.43.0",
4
4
  "description":"A library for integrating with ChargeBee.",
5
5
  "keywords":[
6
6
  "payments",
package/types/core.d.ts CHANGED
@@ -44,7 +44,7 @@ declare module 'chargebee' {
44
44
  type EntityCode = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'p' | 'q' | 'r' | 'med1' | 'med2'
45
45
  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'
46
46
  type EventName = 'cancellation_page_loaded'
47
- 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'
47
+ 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' | 'subscription_ramp_created' | 'subscription_ramp_deleted' | 'subscription_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'
48
48
  type ExportType = 'data' | 'import_friendly_data'
49
49
  type FreePeriodUnit = 'day' | 'week' | 'month' | 'year'
50
50
  type FriendOfferType = 'none' | 'coupon' | 'coupon_code'
@@ -85,6 +85,7 @@ declare module 'chargebee' {
85
85
  type UnbilledChargesHandling = 'no_action' | 'invoice'
86
86
  type UnbilledChargesOption = 'invoice' | 'delete'
87
87
  type UnpaidInvoicesHandling = 'no_action' | 'schedule_payment_collection'
88
+ type UsageAccumulationResetFrequency = 'never' | 'subscription_billing_frequency'
88
89
  type ValidationStatus = 'not_validated' | 'valid' | 'partially_valid' | 'invalid'
89
90
  type VoucherType = 'boleto'
90
91
  type ChargeOn = 'immediately' | 'on_event'
package/types/index.d.ts CHANGED
@@ -33,9 +33,6 @@
33
33
  ///<reference path='./resources/ImpactedItemPrice.d.ts' />
34
34
  ///<reference path='./resources/ImpactedSubscription.d.ts' />
35
35
  ///<reference path='./resources/InAppSubscription.d.ts' />
36
- ///<reference path='./resources/Installment.d.ts' />
37
- ///<reference path='./resources/InstallmentConfig.d.ts' />
38
- ///<reference path='./resources/InstallmentDetail.d.ts' />
39
36
  ///<reference path='./resources/Invoice.d.ts' />
40
37
  ///<reference path='./resources/InvoiceEstimate.d.ts' />
41
38
  ///<reference path='./resources/Item.d.ts' />
@@ -47,6 +44,9 @@
47
44
  ///<reference path='./resources/Order.d.ts' />
48
45
  ///<reference path='./resources/PaymentIntent.d.ts' />
49
46
  ///<reference path='./resources/PaymentReferenceNumber.d.ts' />
47
+ ///<reference path='./resources/PaymentSchedule.d.ts' />
48
+ ///<reference path='./resources/PaymentScheduleEstimate.d.ts' />
49
+ ///<reference path='./resources/PaymentScheduleScheme.d.ts' />
50
50
  ///<reference path='./resources/PaymentSource.d.ts' />
51
51
  ///<reference path='./resources/PaymentVoucher.d.ts' />
52
52
  ///<reference path='./resources/PortalSession.d.ts' />
@@ -98,8 +98,6 @@ declare module 'chargebee' {
98
98
  static gift: Gift.GiftResource;
99
99
  static hosted_page: HostedPage.HostedPageResource;
100
100
  static in_app_subscription: InAppSubscription.InAppSubscriptionResource;
101
- static installment: Installment.InstallmentResource;
102
- static installment_config: InstallmentConfig.InstallmentConfigResource;
103
101
  static invoice: Invoice.InvoiceResource;
104
102
  static item: Item.ItemResource;
105
103
  static item_entitlement: ItemEntitlement.ItemEntitlementResource;
@@ -108,6 +106,7 @@ declare module 'chargebee' {
108
106
  static non_subscription: NonSubscription.NonSubscriptionResource;
109
107
  static order: Order.OrderResource;
110
108
  static payment_intent: PaymentIntent.PaymentIntentResource;
109
+ static payment_schedule_scheme: PaymentScheduleScheme.PaymentScheduleSchemeResource;
111
110
  static payment_source: PaymentSource.PaymentSourceResource;
112
111
  static payment_voucher: PaymentVoucher.PaymentVoucherResource;
113
112
  static portal_session: PortalSession.PortalSessionResource;
@@ -70,7 +70,7 @@ declare module 'chargebee' {
70
70
 
71
71
  */
72
72
 
73
- card_type?:'discover' | 'other' | 'argencard' | 'jcb' | 'mastercard' | 'elo' | 'cencosud' | 'cmr_falabella' | 'american_express' | 'cabal' | 'nativa' | 'bancontact' | 'tarjeta_naranja' | 'carnet' | 'visa' | 'diners_club' | 'rupay' | 'not_applicable' | 'hipercard' | 'maestro';
73
+ card_type?:'visa' | 'mastercard' | 'american_express' | 'discover' | 'jcb' | 'diners_club' | 'bancontact' | 'cmr_falabella' | 'tarjeta_naranja' | 'nativa' | 'cencosud' | 'cabal' | 'argencard' | 'elo' | 'hipercard' | 'carnet' | 'rupay' | 'maestro' | 'dankort' | 'cartes_bancaires' | 'other' | 'not_applicable';
74
74
 
75
75
  /**
76
76
  * @description Card Funding type \* credit - A credit card. \* prepaid - A prepaid card. \* debit - A debit card. \* not_applicable - Used for ACH. Not applicable for cards \* not_known - An unknown card.
@@ -3,21 +3,25 @@
3
3
  declare module 'chargebee' {
4
4
  export interface Estimate {
5
5
 
6
+
6
7
  created_at:number;
7
-
8
+
8
9
  subscription_estimate?:SubscriptionEstimate;
9
-
10
+
10
11
  subscription_estimates?:SubscriptionEstimate[];
11
-
12
+
12
13
  invoice_estimate?:InvoiceEstimate;
13
-
14
+
14
15
  invoice_estimates?:InvoiceEstimate[];
15
-
16
+
17
+ payment_schedule_estimates?:PaymentScheduleEstimate[];
18
+
16
19
  next_invoice_estimate?:InvoiceEstimate;
17
-
20
+
18
21
  credit_note_estimates?:CreditNoteEstimate[];
19
-
22
+
20
23
  unbilled_charge_estimates?:UnbilledCharge[];
24
+
21
25
  }
22
26
  export namespace Estimate {
23
27
  export class EstimateResource {
@@ -58,6 +62,8 @@ declare module 'chargebee' {
58
62
  create_invoice(input?:CreateInvoiceInputParam):ChargebeeRequest<CreateInvoiceResponse>;
59
63
 
60
64
  create_invoice_for_items(input:CreateInvoiceForItemsInputParam):ChargebeeRequest<CreateInvoiceForItemsResponse>;
65
+
66
+ payment_schedules(input:PaymentSchedulesInputParam):ChargebeeRequest<PaymentSchedulesResponse>;
61
67
  }
62
68
  export interface CreateSubscriptionResponse {
63
69
  estimate:Estimate;
@@ -565,6 +571,19 @@ declare module 'chargebee' {
565
571
 
566
572
  invoice_date?:number;
567
573
  }
574
+ export interface PaymentSchedulesResponse {
575
+ estimate:Estimate;
576
+ }
577
+ export interface PaymentSchedulesInputParam {
578
+
579
+ scheme_id:string;
580
+
581
+ amount?:number;
582
+
583
+ invoice_id?:string;
584
+
585
+ payment_schedule_start_date?:number;
586
+ }
568
587
 
569
588
  }
570
589
  }
@@ -746,13 +746,6 @@ All associated [usages](/docs/api/usages?prod_cat_ver&#x3D;2) are permanently de
746
746
 
747
747
  update_details(invoice_id:string, input?:UpdateDetailsInputParam):ChargebeeRequest<UpdateDetailsResponse>;
748
748
 
749
- /**
750
- * @description Creates installments for an invoice, enabling the invoice to be paid in multiple, scheduled payments. **Note: The invoice must be in payment_due.**
751
-
752
- */
753
-
754
- installments(invoice_id:string, input:InstallmentsInputParam):ChargebeeRequest<InstallmentsResponse>;
755
-
756
749
  /**
757
750
  * @description Resend failed einvoice of an invoice to the customer using this API.
758
751
 
@@ -781,6 +774,8 @@ This endpoint schedules e-invoices manually. This operation is not allowed when
781
774
  */
782
775
 
783
776
  send_einvoice(invoice_id:string):ChargebeeRequest<SendEinvoiceResponse>;
777
+ apply_payment_schedule_scheme(invoice_id:string, input:ApplyPaymentScheduleSchemeInputParam):ChargebeeRequest<ApplyPaymentScheduleSchemeResponse>;
778
+ payment_schedules(invoice_id:string):ChargebeeRequest<PaymentSchedulesResponse>;
784
779
  }
785
780
  export interface CreateResponse {
786
781
  invoice:Invoice;
@@ -2170,22 +2165,9 @@ Ireland** . The first two characters of the VAT number in such a case is &#x60;X
2170
2165
 
2171
2166
  statement_descriptor?:{additional_info?:string,descriptor?:string};
2172
2167
  }
2173
- export interface InstallmentsResponse {
2174
- invoice:Invoice;
2175
- }
2176
- export interface InstallmentsInputParam {
2177
-
2178
- /**
2179
- * @description The identifier of the installment_config used to create the installments.
2180
-
2181
- */
2182
-
2183
- config_id:string;
2184
-
2185
- /**
2186
- * @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.
2187
-
2188
- */
2168
+ export interface ApplyPaymentScheduleSchemeInputParam {
2169
+
2170
+ scheme_id:string;
2189
2171
 
2190
2172
  amount?:number;
2191
2173
  }
@@ -2196,7 +2178,12 @@ Ireland** . The first two characters of the VAT number in such a case is &#x60;X
2196
2178
  export interface SendEinvoiceResponse {
2197
2179
  invoice:Invoice;
2198
2180
  }
2199
-
2181
+ export interface ApplyPaymentScheduleSchemeResponse {
2182
+ invoice:Invoice;
2183
+ }
2184
+ export interface PaymentSchedulesResponse {
2185
+ payment_schedules:PaymentSchedule[];
2186
+ }
2200
2187
  export interface LineItem {
2201
2188
  /**
2202
2189
  * @description Uniquely identifies a line_item