chargebee 2.38.0 → 2.40.0

package/CHANGELOG.md

@@ -1,3 +1,41 @@
+### 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)
+* * *
+
+#### New Resource:
+* Metadata has been added. 
+
+#### New Attributes:
+* variant_group has been added in PriceVariant resource.
+* effective_from & schedule_status have been added in EntitlementOverride resource.
+* effective_from & schedule_status have been added in SubscriptionEntitlement resource.
+* status_transition_reason has been added in Ramp subresource.
+* billing_period & billing_period_unit have been added in SubscriptionItem subresource.
+
+#### New Input parameters:
+* variant_group has been added to PriceVariant#CreateRequest, PriceVariant#UpdateRequest.
+* include_scheduled_overrides has been added to SubscriptionEntitlement#SubscriptionEntitlementsForSubscriptionRequest.
+* entitlement_overrides[effective_from] has been added to SubscriptionEntitlement#SubscriptionEntitlementsForSubscriptionRequest.
+* entitlement_overrides[effective_from] has been added to EntitlementOverride#AddEntitlementOverrideForSubscriptionRequest.
+* include_scheduled_overrides has been added to EntitlementOverride#ListEntitlementOverrideForSubscriptionRequest.
+* updated_at has been added to Usage#ListRequest.
+
+#### New Enum values:
+* SUBSCRIPTION_ITEMS_RENEWED has been added in EventType enum.
+* SUBSCRIPTION_RAMP_DRAFTED has been added in EventType enum.
+* SUBSCRIPTION_RAMP_UPDATED has been added in EventType enum.
+
 ### v2.38.0 (2024-07-19)
 * * *
 

package/lib/chargebee.js

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

package/lib/resources/api_endpoints.js

@@ -2598,6 +2598,7 @@ var _endpoints = {
   "impacted_subscription": [],
   "impacted_item": [],
   "impacted_item_price": [],
+  "metadata": [],
   "subscription_entitlement": [
     [
       "subscription_entitlements_for_subscription",

package/package.json

@@ -1,6 +1,6 @@
 {
    "name":"chargebee",
-   "version":"2.38.0",
+   "version":"2.40.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_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' | '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' | '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

@@ -41,6 +41,7 @@
 ///<reference path='./resources/ItemEntitlement.d.ts' />
 ///<reference path='./resources/ItemFamily.d.ts' />
 ///<reference path='./resources/ItemPrice.d.ts' />
+///<reference path='./resources/Metadata.d.ts' />
 ///<reference path='./resources/NonSubscription.d.ts' />
 ///<reference path='./resources/Order.d.ts' />
 ///<reference path='./resources/PaymentIntent.d.ts' />

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/EntitlementOverride.d.ts

@@ -1,4 +1,5 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface EntitlementOverride {
     
@@ -73,6 +74,11 @@ declare module 'chargebee' {
       */
     
     expires_at?:number;
+
+    effective_from?:number;
+
+    schedule_status?:'activated' | 'scheduled' | 'failed';
+
   }
   export namespace EntitlementOverride {
     export class EntitlementOverrideResource {  
@@ -139,6 +145,12 @@ declare module 'chargebee' {
         */
         
       offset?:string;
+       
+      embed?:string;
+       
+      include_drafts?:boolean;
+       
+      include_scheduled_overrides?:boolean;
     }
     
   }

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/Metadata.d.ts

@@ -0,0 +1,10 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+declare module 'chargebee' {
+  export interface Metadata {
+    
+
+    change_type?:string;
+
+  }
+}

package/types/resources/PriceVariant.d.ts

@@ -1,4 +1,5 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface PriceVariant {
     
@@ -27,7 +28,7 @@ declare module 'chargebee' {
       * @description Description of the price variant.
 
       */
-    
+    variant_group?:string;
     description?:string;
     
     /**
@@ -152,6 +153,8 @@ Attributes can be used to store additional information about the price variant.
         */
        
       attributes:{name:string,value:string}[];
+
+      variant_group?:string;
     }
     export interface RetrieveResponse {  
        price_variant:PriceVariant;
@@ -182,6 +185,8 @@ Attributes can be used to store additional information about the price variant.
         */
        
       description?:string;
+
+      variant_group?:string;
        
       /**
         * @description Status of a price variant. \* active - Active price variant. This price variant can be attached to [item prices](https://apidocs.chargebee.com/docs/api/item_prices?lang&#x3D;curl). \* deleted - Deleted price variant. The &#x60;id&#x60; and &#x60;name&#x60; of the deleted price variant can be reused. \* archived - Archived price variant. This price variant is no longer &#x60;active&#x60; and cannot be attached to new [item prices](https://apidocs.chargebee.com/docs/api/item_prices?lang&#x3D;curl). Existing item prices that already have this price variant attached will continue to remain as is.

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/QuotedSubscription.d.ts

@@ -383,6 +383,10 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
           */
        
       proration_type?:'partial_term' | 'full_term' | 'none';
+      
+      billing_period?:number;
+       
+      billing_period_unit?:'day' | 'week' | 'month' | 'year';
     }
     export interface ItemTier {  
          /**

package/types/resources/Ramp.d.ts

@@ -131,6 +131,8 @@ Overrides the [item_tiers](subscriptions#subscription_item_tiers) for specific &
       */
     
     item_tiers?:Ramp.ItemTier[];
+
+    status_transition_reason?:Ramp.StatusTransitionReason;
   }
   export namespace Ramp {
     export class RampResource {  
@@ -740,5 +742,10 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
        
       index:number;
     }
+    export interface StatusTransitionReason {  
+      code?:string;
+       
+      message?:string;
+    }
   }
 }

package/types/resources/Subscription.d.ts

@@ -2752,6 +2752,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;
@@ -3841,6 +3842,10 @@ If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle
           */
        
       proration_type?:'partial_term' | 'full_term' | 'none';
+
+      billing_period?:number;
+       
+      billing_period_unit?:'day' | 'week' | 'month' | 'year';
     }
     export interface ItemTier {  
          /**

package/types/resources/SubscriptionEntitlement.d.ts

@@ -1,4 +1,5 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface SubscriptionEntitlement {
     
@@ -66,7 +67,10 @@ declare module 'chargebee' {
       * @description Timestamp when the subscription entitlements are going to expire.
 
       */
-    
+    effective_from?:number;
+
+    schedule_status?:'activated' | 'scheduled' | 'failed';
+
     expires_at?:number;
     
     /**
@@ -75,6 +79,7 @@ declare module 'chargebee' {
       */
     
     components?:SubscriptionEntitlement.Component;
+    feature_type?:string;
   }
   export namespace SubscriptionEntitlement {
     export class SubscriptionEntitlementResource {  
@@ -137,6 +142,12 @@ The &#x60;components&#x60; attribute is not returned for any of the &#x60;subscr
         */
         
       offset?:string;
+       
+      include_drafts?:boolean;
+       
+      embed?:string;
+       
+      include_scheduled_overrides?:boolean;
     }
     export interface SetSubscriptionEntitlementAvailabilityResponse {  
        subscription_entitlement:SubscriptionEntitlement;

package/types/resources/Usage.d.ts

@@ -271,6 +271,13 @@ The maximum number of usages that can be recorded for the entire lifetime of a s
         */
         
       sort_by?:{asc?:'usage_date',desc?:'usage_date'};
+      
+       /**
+        * @description Indicates the date at which this credit note is last updated.
+
+        */
+        
+       updated_at?:{after?:string,before?:string,between?:string,on?:string};
     }
     export interface PdfResponse {  
        download:Download;