chargebee 2.34.0 → 2.35.0

package/CHANGELOG.md

@@ -1,3 +1,67 @@
+### v2.35.0 (2024-04-30)
+* * *
+
+#### New resources:
+* PriceVariant has been added.
+* Ramp has been added.
+* InstallmentDetail has been added.
+* Session has been added.
+* Ramp has been added.
+
+#### New Enum values:
+* INVOICE_INSTALLMENTS_CREATED has been added in EventType enum.
+* INVOICE_INSTALLMENT_UPDATED has been added in EventType enum.
+* INSTALLMENT_CONFIG_CREATED has been added in EventType enum.
+* INSTALLMENT_CONFIG_DELETED has been added in EventType enum.
+* RAMP_CREATED has been added in EventType enum.
+* RAMP_DELETED has been added in EventType enum.
+* RAMP_APPLIED has been added in EventType enum.
+
+#### New Attributes:
+* tax_providers_fields has been added to Addon resource.
+* tax_providers_fields has been added to Customer resource.
+* tax_providers_fields has been added to ItemPrice resource.
+* tax_providers_fields has been added to Plan resource.
+* resource_version has been added to Installment resource.
+* resource_version has been added to InstallmentConfig resource.
+* KlarnaPayNow has been added to PaymentSource resource.
+* business_entity_id has been added to UnbilledCharge resource.
+
+#### New Endpoints:
+* Exports#PriceVariantsRequest has been added to Exports resource.
+
+#### New Input parameters:
+* changes_scheduled_at, change_option has been added to Estimate#UpdateSubscriptionRequest.
+* changes_scheduled_at, change_option has been added to Estimate#UpdateSubscriptionForItemsRequest.
+* contract_term[contract_start] has been added to Estimate#CreateSubItemEstimateRequest.
+* contract_term[contract_start] has been added to Estimate#CreateSubItemForCustomerEstimateRequest.
+* contract_term[contract_start] has been added to Subscription#CreateWithItemsRequest.
+* contract_term[contract_start] has been added to Subscription#UpdateForItemsRequest.
+* price_variant_id has been added to ItemPrice#CreateRequest.
+* price_variant_id has been added to ItemPrice#UpdateRequest.
+* price_variant_id has been added to ItemPrice#ListRequest.
+
+#### Removed attributes:
+* additional_info has been removed from Invoice#StatmentDescriptor resource.
+
+#### Removed Input parameters:
+* additional_info has been removed from Subscription#CreateRequest.
+* additional_info has been removed from Subscription#CreateForCustomerRequest.
+* additional_info has been removed from Subscription#CreateWithItemsRequest.
+* additional_info has been removed from Subscription#UpdateRequest.
+* additional_info has been removed from Subscription#UpdateForItemsRequest.
+* additional_info has been removed from Subscription#ReactivateRequest.
+
+### v2.34.1 (2024-04-03)
+* * *
+
+#### New Input parameters:
+* to_customer_id has been added to subscription#MoveRequest.
+* copy_payment_source has been added to subscription#MoveRequest.
+
+#### New endpoints:
+* Subscription#MoveRequest has been added to the Subscription resource.
+
 ### v2.34.0 (2024-03-20)
 * * *
 

package/lib/chargebee.js

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

package/lib/resources/api_endpoints.js

@@ -251,6 +251,13 @@ var _endpoints = {
       "/subscriptions",
       "/remove_scheduled_resumption",
       true
+    ],
+    [
+      "move",
+      "POST",
+      "/subscriptions",
+      "/move",
+      true
     ]
   ],
   "contract_term": [],
@@ -2259,6 +2266,13 @@ var _endpoints = {
       "/exports",
       "/differential_prices",
       false
+    ],
+    [
+      "price_variants",
+      "POST",
+      "/exports",
+      "/price_variants",
+      false
     ]
   ],
   "payment_intent": [
@@ -2359,6 +2373,43 @@ var _endpoints = {
       true
     ]
   ],
