Releasing v2.34.0. Please check the changelog for the updates.

CHANGELOG.md

@@ -1,3 +1,46 @@
+### v2.34.0 (2024-03-20)
+* * *
+
+#### New resources:
+* Attribute has been added.
+* ImpactedItemPrice has been added.
+* InstallmentConfig has been added.
+* Installment has been added.
+
+#### Removed attributes:
+* product_id has been removed from ItemPrice resource.
+
+#### New Enum values:
+* klarna_pay_now has been added to TypeEnum in Customer resource.
+* klarna_pay_now has been added to PaymentMethodEnum.
+* klarna_pay_now has been added to PaymentMethodTypeEnum enum.
+* klarna_pay_now has been added to TypeEnum.
+* price_variant has been added to EntityTypeEnum.
+* price_variant_created has been added in EventType enum.
+* price_variant_updated has been added in EventType enum.
+* price_variant_deleted has been added in EventType enum.
+
+#### Removed Enum values:
+* product and variant have been removed from EntityTypeEnum.
+
+#### New Input parameters:
+* config_id has been added to Invoice#InstallmentsRequest.
+* amount has been added to Invoice#InstallmentsRequest.
+* payment_source_id has been added to Purchase#CreateRequest.
+* installment_info[config_id] has been added to Purchase#CreateRequest.
+* installment_info[amount] has been added to Purchase#CreateRequest.
+* subscription_info[contract_term_billing_cycle_on_renewal] has been added to Purchase#CreateRequest.
+* contract_terms[index] has been added to Purchase#CreateRequest.
+* contract_terms[action_at_term_end] has been added to Purchase#CreateRequest.
+* contract_terms[cancellation_cutoff_period] has been added to Purchase#CreateRequest.
+* subscription_info[contract_term_billing_cycle_on_renewal] has been added to Purchase#EstimateRequest.
+* contract_terms[index] has been added to Purchase#EstimateRequest.
+* contract_terms[action_at_term_end] has been added to Purchase#EstimateRequest.
+* contract_terms[cancellation_cutoff_period] has been added to Purchase#EstimateRequest.
+
+#### Deprecated input parameters:
+* product_created, product_updated, product_deleted, variant_created, variant_updated, variant_deleted has been deprecated in EventTypeEnum.
+
 ### v2.33.1 (2024-03-06)
 * * *
 * NonSubscription has been added.

lib/chargebee.js

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

lib/resources/api_endpoints.js

@@ -908,6 +908,13 @@ var _endpoints = {
       "/update_details",
       true
     ],
+    [
+      "installments",
+      "POST",
+      "/invoices",
+      "/installments",
+      true
+    ],
     [
       "resend_einvoice",
       "POST",
@@ -2352,6 +2359,7 @@ var _endpoints = {
       true
     ]
   ],
