chargebee 2.39.0 → 2.41.0

package/CHANGELOG.md

@@ -1,3 +1,34 @@
+### v2.41.0 (2024-08-29)
+* * *
+
+#### New Resource:
+* CustomerEntitlement has been added. 
+
+#### New Endpoints:
+* Ramp#UpdateRequest has been added to Ramp resource.
+* Transaction#ReconcileRequest has been added to Transaction resource. 
+
+### New Attributes: 
+* arr has been added to Subscription. 
+
+### New Enum Values: 
+* customer_entitlements_updated has been added to EntityTypeEnum.
+* subscription_moved_in has been added in EventType enum.
+* subscription_moved_out has been added in EventType enum.
+* subscription_movement_failed has been added in EventType enum.
+
+### v2.40.0 (2024-08-14)
+* * *
+
+#### New Attributes:
+* feature_type has been added in SubscriptionEntitlement.
+* business_entity_id has been made optional in Quote.
+* business_entity_id has been made optional in CreditNote.
+
+#### New Input parameters: 
+* invoice_usages has been added in Subscription#UpdateForItemsRequest.
+* invoice_usages has been added in Estimate#UpdateSubscriptionForItemsRequest.
+
 ### v2.39.0 (2024-07-31)
 * * *
 

package/lib/chargebee.js

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

package/lib/resources/api_endpoints.js

@@ -1243,6 +1243,13 @@ var _endpoints = {
       "/record_refund",
       true
     ],
+    [
+      "reconcile",
+      "POST",
+      "/transactions",
+      "/reconcile",
+      true
+    ],
     [
       "refund",
       "POST",
@@ -2615,6 +2622,15 @@ var _endpoints = {
       true
     ]
   ],