+  "price_variant": [
+    [
+      "create",
+      "POST",
+      "/price_variants",
+      null,
+      false
+    ],
+    [
+      "retrieve",
+      "GET",
+      "/price_variants",
+      null,
+      true
+    ],
+    [
+      "update",
+      "POST",
+      "/price_variants",
+      null,
+      true
+    ],
+    [
+      "delete",
+      "POST",
+      "/price_variants",
+      "/delete",
+      true
+    ],
+    [
+      "list",
+      "GET",
+      "/price_variants",
+      null,
+      false
+    ]
+  ],
   "attribute": [],
   "item_price": [
     [
@@ -2709,6 +2760,36 @@ var _endpoints = {
       true
     ]
   ],
+  "ramp": [
+    [
+      "create_for_subscription",
+      "POST",
+      "/subscriptions",
+      "/create_ramp",
+      true
+    ],
+    [
+      "retrieve",
+      "GET",
+      "/ramps",
+      null,
+      true
+    ],
+    [
+      "delete",
+      "POST",
+      "/ramps",
+      "/delete",
+      true
+    ],
+    [
+      "list",
+      "GET",
+      "/ramps",
+      null,
+      false
+    ]
+  ],
   "installment_config": [
     [
       "create",
@@ -2747,6 +2828,23 @@ var _endpoints = {
       null,
       false
     ]
+  ],
+  "installment_detail": [],
+  "session": [
+    [
+      "create",
+      "POST",
+      "/sessions",
+      null,
+      false
+    ],
+    [
+      "retrieve",
+      "GET",
+      "/sessions",
+      null,
+      true
+    ]
   ]
 };
 module.exports = _endpoints;

package/package.json

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

package/types/core.d.ts

@@ -42,7 +42,7 @@ declare module 'chargebee' {
   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' | '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' | 'price_variant_deleted' | 'price_variant_updated' | 'price_variant_created'
+  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'
   type ExportType = 'data' | 'import_friendly_data'
   type FreePeriodUnit = 'week' | 'month' | 'year' | 'day'
   type FriendOfferType = 'coupon_code' | 'coupon' | 'none'

package/types/index.d.ts

@@ -31,6 +31,7 @@
 ///<reference path='./resources/InAppSubscription.d.ts' />
 ///<reference path='./resources/Installment.d.ts' />
 ///<reference path='./resources/InstallmentConfig.d.ts' />
+///<reference path='./resources/InstallmentDetail.d.ts' />
 ///<reference path='./resources/Invoice.d.ts' />
 ///<reference path='./resources/InvoiceEstimate.d.ts' />
 ///<reference path='./resources/Item.d.ts' />
@@ -45,13 +46,16 @@
 ///<reference path='./resources/PaymentSource.d.ts' />
 ///<reference path='./resources/PaymentVoucher.d.ts' />
 ///<reference path='./resources/PortalSession.d.ts' />
+///<reference path='./resources/PriceVariant.d.ts' />
 ///<reference path='./resources/PromotionalCredit.d.ts' />
 ///<reference path='./resources/Purchase.d.ts' />
 ///<reference path='./resources/Quote.d.ts' />
 ///<reference path='./resources/QuoteLineGroup.d.ts' />
 ///<reference path='./resources/QuotedCharge.d.ts' />
 ///<reference path='./resources/QuotedSubscription.d.ts' />
+///<reference path='./resources/Ramp.d.ts' />
 ///<reference path='./resources/ResourceMigration.d.ts' />
+///<reference path='./resources/Session.d.ts' />
 ///<reference path='./resources/SiteMigrationDetail.d.ts' />
 ///<reference path='./resources/Subscription.d.ts' />
 ///<reference path='./resources/SubscriptionEntitlement.d.ts' />
@@ -100,10 +104,13 @@ declare module 'chargebee' {
     static payment_source: PaymentSource.PaymentSourceResource;
     static payment_voucher: PaymentVoucher.PaymentVoucherResource;
     static portal_session: PortalSession.PortalSessionResource;
+    static price_variant: PriceVariant.PriceVariantResource;
     static promotional_credit: PromotionalCredit.PromotionalCreditResource;
     static purchase: Purchase.PurchaseResource;
     static quote: Quote.QuoteResource;
+    static ramp: Ramp.RampResource;
     static resource_migration: ResourceMigration.ResourceMigrationResource;
+    static session: Session.SessionResource;
     static site_migration_detail: SiteMigrationDetail.SiteMigrationDetailResource;
     static subscription: Subscription.SubscriptionResource;
     static subscription_entitlement: SubscriptionEntitlement.SubscriptionEntitlementResource;

package/types/resources/Customer.d.ts

@@ -99,7 +99,20 @@ This setting can be [overridden](subscriptions#create_subscription_for_items_aut
     allow_direct_debit:boolean;
     
     /**
-      * @description Customer location is validated based on IP address and Card issuing country. If the location is valid, it returns True. If not, it returns False. Applicable only for EU, New Zealand and Australia.
+      * @description **Note**
+
+Applicable only when the customer's `billing_address.country` is New Zealand, Australia, or in the EU.
+
+When the customer uses a [card](https://apidocs.chargebee.com/docs/api/payment_sources#payment_source_type) [payment source](https://apidocs.chargebee.com/docs/api/customers#customer_primary_payment_source_id), this attribute specifies whether the country of the customer and the card issuer are the same.
+
+The following three location indicators are compared:
+
+* The card issuer's country.
+* The `billing_address.country`.
+* The country to which `created_from_ip` belongs.
+* When all three are the same, this attribute is set to true, otherwise it is set to false.
+
+When all three are the same, this attribute is set to `true`, otherwise it is set to `false`.
 
       */
     
@@ -113,7 +126,13 @@ This setting can be [overridden](subscriptions#create_subscription_for_items_aut
     created_at:number;
     
     /**
-      * @description The IP address of the customer. Used primarily for [referral integrations](https://www.chargebee.com/docs/marketing-integration-index.html) and EU/UK VAT validation.
+      * @description The IP address of the customer when this customer record was created. It's mainly used for [referral integrations](https://www.chargebee.com/docs/marketing-integration-index.html) and validating VAT if the customer is in the EU or UK.
+
+Depending on the method used to create the customer record, the field is set as follows:
+
+* **API** : When creating the `customer` resource through the API, you must include the customer's IP address in a [custom HTTP request header](https://apidocs.chargebee.com/docs/api/advanced-features#user_details) (`chargebee-request-origin-ip`) for Chargebee to capture it.
+* **Checkout** : For `customer` resources created through [Chargebee Checkout](https://www.chargebee.com/docs/2.0/hosted-checkout.html), Chargebee automatically captures the IP address of the customer.
+* **UI** : When [creating a `customer`](https://www.chargebee.com/docs/2.0/customers.html#creating-a-new-customer) resource via the Chargebee Billing UI, this field is not relevant and the value must be ignored.
 
       */
     
@@ -176,7 +195,11 @@ To know more about what values you need to provide, refer to this [Avalara'
       * @description **Note**
 
 Applicable only when [Calendar Billing](https://www.chargebee.com/docs/calendar-billing.html) with support for customer-specific billing date is enabled and `billing_date_mode` is `manually_set`.
-Specifies the day of the month for subscription renewals on month-based or year-based plans. Month-based and year-based plans are `item_price` resources where the `item_type` is set to `plan` and `period_unit` is set to `month` and `year` respectively.
+Specifies the day of the month for subscription renewals on month-based or year-based plans. Month-based and year-based plans are `item_price` resources where the `item_type` is set to `plan` and `period_unit` is set to `month` and `year` respectively.  
+**Example**
+
+* **Month-based subscriptions** : If `billing_date` is set to `15`, month-based renewals occur on the 15th of the month. It's important to note that if the value is set to `31`, renewals align with the last day of the month. Additionally, in February, a `billing_date` of `29`, `30`, or `31` aligns renewals for the last day of February.
+* **Year-based subscriptions** : A `billing_date` of `15` and a `billing_month` of `7` schedules the renewal on the 15th of July.
 
       */
     
@@ -210,7 +233,7 @@ Indicates whether this customer's `billing_date` and `billin
 
       */
     
-    billing_day_of_week?:'sunday' | 'saturday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'monday';
+    billing_day_of_week?:'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday';
     
     /**
       * @description Indicates whether this customer's *billing_day_of_week* value is derived as per configurations or its specifically set (overriden). When specifically set, the *billing_day_of_week* will not be reset even when all of the weekly subscriptions are cancelled. \* using_defaults - Billing date is set based on defaults configured. \* manually_set - Billing date is specifically set (default configuration is overridden)
@@ -485,6 +508,8 @@ If there are additional entity identifiers for the customer not associated with
     
     entity_identifiers?:Customer.EntityIdentifier[];
     
+    tax_providers_fields?:Customer.TaxProvidersField[];
+    
     /**
       * @description The [account hierarchy](https://www.chargebee.com/docs/account-hierarchy.html) relationship that the customer is part of.
 
@@ -2240,6 +2265,13 @@ If there is only one entity identifier for the customer and the value is the sam
        
       standard?:string;
     }
+    export interface TaxProvidersField {  
+      provider_name:string;
+       
+      field_id:string;
+       
+      field_value:string;
+    }
     export interface Relationship {  
          /**
           * @description The `id` of the immediate parent of this customer under account hierarchy. If the customer is the root of the hierarchy, this attribute isn't returned.

package/types/resources/Estimate.d.ts

@@ -690,6 +690,32 @@ In the response,
     }
     export interface UpdateSubscriptionForItemsInputParam {
        
+      /**
+        * @description Returns an estimate for updating a subscription.
+
+In the response,
+
+* [subscription_estimate](/docs/api/estimates#subscription_estimate_attributes): The details of the changed subscription such as `status`, next billing date, and so on.
+* [invoice_estimate](/docs/api/estimates#invoice_estimate_attributes):The details of the immediate invoice, if it is generated. An immediate invoice is not generated when:
+  * `end_of_term` parameter is true
+  * `prorate` parameter is `false`
+  * No changes are made to the plan item prices or addon item prices in `subscription_items`.
+  * For changes such as [quantity downgrades](https://www.chargebee.com/docs/proration.html#proration-mechanism_plan-quantity-downgrade-paid-invoice).
+* [next_invoice_estimate](/docs/api/estimates#next_invoice_estimate_attributes):The details of the invoice to be generated later (if any) on the occasion that no immediate invoice has been generated.
+* [credit_note_estimates](/docs/api/estimates#credit_note_estimate_attributes):The list of credit notes (if any) generated during this operation.
+* [unbilled_charge_estimates](/docs/api/estimates#unbilled_charge_estimate_attributes): The details of charges that have not been invoiced. This is returned only if the `invoice_immediately` parameter is set to `false`.
+
+        */
+       
+      changes_scheduled_at?:number;
+       
+      /**
+        * @description null
+
+        */
+       
+      change_option?:ChangeOption;
+       
       /**
         * @description Item ids of [mandatorily attached addons](./attached_items?prod_cat_ver=2) that are to be removed from the subscription.
 

package/types/resources/Export.d.ts

@@ -156,6 +156,8 @@ declare module 'chargebee' {
         */
       
       differential_prices(input?:DifferentialPricesInputParam):ChargebeeRequest<DifferentialPricesResponse>;
+       
+      price_variants(input?:PriceVariantsInputParam):ChargebeeRequest<PriceVariantsResponse>;
     }
     export interface RetrieveResponse {  
        export:Export;
@@ -732,6 +734,13 @@ Item Id of Addon / Charge item price for which differential pricing is applied t
        
       differential_price?:{id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},item_price_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},parent_item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string}};
     }
+    export interface PriceVariantsResponse {  
+       export:Export;
+    }
+    export interface PriceVariantsInputParam {
+       
+      price_variant?:{created_at?:{after?:string,before?:string,between?:string,on?:string},id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},name?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string},status?:{in?:string,is?:'active' | 'archived',is_not?:'active' | 'archived',not_in?:string},updated_at?:{after?:string,before?:string,between?:string,on?:string}};
+    }
     export interface Download {  
          /**
           * @description The URL at which the file is available for download.

package/types/resources/Installment.d.ts

@@ -44,6 +44,8 @@ declare module 'chargebee' {
     
     created_at:number;
     
+    resource_version?:number;
+    
     /**
       * @description The time when this resource was last updated.
 

package/types/resources/InstallmentConfig.d.ts

@@ -51,6 +51,13 @@ declare module 'chargebee' {
     
     created_at:number;
     
+    /**
+      * @description Version number of this resource. The `resource_version` is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
+
+      */
+    
+    resource_version?:number;
+    
     /**
       * @description The timestamp at which the installment_config was last updated at.
 

package/types/resources/InstallmentDetail.d.ts

@@ -0,0 +1,34 @@
+///<reference path='./../core.d.ts'/>
+declare module 'chargebee' {
+  export interface InstallmentDetail {
+    
+    id?:string;
+    
+    invoice_id?:string;
+    
+    amount?:number;
+    
+    installments?:InstallmentDetail.Installment[];
+  }
+  export namespace InstallmentDetail {
+    
+    
+    export interface Installment {  
+      id:string;
+       
+      invoice_id:string;
+       
+      date:number;
+       
+      amount:number;
+       
+      status:'posted' | 'payment_due' | 'paid';
+       
+      created_at:number;
+       
+      resource_version?:number;
+       
+      updated_at?:number;
+    }
+  }
+}

package/types/resources/ItemPrice.d.ts

@@ -53,6 +53,13 @@ If your input contains characters that are subjected to sanitization (like incom
     
     external_name?:string;
     
+    /**
+      * @description An immutable unique identifier of a [price variant](price_variants).
+
+      */
+    
+    price_variant_id?:string;
+    
     /**
       * @description **Note**
 
@@ -272,6 +279,8 @@ In-App Subscriptions is currently in early access. Contact [eap@chargebee.com](m
     
     tax_detail?:ItemPrice.TaxDetail;
     
+    tax_providers_fields?:ItemPrice.TaxProvidersField[];
+    
     /**
       * @description Accounting integration details. The values are typically dependent on the [accounting integration](https://www.chargebee.com/docs/finance-integration-index.html) used.
 
@@ -406,6 +415,13 @@ Specifies how to manage charges or credits for the addon item price during a [su
        
       currency_code?:string;
        
+      /**
+        * @description An immutable unique identifier of a [price variant](price_variants).
+
+        */
+       
+      price_variant_id?:string;
+       
       /**
         * @description Specifies whether taxes apply to this item price. This value is set and returned even if [Taxes](https://www.chargebee.com/docs/tax.html) have been disabled in Chargebee. However, the value is effective only while Taxes are enabled.
 
@@ -599,7 +615,14 @@ Specifies how to manage charges or credits for the addon item price during a [su
 
         */
        
-      proration_type?:'partial_term' | 'full_term' | 'site_default';
+      proration_type?:'site_default' | 'partial_term' | 'full_term';
+       
+      /**
+        * @description An immutable unique identifier of a [price variant](price_variants).
+
+        */
+       
+      price_variant_id?:string;
        
       /**
         * @description The status of the item price. \* archived - The item price is no longer active and cannot be used in new subscriptions or added to existing ones. Existing subscriptions that already have this item price will continue to renew with the item price. \* active - The item price can be used in subscriptions. \* deleted - Indicates that the item price has been deleted. The `id` and `name` can be reused.
@@ -866,6 +889,13 @@ If subscriptions, invoices or [differential prices](./differential_prices?prod_c
         
       currency_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
+      /**
+        * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
+
+        */
+        
+      price_variant_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
       /**
         * @description Returns a list of item prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order.
 
@@ -1132,6 +1162,13 @@ If an addon-item price has [differential pricing](differential_prices?prod_cat_v
        
       taxjar_product_code?:string;
     }
+    export interface TaxProvidersField {  
+      provider_name:string;
+       
+      field_id:string;
+       
+      field_value:string;
+    }
     export interface AccountingDetail {  
          /**
           * @description This maps to the sku or product name in the accounting integration.

package/types/resources/PaymentSource.d.ts

@@ -152,6 +152,8 @@ declare module 'chargebee' {
     
     venmo?:PaymentSource.Venmo;
     
+    klarna_pay_now?:PaymentSource.KlarnaPayNow;
+    
     /**
       * @description Mandate details associated with the payment source.
 
@@ -1289,6 +1291,9 @@ If you have enabled [EU VAT](https://www.chargebee.com/docs/eu-vat.html) in 2021
     export interface Venmo {  
       user_name?:string;
     }
+    export interface KlarnaPayNow {  
+      email?:string;
+    }
     export interface Mandate {  
          /**
           * @description A unique mandate identifier used for recurring payments.