chargebee 2.51.0 → 2.52.0

package/CHANGELOG.md

@@ -1,3 +1,30 @@
+### v2.52.0 (2025-07-18) 
+* * * 
+
+### New Resources: 
+* BillingConfiguration has been added. 
+* Brand has been added. 
+
+### New Attributes: 
+* has_children has been added to Hierarchy
+* coupon_applicability_mappings has been added to QuotedRamp.
+
+### New Endpoint:
+* listHierarchyDetail has been added to Customer.
+
+### New Input parameters: 
+* change_reason children has been added to Entitlement#CreateRequest.
+* entitlements[apply_grandfathering] has been added to Entitlement#CreateRequest.
+* replace_primary_payment_source has been added to Purchase#CreateRequest.
+* omnichannel_subscription has been added to RecordedPurchase#CreateRequest.
+* contract_term has been added to Subscription#RemoveScheduledCancellationRequest.
+* contract_term_billing_cycle_on_renewal has been added to Subscription#RemoveScheduledCancellationRequest.
+
+### New Enums: 
+* payconiq_by_bancontact has been added to PaymentMethodType.
+* solidgate has been added to Gateway.
+* solidgate has been added to PaymentMethod.
+
 ### v2.51.0 (2025-06-19) 
 * * * 
 

package/lib/chargebee.js

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

package/lib/resources/api_endpoints.js

@@ -702,6 +702,17 @@ var _endpoints = {
       { 
       }
     ],