+  "attribute": [],
   "item_price": [
     [
       "create",
@@ -2537,6 +2545,7 @@ var _endpoints = {
   ],
   "impacted_subscription": [],
   "impacted_item": [],
+  "impacted_item_price": [],
   "subscription_entitlement": [
     [
       "subscription_entitlements_for_subscription",
@@ -2699,6 +2708,45 @@ var _endpoints = {
       "/payment_vouchers",
       true
     ]
+  ],
+  "installment_config": [
+    [
+      "create",
+      "POST",
+      "/installment_configs",
+      null,
+      false
+    ],
+    [
+      "retrieve",
+      "GET",
+      "/installment_configs",
+      null,
+      true
+    ],
+    [
+      "delete",
+      "POST",
+      "/installment_configs",
+      "/delete",
+      true
+    ]
+  ],
+  "installment": [
+    [
+      "retrieve",
+      "GET",
+      "/installments",
+      null,
+      true
+    ],
+    [
+      "list",
+      "GET",
+      "/installments",
+      null,
+      false
+    ]
   ]
 };
 module.exports = _endpoints;

package.json

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

types/core.d.ts

@@ -40,9 +40,9 @@ declare module 'chargebee' {
   type EinvoicingMethod = 'automatic' | 'manual' | 'site_default'
   type EndScheduleOn = 'after_number_of_intervals' | 'specific_date' | 'subscription_end'
   type EntityCode = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'p' | 'q' | 'r' | 'med2' | 'med1'
-  type EntityType = 'item' | 'product' | 'coupon' | 'addon' | 'item_price' | 'business_entity' | 'subscription' | 'item_family' | 'credit_note' | 'quote' | 'variant' | 'invoice' | 'plan' | 'transaction' | 'customer' | 'order'
+  type EntityType = 'item' | 'product' | 'coupon' | 'addon' | 'item_price' | 'business_entity' | 'subscription' | 'item_family' | 'credit_note' | 'quote' | 'variant' | 'invoice' | 'plan' | 'transaction' | 'customer' | 'order' | 'price_variant'
   type EventName = 'cancellation_page_loaded'
-  type EventType = 'subscription_pause_scheduled' | 'order_delivered' | 'customer_business_entity_changed' | 'subscription_advance_invoice_schedule_added' | 'gift_expired' | 'tax_withheld_deleted' | 'coupon_codes_added' | 'unbilled_charges_deleted' | 'gift_cancelled' | 'coupon_updated' | 'order_cancelled' | 'coupon_deleted' | 'product_updated' | 'subscription_scheduled_changes_removed' | 'pending_invoice_created' | 'product_deleted' | 'entitlement_overrides_auto_removed' | 'unbilled_charges_created' | 'subscription_resumed' | 'subscription_business_entity_changed' | 'subscription_cancelled' | 'item_entitlements_removed' | 'business_entity_created' | 'payment_source_deleted' | 'quote_deleted' | 'invoice_updated' | 'coupon_set_updated' | 'differential_price_updated' | 'subscription_advance_invoice_schedule_removed' | 'entitlement_overrides_removed' | 'subscription_activated_with_backdating' | 'card_deleted' | 'order_ready_to_ship' | 'subscription_trial_end_reminder' | 'subscription_shipping_address_updated' | 'variant_updated' | 'voucher_create_failed' | 'gift_claimed' | 'business_entity_updated' | 'subscription_scheduled_resumption_removed' | 'payment_initiated' | 'feature_archived' | 'subscription_reactivated_with_backdating' | 'customer_deleted' | 'token_expired' | 'card_added' | 'coupon_created' | 'refund_initiated' | 'invoice_generated_with_backdating' | 'add_usages_reminder' | 'item_price_entitlements_updated' | 'item_price_deleted' | 'virtual_bank_account_deleted' | 'subscription_created' | 'voucher_created' | 'feature_activated' | 'subscription_entitlements_created' | 'payment_source_locally_deleted' | 'order_returned' | 'subscription_deleted' | 'invoice_generated' | 'voucher_expired' | 'authorization_succeeded' | 'payment_source_added' | 'gift_scheduled' | 'item_price_created' | 'subscription_changes_scheduled' | 'subscription_changed_with_backdating' | 'variant_created' | 'subscription_scheduled_cancellation_removed' | 'payment_refunded' | 'gift_unclaimed' | 'product_created' | 'differential_price_created' | 'virtual_bank_account_added' | 'payment_intent_created' | 'transaction_created' | 'credit_note_created_with_backdating' | 'contract_term_terminated' | 'item_family_updated' | 'order_created' | 'payment_succeeded' | 'subscription_canceled_with_backdating' | 'unbilled_charges_voided' | 'quote_created' | 'customer_moved_in' | 'coupon_set_deleted' | 'subscription_advance_invoice_schedule_updated' | 'attached_item_created' | 'customer_changed' | 'subscription_started' | 'item_deleted' | 'subscription_activated' | 'payment_source_expiring' | 'subscription_reactivated' | 'order_updated' | 'subscription_scheduled_pause_removed' | 'subscription_cancellation_reminder' | 'subscription_created_with_backdating' | 'order_deleted' | 'item_entitlements_updated' | 'token_consumed' | 'hierarchy_deleted' | 'subscription_cancellation_scheduled' | 'gift_updated' | 'subscription_trial_extended' | 'subscription_renewed' | 'feature_updated' | 'feature_deleted' | 'item_family_created' | 'card_expiry_reminder' | 'token_created' | 'purchase_created' | 'entitlement_overrides_updated' | 'promotional_credits_added' | 'item_family_deleted' | 'subscription_resumption_scheduled' | 'feature_reactivated' | 'coupon_codes_deleted' | 'card_expired' | 'credit_note_updated' | 'promotional_credits_deducted' | 'payment_source_expired' | 'customer_moved_out' | 'subscription_paused' | 'order_ready_to_process' | 'feature_created' | 'hierarchy_created' | 'attached_item_deleted' | 'transaction_deleted' | 'credit_note_created' | 'item_updated' | 'item_created' | 'coupon_set_created' | 'transaction_updated' | 'payment_intent_updated' | 'variant_deleted' | 'mrr_updated' | 'order_resent' | 'unbilled_charges_invoiced' | 'tax_withheld_recorded' | 'item_price_updated' | 'differential_price_deleted' | 'coupon_codes_updated' | 'virtual_bank_account_updated' | 'contract_term_created' | 'subscription_changed' | 'contract_term_cancelled' | 'contract_term_renewed' | 'invoice_deleted' | 'payment_failed' | 'credit_note_deleted' | 'tax_withheld_refunded' | 'contract_term_completed' | 'item_price_entitlements_removed' | 'card_updated' | 'customer_created' | 'pending_invoice_updated' | 'quote_updated' | 'subscription_renewal_reminder' | 'attached_item_updated' | 'payment_source_updated' | 'business_entity_deleted' | 'authorization_voided' | 'plan_deleted' | 'addon_deleted' | 'addon_updated' | 'addon_created' | 'plan_created' | 'entitlement_overrides_updated' | 'plan_updated'
+  type EventType = 'subscription_pause_scheduled' | 'order_delivered' | 'customer_business_entity_changed' | 'subscription_advance_invoice_schedule_added' | 'gift_expired' | 'tax_withheld_deleted' | 'coupon_codes_added' | 'unbilled_charges_deleted' | 'gift_cancelled' | 'coupon_updated' | 'order_cancelled' | 'coupon_deleted' | 'product_updated' | 'subscription_scheduled_changes_removed' | 'pending_invoice_created' | 'product_deleted' | 'entitlement_overrides_auto_removed' | 'unbilled_charges_created' | 'subscription_resumed' | 'subscription_business_entity_changed' | 'subscription_cancelled' | 'item_entitlements_removed' | 'business_entity_created' | 'payment_source_deleted' | 'quote_deleted' | 'invoice_updated' | 'coupon_set_updated' | 'differential_price_updated' | 'subscription_advance_invoice_schedule_removed' | 'entitlement_overrides_removed' | 'subscription_activated_with_backdating' | 'card_deleted' | 'order_ready_to_ship' | 'subscription_trial_end_reminder' | 'subscription_shipping_address_updated' | 'variant_updated' | 'voucher_create_failed' | 'gift_claimed' | 'business_entity_updated' | 'subscription_scheduled_resumption_removed' | 'payment_initiated' | 'feature_archived' | 'subscription_reactivated_with_backdating' | 'customer_deleted' | 'token_expired' | 'card_added' | 'coupon_created' | 'refund_initiated' | 'invoice_generated_with_backdating' | 'add_usages_reminder' | 'item_price_entitlements_updated' | 'item_price_deleted' | 'virtual_bank_account_deleted' | 'subscription_created' | 'voucher_created' | 'feature_activated' | 'subscription_entitlements_created' | 'payment_source_locally_deleted' | 'order_returned' | 'subscription_deleted' | 'invoice_generated' | 'voucher_expired' | 'authorization_succeeded' | 'payment_source_added' | 'gift_scheduled' | 'item_price_created' | 'subscription_changes_scheduled' | 'subscription_changed_with_backdating' | 'variant_created' | 'subscription_scheduled_cancellation_removed' | 'payment_refunded' | 'gift_unclaimed' | 'product_created' | 'differential_price_created' | 'virtual_bank_account_added' | 'payment_intent_created' | 'transaction_created' | 'credit_note_created_with_backdating' | 'contract_term_terminated' | 'item_family_updated' | 'order_created' | 'payment_succeeded' | 'subscription_canceled_with_backdating' | 'unbilled_charges_voided' | 'quote_created' | 'customer_moved_in' | 'coupon_set_deleted' | 'subscription_advance_invoice_schedule_updated' | 'attached_item_created' | 'customer_changed' | 'subscription_started' | 'item_deleted' | 'subscription_activated' | 'payment_source_expiring' | 'subscription_reactivated' | 'order_updated' | 'subscription_scheduled_pause_removed' | 'subscription_cancellation_reminder' | 'subscription_created_with_backdating' | 'order_deleted' | 'item_entitlements_updated' | 'token_consumed' | 'hierarchy_deleted' | 'subscription_cancellation_scheduled' | 'gift_updated' | 'subscription_trial_extended' | 'subscription_renewed' | 'feature_updated' | 'feature_deleted' | 'item_family_created' | 'card_expiry_reminder' | 'token_created' | 'purchase_created' | 'entitlement_overrides_updated' | 'promotional_credits_added' | 'item_family_deleted' | 'subscription_resumption_scheduled' | 'feature_reactivated' | 'coupon_codes_deleted' | 'card_expired' | 'credit_note_updated' | 'promotional_credits_deducted' | 'payment_source_expired' | 'customer_moved_out' | 'subscription_paused' | 'order_ready_to_process' | 'feature_created' | 'hierarchy_created' | 'attached_item_deleted' | 'transaction_deleted' | 'credit_note_created' | 'item_updated' | 'item_created' | 'coupon_set_created' | 'transaction_updated' | 'payment_intent_updated' | 'variant_deleted' | 'mrr_updated' | 'order_resent' | 'unbilled_charges_invoiced' | 'tax_withheld_recorded' | 'item_price_updated' | 'differential_price_deleted' | 'coupon_codes_updated' | 'virtual_bank_account_updated' | 'contract_term_created' | 'subscription_changed' | 'contract_term_cancelled' | 'contract_term_renewed' | 'invoice_deleted' | 'payment_failed' | 'credit_note_deleted' | 'tax_withheld_refunded' | 'contract_term_completed' | 'item_price_entitlements_removed' | 'card_updated' | 'customer_created' | 'pending_invoice_updated' | 'quote_updated' | 'subscription_renewal_reminder' | 'attached_item_updated' | 'payment_source_updated' | 'business_entity_deleted' | 'authorization_voided' | 'plan_deleted' | 'addon_deleted' | 'addon_updated' | 'addon_created' | 'plan_created' | 'entitlement_overrides_updated' | 'plan_updated' | 'price_variant_deleted' | 'price_variant_updated' | 'price_variant_created'
   type ExportType = 'data' | 'import_friendly_data'
   type FreePeriodUnit = 'week' | 'month' | 'year' | 'day'
   type FriendOfferType = 'coupon_code' | 'coupon' | 'none'
@@ -58,8 +58,8 @@ declare module 'chargebee' {
   type OperationType = 'add' | 'remove'
   type PauseOption = 'end_of_term' | 'billing_cycles' | 'immediately' | 'specific_date'
   type PaymentInitiator = 'merchant' | 'customer'
-  type PaymentMethod = 'other' | 'netbanking_emandates' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'automated_bank_transfer' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card'
-  type PaymentMethodType = 'giropay' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'unionpay' | 'direct_debit' | 'faster_payments' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'automated_bank_transfer' | 'paypal_express_checkout' | 'wechat_pay' | 'pay_to' | 'card'
+  type PaymentMethod = 'other' | 'netbanking_emandates' | 'klarna_pay_now' | 'ach_credit' | 'dotpay' | 'boleto' | 'direct_debit' | 'automated_bank_transfer' | 'chargeback' | 'wechat_pay' | 'pay_to' | 'cash' | 'giropay' | 'bank_transfer' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'custom' | 'unionpay' | 'check' | 'faster_payments' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'sepa_credit' | 'card'
+  type PaymentMethodType = 'giropay' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'unionpay' | 'direct_debit' | 'faster_payments' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'automated_bank_transfer' | 'paypal_express_checkout' | 'wechat_pay' | 'pay_to' | 'card'
   type PaymentVoucherType = 'boleto'
   type PeriodUnit = 'week' | 'month' | 'year' | 'day'
   type PriceType = 'tax_exclusive' | 'tax_inclusive'
@@ -79,7 +79,7 @@ declare module 'chargebee' {
   type Taxability = 'taxable' | 'exempt'
   type TaxjarExemptionCategory = 'other' | 'wholesale' | 'government'
   type TrialEndAction = 'activate_subscription' | 'plan_default' | 'cancel_subscription' | 'site_default'
-  type Type = 'giropay' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'unionpay' | 'direct_debit' | 'faster_payments' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'automated_bank_transfer' | 'paypal_express_checkout' | 'wechat_pay' | 'pay_to' | 'card'
+  type Type = 'giropay' | 'alipay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'unionpay' | 'direct_debit' | 'faster_payments' | 'generic' | 'sofort' | 'amazon_payments' | 'upi' | 'venmo' | 'apple_pay' | 'bancontact' | 'automated_bank_transfer' | 'paypal_express_checkout' | 'wechat_pay' | 'pay_to' | 'card'
   type UnbilledChargesHandling = 'invoice' | 'no_action'
   type UnbilledChargesOption = 'invoice' | 'delete'
   type UnpaidInvoicesHandling = 'schedule_payment_collection' | 'no_action'

types/index.d.ts

@@ -1,6 +1,7 @@
 ///<reference path='./resources/Address.d.ts' />
 ///<reference path='./resources/AdvanceInvoiceSchedule.d.ts' />
 ///<reference path='./resources/AttachedItem.d.ts' />
+///<reference path='./resources/Attribute.d.ts' />
 ///<reference path='./resources/Card.d.ts' />
 ///<reference path='./resources/Comment.d.ts' />
 ///<reference path='./resources/Contact.d.ts' />
@@ -25,8 +26,11 @@
 ///<reference path='./resources/Hierarchy.d.ts' />
 ///<reference path='./resources/HostedPage.d.ts' />
 ///<reference path='./resources/ImpactedItem.d.ts' />
+///<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/Invoice.d.ts' />
 ///<reference path='./resources/InvoiceEstimate.d.ts' />
 ///<reference path='./resources/Item.d.ts' />
@@ -83,6 +87,8 @@ 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;

types/resources/Attribute.d.ts

@@ -0,0 +1,9 @@
+///<reference path='./../core.d.ts'/>
+declare module 'chargebee' {
+  export interface Attribute {
+
+    name:string;
+
+    value:string;
+  }
+}