+  "customer_entitlement": [
+    [
+      "entitlements_for_customer",
+      "GET",
+      "/customers",
+      "/customer_entitlements",
+      true
+    ]
+  ],
   "item_entitlement": [
     [
       "item_entitlements_for_item",
@@ -2830,6 +2846,13 @@ var _endpoints = {
       "/create_ramp",
       true
     ],
+    [
+      "update",
+      "POST",
+      "/ramps",
+      "/update",
+      true
+    ],
     [
       "retrieve",
       "GET",

package/package.json

@@ -1,6 +1,6 @@
 {
    "name":"chargebee",
-   "version":"2.39.0",
+   "version":"2.41.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' | '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' | '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 ExportType = 'data' | 'import_friendly_data'
   type FreePeriodUnit = 'day' | 'week' | 'month' | 'year'
   type FriendOfferType = 'none' | 'coupon' | 'coupon_code'

package/types/index.d.ts

@@ -15,6 +15,7 @@
 ///<reference path='./resources/CreditNoteEstimate.d.ts' />
 ///<reference path='./resources/Currency.d.ts' />
 ///<reference path='./resources/Customer.d.ts' />
+///<reference path='./resources/CustomerEntitlement.d.ts' />
 ///<reference path='./resources/DifferentialPrice.d.ts' />
 ///<reference path='./resources/Discount.d.ts' />
 ///<reference path='./resources/Download.d.ts' />
@@ -86,6 +87,7 @@ declare module 'chargebee' {
     static credit_note: CreditNote.CreditNoteResource;
     static currency: Currency.CurrencyResource;
     static customer: Customer.CustomerResource;
+    static customer_entitlement: CustomerEntitlement.CustomerEntitlementResource;
     static differential_price: DifferentialPrice.DifferentialPriceResource;
     static entitlement: Entitlement.EntitlementResource;
     static entitlement_override: EntitlementOverride.EntitlementOverrideResource;

package/types/resources/CreditNote.d.ts

@@ -1,4 +1,6 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
 declare module 'chargebee' {
   export interface CreditNote {
     
@@ -240,7 +242,7 @@ Ireland** . The first two characters of the VAT number in such a case is &#x60;X
 
       */
     
-    business_entity_id:string;
+    business_entity_id?:string;
     
     /**
       * @description An e-invoice or electronic invoice is a structured representation of an invoice that is interoperable between computerized invoicing systems. Depending on the country, e-invoicing can be necessary to meet financial/taxation authority regulations.

package/types/resources/CustomerEntitlement.d.ts

@@ -0,0 +1,47 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+declare module 'chargebee' {
+  export interface CustomerEntitlement {
+    
+
+    customer_id:string;
+
+    subscription_id?:string;
+
+    feature_id?:string;
+
+    value?:string;
+
+    name?:string;
+
+    is_enabled:boolean;
+
+  }
+  export namespace CustomerEntitlement {
+    export class CustomerEntitlementResource {  
+      entitlements_for_customer(customer_id:string, input?:EntitlementsForCustomerInputParam):ChargebeeRequest<EntitlementsForCustomerResponse>;
+    }
+    export interface EntitlementsForCustomerResponse {  
+       list:{customer_entitlement:CustomerEntitlement}[];
+       
+       next_offset?:string;
+    }
+    export interface EntitlementsForCustomerInputParam {
+      [key : string]: any;  
+      /**
+        * @description The number of resources to be returned.
+
+        */
+        
+      limit?:number;
+       
+      /**
+        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
+
+        */
+        
+      offset?:string;
+    }
+    
+  }
+}

package/types/resources/Estimate.d.ts

@@ -316,6 +316,8 @@ declare module 'chargebee' {
       use_existing_balances?:boolean;
        
       invoice_immediately?:boolean;
+       
+      invoice_usages?:boolean;
     }
     export interface RenewalEstimateResponse {  
        estimate:Estimate;

package/types/resources/Quote.d.ts

@@ -1,4 +1,6 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
 declare module 'chargebee' {
   export interface Quote {
     
@@ -76,7 +78,7 @@ declare module 'chargebee' {
     
     contract_term_termination_fee?:number;
     
-    business_entity_id:string;
+    business_entity_id?:string;
   }
   export namespace Quote {
     export class QuoteResource {  

package/types/resources/Ramp.d.ts

@@ -179,6 +179,8 @@ By default, the ramps are returned [sorted](ramps#list_ramps_sort_by) in descend
         */
       
       list(input:ListInputParam):ChargebeeRequest<ListResponse>;
+
+      update(ramp_id:string, input:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
     }
     export interface CreateForSubscriptionResponse {  
        ramp:Ramp;
@@ -285,7 +287,9 @@ Replaces the existing item_tiers for specific &#x60;item_price&#x60;s within the
     export interface RetrieveResponse {  
        ramp:Ramp;
     }
-    
+    export interface UpdateResponse {  
+      ramp:Ramp;
+    }
     export interface DeleteResponse {  
        ramp:Ramp;
     }
@@ -311,6 +315,28 @@ By default, the ramps are returned [sorted](ramps#list_ramps_sort_by) in descend
        
        next_offset?:string;
     }
+    export interface UpdateInputParam {
+         
+      items_to_add:{billing_cycles?:number,item_price_id:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
+       
+      items_to_update:{billing_cycles?:number,item_price_id:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
+       
+      item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
+       
+      coupons_to_add?:{apply_till?:number,coupon_id?:string}[];
+       
+      discounts_to_add:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
+       
+      effective_from:number;
+       
+      description?:string;
+       
+      coupons_to_remove?:string[];
+       
+      discounts_to_remove?:string[];
+       
+      items_to_remove?:string[];
+    }
     export interface ListInputParam {
       [key : string]: any;  
       /**

package/types/resources/Subscription.d.ts

@@ -442,6 +442,7 @@ Applicable only when [Metered Billing](https://www.chargebee.com/docs/metered_bi
       */
     
     discounts?:Subscription.Discount[];
+    arr?:number;
   }
   export namespace Subscription {
     export class SubscriptionResource {  
@@ -2752,6 +2753,7 @@ Updates the specified subscription by setting the parameters passed. Any paramet
         */
        
       item_tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
+      invoice_usages?:boolean;
     }
     export interface ChangeTermEndResponse {  
        subscription:Subscription;

package/types/resources/SubscriptionEntitlement.d.ts

@@ -79,6 +79,7 @@ declare module 'chargebee' {
       */
     
     components?:SubscriptionEntitlement.Component;
+    feature_type?:string;
   }
   export namespace SubscriptionEntitlement {
     export class SubscriptionEntitlementResource {  

package/types/resources/Transaction.d.ts

@@ -371,6 +371,8 @@ declare module 'chargebee' {
         */
       
       delete_offline_transaction(transaction_id:string, input?:DeleteOfflineTransactionInputParam):ChargebeeRequest<DeleteOfflineTransactionResponse>;
+      
+      reconcile(transaction_id:string, input?:ReconcileInputParam):ChargebeeRequest<ReconcileResponse>;
     }
     export interface CreateAuthorizationResponse {  
        transaction:Transaction;
@@ -640,6 +642,17 @@ declare module 'chargebee' {
        
        next_offset?:string;
     }
+    export interface ReconcileResponse {  
+      transaction:Transaction;
+    }
+    export interface ReconcileInputParam {
+         
+      id_at_gateway?:string;
+       
+      customer_id?:string;
+       
+      status?:'success' | 'failure';
+    }
     export interface PaymentsForInvoiceInputParam {
       [key : string]: any;  
       /**