+    [
+      "list_hierarchy_detail",
+      "GET",
+      "/customers",
+      "/hierarchy_detail",
+      true,
+      null,
+      false,
+      { 
+      }
+    ],
     [
       "update_hierarchy_settings",
       "POST",
@@ -2795,6 +2806,7 @@ var _endpoints = {
   "quoted_subscription": [],
   "quoted_charge": [],
   "quoted_ramp": [],
+  "billing_configuration": [],
   "quote_line_group": [],
   "plan": [
     [
@@ -4778,6 +4790,7 @@ var _endpoints = {
       { 
       }
     ]
-  ]
+  ],
+  "brand": []
 };
 module.exports = _endpoints;

package/package.json

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

package/types/core.d.ts

@@ -51,7 +51,7 @@ declare module 'chargebee' {
   type ExportType = 'data' | 'import_friendly_data'
   type FreePeriodUnit = 'day' | 'week' | 'month' | 'year'
   type FriendOfferType = 'none' | 'coupon' | 'coupon_code'
-  type Gateway = 'chargebee' | 'chargebee_payments' | 'adyen' | 'stripe' | 'wepay' | 'braintree' | 'authorize_net' | 'paypal_pro' | 'pin' | 'eway' | 'eway_rapid' | 'worldpay' | 'balanced_payments' | 'beanstream' | 'bluepay' | 'elavon' | 'first_data_global' | 'hdfc' | 'migs' | 'nmi' | 'ogone' | 'paymill' | 'paypal_payflow_pro' | 'sage_pay' | 'tco' | 'wirecard' | 'amazon_payments' | 'paypal_express_checkout' | 'orbital' | 'moneris_us' | 'moneris' | 'bluesnap' | 'cybersource' | 'vantiv' | 'checkout_com' | 'paypal' | 'ingenico_direct' | 'exact' | 'mollie' | 'quickbooks' | 'razorpay' | 'global_payments' | 'bank_of_america' | 'ecentric' | 'metrics_global' | 'windcave' | 'pay_com' | 'ebanx' | 'dlocal' | 'nuvei' | 'paystack' | 'jp_morgan' | 'gocardless' | 'not_applicable'
+  type Gateway = 'chargebee' | 'chargebee_payments' | 'adyen' | 'stripe' | 'wepay' | 'braintree' | 'authorize_net' | 'paypal_pro' | 'pin' | 'eway' | 'eway_rapid' | 'worldpay' | 'balanced_payments' | 'beanstream' | 'bluepay' | 'elavon' | 'first_data_global' | 'hdfc' | 'migs' | 'nmi' | 'ogone' | 'paymill' | 'paypal_payflow_pro' | 'sage_pay' | 'tco' | 'wirecard' | 'amazon_payments' | 'paypal_express_checkout' | 'orbital' | 'moneris_us' | 'moneris' | 'bluesnap' | 'cybersource' | 'vantiv' | 'checkout_com' | 'paypal' | 'ingenico_direct' | 'exact' | 'mollie' | 'quickbooks' | 'razorpay' | 'global_payments' | 'bank_of_america' | 'ecentric' | 'metrics_global' | 'windcave' | 'pay_com' | 'ebanx' | 'dlocal' | 'nuvei' | 'solidgate' | 'paystack' | 'jp_morgan' | 'gocardless' | 'not_applicable'
   type HierarchyOperationType = 'complete_hierarchy' | 'subordinates' | 'path_to_root'
   type InvoiceDunningHandling = 'continue' | 'stop'
   type ItemType = 'plan' | 'addon' | 'charge'
@@ -63,8 +63,8 @@ declare module 'chargebee' {
   type OperationType = 'add' | 'remove'
   type PauseOption = 'immediately' | 'end_of_term' | 'specific_date' | 'billing_cycles'
   type PaymentInitiator = 'customer' | 'merchant'
-  type PaymentMethod = 'cash' | 'check' | 'bank_transfer' | 'other' | 'custom' | 'chargeback' | 'card' | 'amazon_payments' | 'paypal_express_checkout' | 'direct_debit' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ach_credit' | 'sepa_credit' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'boleto' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland'
-  type PaymentMethodType = 'card' | 'paypal_express_checkout' | 'amazon_payments' | 'direct_debit' | 'generic' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland'
+  type PaymentMethod = 'cash' | 'check' | 'bank_transfer' | 'other' | 'custom' | 'chargeback' | 'card' | 'amazon_payments' | 'paypal_express_checkout' | 'direct_debit' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ach_credit' | 'sepa_credit' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'boleto' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact'
+  type PaymentMethodType = 'card' | 'paypal_express_checkout' | 'amazon_payments' | 'direct_debit' | 'generic' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact'
   type PaymentVoucherType = 'boleto'
   type PeriodUnit = 'day' | 'week' | 'month' | 'year'
   type PriceType = 'tax_exclusive' | 'tax_inclusive'
@@ -86,7 +86,7 @@ declare module 'chargebee' {
   type Taxability = 'taxable' | 'exempt'
   type TaxjarExemptionCategory = 'wholesale' | 'government' | 'other'
   type TrialEndAction = 'site_default' | 'plan_default' | 'activate_subscription' | 'cancel_subscription'
-  type Type = 'card' | 'paypal_express_checkout' | 'amazon_payments' | 'direct_debit' | 'generic' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland'
+  type Type = 'card' | 'paypal_express_checkout' | 'amazon_payments' | 'direct_debit' | 'generic' | 'alipay' | 'unionpay' | 'apple_pay' | 'wechat_pay' | 'ideal' | 'google_pay' | 'sofort' | 'bancontact' | 'giropay' | 'dotpay' | 'upi' | 'netbanking_emandates' | 'venmo' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'automated_bank_transfer' | 'klarna_pay_now' | 'online_banking_poland' | 'payconiq_by_bancontact'
   type UnbilledChargesHandling = 'no_action' | 'invoice'
   type UnbilledChargesOption = 'invoice' | 'delete'
   type UnpaidInvoicesHandling = 'no_action' | 'schedule_payment_collection'

package/types/index.d.ts

@@ -3,6 +3,8 @@
 ///<reference path='./resources/AdvanceInvoiceSchedule.d.ts' />
 ///<reference path='./resources/AttachedItem.d.ts' />
 ///<reference path='./resources/Attribute.d.ts' />
+///<reference path='./resources/BillingConfiguration.d.ts' />
+///<reference path='./resources/Brand.d.ts' />
 ///<reference path='./resources/BusinessEntity.d.ts' />
 ///<reference path='./resources/BusinessEntityTransfer.d.ts' />
 ///<reference path='./resources/Card.d.ts' />

package/types/resources/Address.d.ts

@@ -1,140 +1,46 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface Address {
     
-    /**
-      * @description Label to identify the address. This is unique for all the address for a subscription.
 
-      */
-    
     label:string;
-    
-    /**
-      * @description First name
 
-      */
-    
     first_name?:string;
-    
-    /**
-      * @description Last name
 
-      */
-    
     last_name?:string;
-    
-    /**
-      * @description Email
 
-      */
-    
     email?:string;
-    
-    /**
-      * @description Company name
 
-      */
-    
     company?:string;
-    
-    /**
-      * @description Phone number
 
-      */
-    
     phone?:string;
-    
-    /**
-      * @description Address line 1
 
-      */
-    
     addr?:string;
-    
-    /**
-      * @description Address line 2
 
-      */
-    
     extended_addr?:string;
-    
-    /**
-      * @description Address line 3
 
-      */
-    
     extended_addr2?:string;
-    
-    /**
-      * @description Name of the city
 
-      */
-    
     city?:string;
-    
-    /**
-      * @description The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search) without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set &#x60;state_code&#x60; as &#x60;AZ&#x60; (not &#x60;US-AZ&#x60;). For Tamil Nadu (India), set as &#x60;TN&#x60; (not &#x60;IN-TN&#x60;). For British Columbia (Canada), set as &#x60;BC&#x60; (not &#x60;CA-BC&#x60;).
 
-      */
-    
     state_code?:string;
-    
-    /**
-      * @description State or Province
 
-      */
-    
     state?:string;
-    
-    /**
-      * @description The billing address country of the customer. Must be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html).   
 
-**Note** : If you enter an invalid country code, the system will return an error.  
-
-**Brexit**
-
-
-If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee) the Brexit configuration, then &#x60;XI&#x60; (the code for **United Kingdom -- Northern Ireland**) is available as an option.
-
-      */
-    
     country?:string;
-    
-    /**
-      * @description Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address).
 
-      */
-    
     zip?:string;
-    
-    /**
-      * @description The address verification status. \* partially_valid - The address is valid for taxability but has not been validated for shipping. \* not_validated - Address is not yet validated. \* invalid - Address is invalid. \* valid - Address was validated successfully.
 
-      */
-    
     validation_status?:ValidationStatus;
-    
-    /**
-      * @description A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
 
-      */
-    
     subscription_id:string;
+
   }
   export namespace Address {
     export class AddressResource {  
-      /**
-        * @description Retrieves an address resource for a subscription and the specified label.
-
-        */
-      
       retrieve(input:RetrieveInputParam):ChargebeeRequest<RetrieveResponse>;
        
-      /**
-        * @description Adds or replaces the address for a subscription. If an address is already present for the specified label, it will be replaced otherwise new address is added with that label.
-
-        */
-      
       update(input:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
     }
     export interface RetrieveResponse {  
@@ -142,18 +48,8 @@ If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021
     }
     export interface RetrieveInputParam {
        
-      /**
-        * @description Retrieves an address resource for a subscription and the specified label.
-
-        */
-        
       subscription_id:string;
        
-      /**
-        * @description Retrieves an address resource for a subscription and the specified label.
-
-        */
-        
       label:string;
     }
     export interface UpdateResponse {  
@@ -161,124 +57,36 @@ If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021
     }
     export interface UpdateInputParam {
        
-      /**
-        * @description A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
-
-        */
-       
       subscription_id:string;
        
-      /**
-        * @description Label to identify the address. This is unique for all the address for a subscription.
-
-        */
-       
       label:string;
        
-      /**
-        * @description First name.
-
-        */
-       
       first_name?:string;
        
-      /**
-        * @description Last name.
-
-        */
-       
       last_name?:string;
        
-      /**
-        * @description Email.
-
-        */
-       
       email?:string;
        
-      /**
-        * @description Company name.
-
-        */
-       
       company?:string;
        
-      /**
-        * @description Phone number.
-
-        */
-       
       phone?:string;
        
-      /**
-        * @description Address line 1.
-
-        */
-       
       addr?:string;
        
-      /**
-        * @description Address line 2.
-
-        */
-       
       extended_addr?:string;
        
-      /**
-        * @description Address line 3.
-
-        */
-       
       extended_addr2?:string;
        
-      /**
-        * @description Name of the city.
-
-        */
-       
       city?:string;
        
-      /**
-        * @description The [ISO 3166-2 state/province code](https://www.iso.org/obp/ui/#search/code) without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set &#x60;state_code&#x60; as &#x60;AZ&#x60; (not &#x60;US-AZ&#x60;). For Tamil Nadu (India), set as &#x60;TN&#x60; (not &#x60;IN-TN&#x60;). For British Columbia (Canada), set as &#x60;BC&#x60; (not &#x60;CA-BC&#x60;).
-
-        */
-       
       state_code?:string;
        
-      /**
-        * @description The state/province name. Is set by Chargebee automatically for US, Canada and India If &#x60;state_code&#x60; is provided.
-
-        */
-       
       state?:string;
        
-      /**
-        * @description Zip or postal code. The number of characters is validated according to the rules [specified here](https://chromium-i18n.appspot.com/ssl-address).
-
-        */
-       
       zip?:string;
        
-      /**
-        * @description The billing address country of the customer. Must be one of [ISO 3166 alpha-2 country code](https://www.iso.org/iso-3166-country-codes.html).   
-
-**Note** : If you enter an invalid country code, the system will return an error.  
-
-**Brexit**
-
-
-If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021 or later, or have [manually enable](https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee) the Brexit configuration, then &#x60;XI&#x60; (the code for **United Kingdom -- Northern Ireland**) is available as an option.
-.
-
-        */
-       
       country?:string;
        
-      /**
-        * @description The address verification status. \* partially_valid - The address is valid for taxability but has not been validated for shipping. \* not_validated - Address is not yet validated. \* invalid - Address is invalid. \* valid - Address was validated successfully.
-
-        */
-       
       validation_status?:ValidationStatus;
     }
     

package/types/resources/AdvanceInvoiceSchedule.d.ts

@@ -1,102 +1,40 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface AdvanceInvoiceSchedule {
     
-    /**
-      * @description System-generated and immutable unique Id for the &#x60;advance_invoice_schedule&#x60;.
 
-      */
-    
     id:string;
-    
-    /**
-      * @description The type of advance invoice or advance invoicing schedule. \* specific_dates - The advance charges occur on specific dates. For each date, [a fixed number of billing cycles](advance_invoice_schedules#advance_invoice_schedule_specific_dates_schedule_terms_to_charge) is charged for. There can be up to 5 dates configured. \* fixed_intervals - The advance charges occur at [fixed intervals of time](advance_invoice_schedules#advance_invoice_schedule_fixed_interval_schedule_terms_to_charge).
 
-      */
-    
-    schedule_type?:'specific_dates' | 'fixed_intervals';
-    
-    /**
-      * @description When the &#x60;schedule_type&#x60; is &#x60;fixed_intervals&#x60;, this object gives further details of the schedule.
+    schedule_type?:'fixed_intervals' | 'specific_dates';
 
-      */
-    
     fixed_interval_schedule?:AdvanceInvoiceSchedule.FixedIntervalSchedule;
-    
-    /**
-      * @description The advance charges occur on specific dates. For each date, [a fixed number of billing cycles](advance_invoice_schedules#advance_invoice_schedule_specific_dates_schedule_terms_to_charge) is charged for. There can be up to 5 dates configured.
 
-      */
-    
     specific_dates_schedule?:AdvanceInvoiceSchedule.SpecificDatesSchedule;
+
   }
   export namespace AdvanceInvoiceSchedule {
     
     
     export interface FixedIntervalSchedule {  
-         /**
-          * @description Specifies when the schedule should end. \* after_number_of_intervals - Advance invoices are generated a &#x60;specified number of times&#x60; \* subscription_end - Advance invoices are generated for as long as the subscription is active. \* specific_date - End the advance invoicing schedule on a &#x60;specific date&#x60;.
-
-          */
-       
       end_schedule_on?:EndScheduleOn;
        
-         /**
-          * @description The number of advance invoices to generate. The schedule is created such that the total number of billing cycles in the schedule does not exceed the [&#x60;remaining_billing_cycles&#x60;](subscriptions#subscription_remaining_billing_cycles) of the subscription. This parameter is applicable only when [&#x60;fixed_interval_schedule[end_schedule_on]&#x60;](advance_invoice_schedules#advance_invoice_schedule_fixed_interval_schedule_end_schedule_on) &#x3D; &#x60;after_number_of_intervals&#x60;
-
-          */
-       
       number_of_occurrences?:number;
        
-         /**
-          * @description The number of days before each interval that advance invoices are generated.
-
-          */
-       
       days_before_renewal?:number;
        
-         /**
-          * @description The date when the schedule should end. Advance invoices are not generated beyond this date. It must be at least 1 day before the start of the last billing cycle of the subscription and also within 5 years from the current date. This parameter is only applicable when [&#x60;fixed_interval_schedule[end_schedule_on]&#x60;](advance_invoice_schedules#advance_invoice_schedule_fixed_interval_schedule_end_schedule_on) &#x3D; &#x60;specific_date&#x60;.
-
-          */
-       
       end_date?:number;
        
-         /**
-          * @description The date when this advance invoicing schedule was created.
-
-          */
-       
-      created_at?:number;
-       
-         /**
-          * @description The number of billing cycles in one interval.
-
-          */
+      created_at:number;
        
       terms_to_charge?:number;
     }
     export interface SpecificDatesSchedule {  
-         /**
-          * @description The number of billing cycles to charge for, on the date specified. Applicable only when [&#x60;schedule_type&#x60;](advance_invoice_schedules#advance_invoice_schedule_schedule_type) is specific_dates.
-
-          */
-       
       terms_to_charge?:number;
        
-         /**
-          * @description The unique id of the member of the advance_invoice_schedule array which corresponds to the specific_dates_schedule that you intend to modify. Only applicable when [&#x60;schedule_type&#x60;](advance_invoice_schedules#advance_invoice_schedule_schedule_type) is &#x60;specific_dates&#x60;.
-
-          */
-       
       date?:number;
        
-         /**
-          * @description The date when this advance invoicing schedule was created.
-
-          */
-       
-      created_at?:number;
+      created_at:number;
     }
   }
 }

package/types/resources/Attribute.d.ts

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

package/types/resources/BillingConfiguration.d.ts

@@ -0,0 +1,21 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+declare module 'chargebee' {
+  export interface BillingConfiguration {
+    
+
+    is_calendar_billing_enabled:boolean;
+
+    billing_dates?:BillingConfiguration.BillingDate[];
+
+  }
+  export namespace BillingConfiguration {
+    
+    
+    export interface BillingDate {  
+      start_date?:number;
+       
+      end_date?:number;
+    }
+  }
+}

package/types/resources/Brand.d.ts

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

package/types/resources/BusinessEntity.d.ts

@@ -3,19 +3,21 @@
 declare module 'chargebee' {
   export interface BusinessEntity {
     
+
     id:string;
-    
+
     name:string;
-    
+
     status:'active' | 'inactive';
-    
+
     deleted:boolean;
-    
+
     created_at:number;
-    
+
     resource_version?:number;
-    
+
     updated_at?:number;
+
   }
   export namespace BusinessEntity {
     export class BusinessEntityResource {  

package/types/resources/BusinessEntityTransfer.d.ts

@@ -1,21 +1,24 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
 declare module 'chargebee' {
   export interface BusinessEntityTransfer {
     
+
     id:string;
-    
+
     resource_type:'customer' | 'subscription';
-    
+
     resource_id:string;
-    
+
     active_resource_id:string;
-    
+
     destination_business_entity_id:string;
-    
+
     source_business_entity_id:string;
-    
+
     reason_code:'correction';
-    
+
     created_at:number;
+
   }
 }