chargebee 2.33.1 → 2.34.0

package/types/resources/Subscription.d.ts

@@ -336,6 +336,13 @@ declare module 'chargebee' {
     
     changes_scheduled_at?:number;
     
+    /**
+      * @description Contract terms for this subscription
+
+      */
+    
+    contract_term?:Subscription.ContractTerm;
+    
     /**
       * @description Reason code for canceling the subscription. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Subscriptions \> Subscription Cancellation**. Must be passed if set as mandatory in the app. The codes are case-sensitive
 
@@ -746,7 +753,7 @@ If specified as **schedule_payment_collection**, payment collection for the amou
       
       remove_scheduled_resumption(subscription_id:string):ChargebeeRequest<RemoveScheduledResumptionResponse>;
     }
-    export interface CreateWithItemsResponse {  
+    export interface CreateResponse {  
        subscription:Subscription;
        
        customer:Customer;
@@ -757,7 +764,7 @@ If specified as **schedule_payment_collection**, payment collection for the amou
        
        unbilled_charges?:UnbilledCharge[];
     }
-    export interface CreateWithItemsInputParam {
+    export interface CreateInputParam {
       [key : string] : any;  
       /**
         * @description A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
@@ -767,47 +774,70 @@ If specified as **schedule_payment_collection**, payment collection for the amou
       id?:string;
        
       /**
-        * @description The unique ID of the [business entity](/docs/api/advanced-features?prod_cat_ver&#x3D;2#mbe) this subscription should be [linked](/docs/api/advanced-features?prod_cat_ver&#x3D;2#mbe-linked-be) to. Applicable only when multiple business entities have been created for the site. This must be the same as the business entity of the &#x60;{customer_id}&#x60; for the operation to be successful.  
-**Note**
+        * @description Identifier of the plan for this subscription.
 
-An alternative way of passing this parameter is by means of a [custom HTTP header](/docs/api/advanced-features?prod_cat_ver&#x3D;2#mbe-header-main).
-.
+        */
+       
+      plan_id:string;
+       
+      /**
+        * @description Plan quantity for this subscription.
 
         */
        
-      business_entity_id?:string;
+      plan_quantity?:number;
        
       /**
-        * @description End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than &#x60;start_date&#x60;. Set it to &#x60;0&#x60; to have no trial period.
+        * @description The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units ) is enabled.
 
         */
        
-      trial_end?:number;
+      plan_quantity_in_decimal?:string;
        
       /**
-        * @description The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles [set for the plan-item price](https://apidocs.chargebee.com/docs/api/item_prices?prod_cat_ver&#x3D;2#item_price_billing_cycles) is used.
+        * @description Plan Unit Amount for create subscription.
 
         */
        
-      billing_cycles?:number;
+      plan_unit_price?:number;
        
       /**
-        * @description Item ids of [mandatorily attached addons](./attached_items?prod_cat_ver&#x3D;2) that are to be removed from the subscription.
+        * @description Plan Unit Amount in Decimal for create subscription.
 
         */
        
-      mandatory_items_to_remove?:string[];
+      plan_unit_price_in_decimal?:string;
        
       /**
-        * @description Defines [Net D](https://www.chargebee.com/docs/net_d.html) for the subscription. Net D is the number of days within which any invoice raised for the subscription must be paid.
+        * @description Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api?prod_cat_ver&#x3D;1#md_disabled).
 
-* If a value is provided: Net D is set explicitly for the subscription to the value provided. The value must be one among those defined in the [site configuration](https://www.chargebee.com/docs/net_d.html#enable-net-d-for-chargebee-invoices).
-* If not provided: The attribute is not set and therefore not returned by the API. In this case, when an invoice is raised -- whether now or later -- the &#x60;net_term_days&#x60; defined at the [customer level](customers#customer_net_term_days) is considered.
-.
+        */
+       
+      setup_fee?:number;
+       
+      /**
+        * @description The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **&#x27;0&#x27;** is passed, the subscription will be activated immediately.
 
         */
        
-      net_term_days?:number;
+      trial_end?:number;
+       
+      /**
+        * @description Specifies the number of billing cycles for the subscription. The behavior of the subscription after the billing cycles have completed depends on whether the subscription is on a [contract term](contract_terms?prod_cat_ver&#x3D;1) or not.
+
+* When the subscription is not on a contract term: if &#x60;billing_cycles&#x60; is not provided, then the billing cycles [set for the plan](plans?prod_cat_ver&#x3D;1&amp;lang&#x3D;curl#plan_billing_cycles) is used. Moreover, once the &#x60;billing_cycles&#x60; have completed, the subscription cancels.
+* When the subscription is on a contract term: Providing &#x60;billing_cycles&#x60; is mandatory. Moreover, once the &#x60;billing_cycles&#x60; have completed, the behavior of the subscription is determined by the &#x60;contract_term[action_at_term_end]&#x60; parameter.
+
+        */
+       
+      billing_cycles?:number;
+       
+      /**
+        * @description List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
+
+        */
+       
+      mandatory_addons_to_remove?:string[];
        
       /**
         * @description The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
@@ -842,6 +872,13 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
        
       billing_alignment_mode?:BillingAlignmentMode;
        
+      /**
+        * @description The preferred offline payment method for the subscription. \* sepa_credit - SEPA Credit \* cash - Cash \* no_preference - No Preference \* bank_transfer - Bank Transfer \* check - Check \* boleto - Boleto \* ach_credit - ACH Credit
+
+        */
+       
+      offline_payment_method?:OfflinePaymentMethod;
+       
       /**
         * @description Purchase order number for this subscription.
 
@@ -857,18 +894,18 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
       coupon_ids?:string[];
        
       /**
-        * @description Id of the payment source to be attached to this subscription.
+        * @description The Chargebee payment token generated by Chargebee JS.
 
         */
        
-      payment_source_id?:string;
+      token_id?:string;
        
       /**
-        * @description If &#x60;true&#x60;, ignores the [hierarchy relationship](./customers?prod_cat_ver&#x3D;2#customer_relationship) and uses customer as payment and invoice owner.
+        * @description A unique tracking token.
 
         */
        
-      override_relationship?:boolean;
+      affiliate_token?:string;
        
       /**
         * @description A customer-facing note added to all invoices associated with this subscription. This note is one among [all the notes](/docs/api/invoices#invoice_notes) displayed on the invoice PDF.
@@ -893,7 +930,7 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
       /**
         * @description A collection of key-value pairs that provides extra information about the subscription.  
 **Note:** There&#x27;s a character limit of 65,535.
-[Learn more](advanced-features?prod_cat_ver&#x3D;2#metadata).
+[Learn more](advanced-features?prod_cat_ver&#x3D;1#metadata).
 
         */
        
@@ -907,13 +944,6 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
        
       invoice_immediately?:boolean;
        
-      /**
-        * @description Indicates whether the primary payment source should be replaced with this payment source. In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
-
-        */
-       
-      replace_primary_payment_source?:boolean;
-       
       /**
         * @description The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.
 
@@ -936,395 +966,535 @@ An alternative way of passing this parameter is by means of a [custom HTTP heade
       contract_term_billing_cycle_on_renewal?:number;
        
       /**
-        * @description Indicates whether the invoices for this subscription are generated with a &#x60;pending&#x60; &#x60;status&#x60;. This attribute is set to &#x60;true&#x60; automatically when the subscription has item prices that belong to &#x60;metered&#x60; items.
-
-You can also set this to &#x60;true&#x60; explicitly using the [create](/docs/api/subscriptions#create_subscription_for_items_create_pending_invoices)/[update](/docs/api/subscriptions#update_subscription_for_items_create_pending_invoices) subscription operations. This is useful in the following scenarios:
-
-* When tracking usages and calculating usage-based charges on your end. You can then add them to the subscription as a [one-time charge](https://www.chargebee.com/docs/charges.html) at the end of the billing term.
-* When you need to inspect all charges before closing invoices for this subscription.
-
-Applicable only when [Metered Billing](https://www.chargebee.com/docs/metered_billing.html) is enabled for the site
-.
+        * @description Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/2.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions) has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends. \* activate_subscription - The subscription activates and charges are raised for non-metered items. \* cancel_subscription - The subscription cancels. \* plan_default - The action [configured for the site](https://www.chargebee.com/docs/trial_periods.html#how-to-define-the-end-of-trial-actions-for-subscriptions) at the time when the trial ends, takes effect. This is the default value when &#x60;trial_end_action&#x60; is defined for the plan. \* site_default - The action [configured for the site](https://www.chargebee.com/docs/trial_periods.html#how-to-define-the-end-of-trial-actions-for-subscriptions) at the time when the trial ends, takes effect. This is the default value when &#x60;trial_end_action&#x60; is **not** defined for the plan.
 
         */
        
-      create_pending_invoices?:boolean;
+      trial_end_action?:TrialEndAction;
        
       /**
-        * @description Set to &#x60;false&#x60; to override for this subscription, the [site-level setting](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing) for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the [customer level](/docs/api/customers?prod_cat_ver&#x3D;2#customer_auto_close_invoices).
+        * @description Indicates the Client profile id for the customer. This is applicable only if you use [Chargebee&#x27;s AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration.
 
         */
        
-      auto_close_invoices?:boolean;
+      client_profile_id?:string;
        
       /**
-        * @description If you want to bill the usages from the previous billing cycle, set this parameter to &#x60;true&#x60;. This is useful if the subscription has moved from another system into Chargebee and you haven&#x27;t closed the previous cycle&#x27;s invoice yet. This creates a &#x60;pending&#x60; invoice immediately on subscription creation, to which you can [add usages](/docs/api/usages#create_a_usage) for the previous cycle.
-
-If any non-&#x60;metered&#x60; items are present for the current term, they&#x27;re also added to this &#x60;pending&#x60; invoice. As with all &#x60;pending&#x60; invoices, this invoice is also [closed automatically](https://www.chargebee.com/docs/metered_billing.html#configuring-metered-billing) or via an [API call](/docs/api/invoices#close_a_pending_invoice). This parameter can be passed only when the &#x60;create_pending_invoices&#x60; is &#x60;true&#x60;
-.
+        * @description The type of initiator to be used for the payment request triggered by this operation. \* customer - Pass this value to indicate that the request is initiated by the customer \* merchant - Pass this value to indicate that the request is initiated by the merchant
 
         */
        
-      first_invoice_pending?:boolean;
+      payment_initiator?:PaymentInitiator;
        
       /**
-        * @description Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/2.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions) has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends. \* cancel_subscription - The subscription cancels. \* activate_subscription - The subscription activates and charges are raised for non-metered items. \* plan_default - The action [configured for the site](https://www.chargebee.com/docs/trial_periods.html#how-to-define-the-end-of-trial-actions-for-subscriptions) at the time when the trial ends, takes effect. This is the default value when &#x60;trial_end_action&#x60; is defined for the plan. \* site_default - The action [configured for the site](https://www.chargebee.com/docs/trial_periods.html#how-to-define-the-end-of-trial-actions-for-subscriptions) at the time when the trial ends, takes effect. This is the default value when &#x60;trial_end_action&#x60; is **not** defined for the plan.
+        * @description Parameters for customer
 
         */
        
-      trial_end_action?:TrialEndAction;
+      customer?:object;
        
       /**
-        * @description The type of initiator to be used for the payment request triggered by this operation. \* customer - Pass this value to indicate that the request is initiated by the customer \* merchant - Pass this value to indicate that the request is initiated by the merchant
+        * @description Parameters for card
 
         */
        
-      payment_initiator?:PaymentInitiator;
+      card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway_account_id?:string,last_name?:string,number?:string};
        
       /**
-        * @description Parameters for shipping_address
+        * @description Parameters for bank_account
 
         */
        
-      shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
+      bank_account?:{account_holder_type?:AccountHolderType,account_number?:string,account_type?:AccountType,bank_code?:string,bank_name?:string,billing_address?:object,company?:string,echeck_type?:EcheckType,email?:string,first_name?:string,gateway_account_id?:string,iban?:string,issuing_country?:string,last_name?:string,phone?:string,routing_number?:string,swedish_identity_number?:string};
        
       /**
-        * @description **Note:** This endpoint optionally supports 3DS. To use it [create](./payment_intents?prod_cat_ver&#x3D;2#create_a_payment_intent) a &#x60;payment_intent&#x60; and provide it via this endpoint.
-
-Creates a new subscription for an existing customer in Chargebee. Any available [credits and excess payments](./customers?prod_cat_ver&#x3D;2#customer_balances) for the customer are automatically applied on the invoice.  
-**See also**
-
-* [Create a purchase](https://apidocs.chargebee.com/docs/api/purchases#create_a_purchase): an operation that creates a purchase representing multiple subscriptions bought together by a customer.
+        * @description Parameters for payment_method
 
         */
        
-      statement_descriptor?:{additional_info?:string,descriptor?:string};
+      payment_method?:{additional_information?:object,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type?:Type};
        
       /**
         * @description Parameters for payment_intent
 
         */
        
-      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
+      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
        
       /**
-        * @description Parameters for contract_term
+        * @description Parameters for billing_address
 
         */
        
-      contract_term?:{action_at_term_end?:'cancel' | 'renew' | 'evergreen',cancellation_cutoff_period?:number};
+      billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
        
       /**
-        * @description Parameters for subscription_items
+        * @description Parameters for shipping_address
 
         */
        
-      subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
+      shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
        
       /**
-        * @description Parameters for discounts
+        * @description **Note:** This operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/#3ds-implementation-guide) and pass it as input parameter to this API.
+
+Creates a new subscription along with the customer. You can attach a plan, plan quantity, one or more addons and coupon while creating this subscription.
+
+#### Future Subscriptions
+
+If the **start_date** is specified, the subscription will be created in &#x27;future&#x27; state (.ie, instead of starting immediately it will be scheduled to start at the specified &#x27;start_date&#x27;). Besides if &#x27;trial&#x27; is specified (plan configuration or specified explicitly using trial_end), the subscription will go into &#x27;trial&#x27; state when it starts. Otherwise it will directly become &#x27;active&#x27; when it starts.
+
+#### Trial Period
+
+If the plan has trial period or if the trial_end is specified explicitly, the subscription will be created in &#x27;in_trial&#x27; state.
+
+If the card details are passed, it is not charged until the end of the trial period. Incase you need to verify the card you could enable the [&#x27;card verification option&#x27;](https://www.chargebee.com/docs/cards.html#card-verification) in the gateway settings.
+
+#### Invoice
+
+If the plan does not have a trial period and if any of the recurring items has charges, then a invoice would be raised immediately. If &#x27;auto_collection&#x27; is turned &#x27;on&#x27;, then card attributes are mandatory and subscription will be created only if the payment was successful.
+
+#### Card details
+
+Passing card details to this API involves PCI liability at your end as sensitive card information passes through your servers. If you wish to avoid that, you can use one of the following integration methodologies if applicable
+
+* If you are using Stripe gateway, you can use [Stripe.js](https://stripe.com/docs/stripe.js) with your checkout form. Take a look at this [Stripe tutorial](https://stripe.com/docs/payments/accept-a-payment-charges) for more details.
+* If you are using Braintree gateway, you can use [Braintree.js](//www.braintreepayments.com/docs/javascript) with your checkout form. Please refer this [tutorial](https://www.chargebee.com/tutorials/braintree-js-example.html) for more details.
+* If you are using Authorize.Net gateway, you use [Accept.js](https://developer.authorize.net/api/reference/features/acceptjs.html) with your checkout form.
+* In case you are using the Adyen gateway, you will have to use the Adyen&#x27;s [Client Side Encryption](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/cse-integration-ecommerce) to encrypt sensitive cardholder data. Once the cardholder data is encrypted, pass the value in adyen.encrypted.data as temp token in this API.
+
+You can also use our [Hosted Pages](https://www.chargebee.com/docs/hosted_pages.html) based integration.
+
+
+
+**Legacy behavior:**
+
+* **For [sites](https://www.chargebee.com/docs/sites-intro.html) created before March 1st, 2014:** On making this request, the &#x60;billing_address&#x60; and &#x60;vat_number&#x60; of the customer are **deleted** and replaced by the values passed with this request. Ensure that you pass the [billing address parameters](/docs/api/subscriptions?prod_cat_ver&#x3D;1#create_a_subscription_card_billing_addr1) and the &#x60;vat_number&#x60; parameters each time you make this request, to avoid losing the same information at the customer-level.
+* **For [sites](https://www.chargebee.com/docs/sites-intro.html) created on or after March 1st, 2014:** This request does not alter the &#x60;billing_address&#x60; and &#x60;vat_number&#x60; of the customer.
+
+
+
+#### Related Tutorials
+
+* [Check out this tutorial to create trial signup with custom fields.](//www.chargebee.com/tutorials/custom-fields-recurring-billing-example.html)
+* [Learn how to implement a in-app checkout flow that allows your customers to select addons and apply coupons. Estimate API is used to dynamically calculate the order summary shown to the customer.](https://www.chargebee.com/tutorials/in-app-checkout-page-using-estimate-api-example.html)
+
+
+
 
         */
        
-      discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
+      statement_descriptor?:{additional_info?:string,descriptor?:string};
        
       /**
-        * @description Parameters for item_tiers
+        * @description Parameters for contract_term
 
         */
        
-      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}[];
-    }
-    export interface ListResponse {  
+      contract_term?:{action_at_term_end?:'cancel' | 'renew' | 'evergreen',cancellation_cutoff_period?:number};
+       
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description Parameters for entity_identifiers
 
         */
        
-       list:{subscription:Subscription,customer:Customer,card?:Card}[];
+      entity_identifiers?:{id?:string,scheme?:string,standard?:string,value?:string}[];
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description Parameters for addons
 
         */
        
-       next_offset?:string;
-    }
-    export interface ListInputParam {
-      [key : string]: any;  
+      addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
+       
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description Parameters for event_based_addons
 
         */
-        
-      limit?:number;
        
+      event_based_addons?:{charge_on?:ChargeOn,charge_once?:boolean,id?:string,on_event?:OnEvent,quantity?:number,quantity_in_decimal?:string,service_period_in_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
+    }
+    export interface CreateForCustomerResponse {  
+       subscription:Subscription;
+       
+       customer:Customer;
+       
+       card?:Card;
+       
+       invoice?:Invoice;
+       
+       unbilled_charges?:UnbilledCharge[];
+    }
+    export interface CreateForCustomerInputParam {
+      [key : string] : any;  
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
 
         */
-        
-      offset?:string;
+       
+      id?:string;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description Identifier of the plan for this subscription.
 
         */
-        
-      include_deleted?:boolean;
+       
+      plan_id:string;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description Plan quantity for this subscription.
 
         */
-        
-      id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      plan_quantity?:number;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units ) is enabled.
 
         */
-        
-      customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      plan_quantity_in_decimal?:string;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description Amount that will override the Plan&#x27;s default price. The unit depends on the [type of currency](/docs/api?prod_cat_ver&#x3D;1#md_disabled).
 
         */
-        
-      item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      plan_unit_price?:number;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description When [price overriding](http://chargebee.com/docs/price-override.html )is enabled for the site, the price or per-unit price of the plan can be set here. The value [set for the plan](https://apidocs.chargebee.com/docs/api/plans#plan_price ) is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units ) is enabled.
 
         */
-        
-      item_price_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      plan_unit_price_in_decimal?:string;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api?prod_cat_ver&#x3D;1#md_disabled).
 
         */
-        
-      status?:{in?:string,is?:'in_trial' | 'paused' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing',is_not?:'in_trial' | 'paused' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing',not_in?:string};
+       
+      setup_fee?:number;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description The time at which the trial ends for this subscription. Can be specified to override the default trial period.If **&#x27;0&#x27;** is passed, the subscription will be activated immediately.
 
         */
-        
-      cancel_reason?:{in?:string,is?:'tax_calculation_failed' | 'fraud_review_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_eu_customer' | 'non_compliant_customer' | 'not_paid' | 'no_card',is_not?:'tax_calculation_failed' | 'fraud_review_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_eu_customer' | 'non_compliant_customer' | 'not_paid' | 'no_card',is_present?:'true' | 'false',not_in?:string};
+       
+      trial_end?:number;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description Specifies the number of billing cycles for the subscription. The behavior of the subscription after the billing cycles have completed depends on whether the subscription is on a [contract term](contract_terms?prod_cat_ver&#x3D;1) or not.
+
+* When the subscription is not on a contract term: if &#x60;billing_cycles&#x60; is not provided, then the billing cycles [set for the plan](plans?prod_cat_ver&#x3D;1&amp;lang&#x3D;curl#plan_billing_cycles) is used. Moreover, once the &#x60;billing_cycles&#x60; have completed, the subscription cancels.
+* When the subscription is on a contract term: Providing &#x60;billing_cycles&#x60; is mandatory. Moreover, once the &#x60;billing_cycles&#x60; have completed, the behavior of the subscription is determined by the &#x60;contract_term[action_at_term_end]&#x60; parameter.
 
         */
-        
-      cancel_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      billing_cycles?:number;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
 
         */
-        
-      remaining_billing_cycles?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,is_present?:'true' | 'false',lt?:string,lte?:string};
+       
+      mandatory_addons_to_remove?:string[];
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
+
+* Backdating is enabled for subscription creation operations.
+* The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is typically the day of the month by which the accounting for the previous month must be closed.
+* The date is not more than duration X into the past, where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, &#x60;start_date&#x60; cannot be earlier than 14th February.
+.
 
         */
-        
-      created_at?:{after?:string,before?:string,between?:string,on?:string};
+       
+      start_date?:number;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description Defines whether payments need to be collected automatically for this subscription. Overrides customer&#x27;s auto-collection property. \* on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available. \* off - Automatic collection of charges will not be made for this subscription. Use this for offline payments.
 
         */
-        
-      activated_at?:{after?:string,before?:string,between?:string,is_present?:'true' | 'false',on?:string};
+       
+      auto_collection?:AutoCollection;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description The number of subscription billing cycles (including the first one) to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html).
 
         */
-        
-      next_billing_at?:{after?:string,before?:string,between?:string,on?:string};
+       
+      terms_to_charge?:number;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date) for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site. \* immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly.. \* delayed - Subscription period will be aligned with the configured billing date at the next renewal.
 
         */
-        
-      cancelled_at?:{after?:string,before?:string,between?:string,on?:string};
+       
+      billing_alignment_mode?:BillingAlignmentMode;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description The preferred offline payment method for the subscription. \* sepa_credit - SEPA Credit \* cash - Cash \* no_preference - No Preference \* bank_transfer - Bank Transfer \* boleto - Boleto \* check - Check \* ach_credit - ACH Credit
 
         */
-        
-      has_scheduled_changes?:{is?:'true' | 'false'};
+       
+      offline_payment_method?:OfflinePaymentMethod;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description Purchase order number for this subscription.
 
         */
-        
-      updated_at?:{after?:string,before?:string,between?:string,on?:string};
+       
+      po_number?:string;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
 
         */
-        
-      offline_payment_method?:{in?:string,is?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit' | 'cash',is_not?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit' | 'cash',not_in?:string};
+       
+      coupon_ids?:string[];
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description Id of the payment source to be attached to this subscription.
 
         */
-        
-      auto_close_invoices?:{is?:'true' | 'false'};
+       
+      payment_source_id?:string;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description If &#x60;true&#x60;, ignores the [hierarchy relationship](./customers?prod_cat_ver&#x3D;2#customer_relationship) and uses customer as payment and invoice owner.
 
         */
-        
-      override_relationship?:{is?:'true' | 'false'};
+       
+      override_relationship?:boolean;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description A customer-facing note added to all invoices associated with this subscription. This note is one among [all the notes](/docs/api/invoices#invoice_notes) displayed on the invoice PDF.
 
         */
-        
-      sort_by?:{asc?:'updated_at' | 'created_at',desc?:'updated_at' | 'created_at'};
+       
+      invoice_notes?:string;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if &#x60;create_pending_invoices&#x60; is set to &#x60;true&#x60;, and if the site is configured to set invoice dates to the date of closing, then upon invoice closure, this date is changed to the invoice closing date. &#x60;taxes&#x60; and &#x60;line_item_taxes&#x60; are computed based on the tax configuration as of &#x60;invoice_date&#x60;. When passing this parameter, the following prerequisites must be met:
+
+* &#x60;invoice_date&#x60; must be in the past.
+* It is not earlier than &#x60;start_date&#x60;.
+* It is not more than one calendar month into the past. Eg. If today is 13th January, then you cannot pass a value that is earlier than 13th December.
+* &#x60;invoice_immediately&#x60; is true.
+.
 
         */
-        
-      business_entity_id?:{is?:string,is_not?:string,starts_with?:string};
+       
+      invoice_date?:number;
        
       /**
-        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+        * @description A collection of key-value pairs that provides extra information about the subscription.  
+**Note:** There&#x27;s a character limit of 65,535.
+[Learn more](advanced-features?prod_cat_ver&#x3D;1#metadata).
 
         */
-        
-      channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string};
-    }
-    export interface ContractTermsForSubscriptionResponse {  
+       
+      meta_data?:object;
+       
       /**
-        * @description Retrieves a list of contract term resources for the subscription specified in the path.
+        * @description If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html). The default value is as per the [site settings](https://www.chargebee.com/docs/unbilled-charges.html#configuration).  
+**Note:** &#x60;invoice_immediately&#x60; only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter. .
 
         */
        
-       list:{contract_term:ContractTerm}[];
+      invoice_immediately?:boolean;
        
       /**
-        * @description Retrieves a list of contract term resources for the subscription specified in the path.
+        * @description Indicates whether the primary payment source should be replaced with this payment source. In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
 
         */
        
-       next_offset?:string;
-    }
-    export interface ContractTermsForSubscriptionInputParam {
-      [key : string]: any;  
+      replace_primary_payment_source?:boolean;
+       
       /**
-        * @description Retrieves a list of contract term resources for the subscription specified in the path.
+        * @description The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.
 
         */
-        
-      limit?:number;
+       
+      free_period?:number;
        
       /**
-        * @description Retrieves a list of contract term resources for the subscription specified in the path.
+        * @description The unit of time in multiples of which the free_period parameter is expressed. The value must be equal to or lower than the [period_unit](/docs/api/plans#create_a_plan_period_unit) attribute of the [plan](/docs/api/subscriptions#create_a_subscription_plan_id) chosen. \* week - Charge based on week(s) \* month - Charge based on month(s) \* day - Charge based on day(s) \* year - Charge based on year(s)
 
         */
-        
-      offset?:string;
-    }
-    export interface ListDiscountsResponse {  
+       
+      free_period_unit?:FreePeriodUnit;
+       
       /**
-        * @description Returns a list of discounts currently attached to the subscription given by &#x60;{subscription_id}&#x60;. The list is sorted by date of creation, in descending order.
+        * @description Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as &#x60;billing_cycles&#x60; or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms).
 
         */
        
-       list:{discount:Discount}[];
+      contract_term_billing_cycle_on_renewal?:number;
        
       /**
-        * @description Returns a list of discounts currently attached to the subscription given by &#x60;{subscription_id}&#x60;. The list is sorted by date of creation, in descending order.
+        * @description Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/2.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions) has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends. \* cancel_subscription - The subscription cancels. \* activate_subscription - The subscription activates and charges are raised for non-metered items. \* plan_default - The action [configured for the site](https://www.chargebee.com/docs/trial_periods.html#how-to-define-the-end-of-trial-actions-for-subscriptions) at the time when the trial ends, takes effect. This is the default value when &#x60;trial_end_action&#x60; is defined for the plan. \* site_default - The action [configured for the site](https://www.chargebee.com/docs/trial_periods.html#how-to-define-the-end-of-trial-actions-for-subscriptions) at the time when the trial ends, takes effect. This is the default value when &#x60;trial_end_action&#x60; is **not** defined for the plan.
 
         */
        
-       next_offset?:string;
-    }
-    export interface ListDiscountsInputParam {
-      [key : string]: any;  
+      trial_end_action?:TrialEndAction;
+       
       /**
-        * @description Returns a list of discounts currently attached to the subscription given by &#x60;{subscription_id}&#x60;. The list is sorted by date of creation, in descending order.
+        * @description The type of initiator to be used for the payment request triggered by this operation. \* customer - Pass this value to indicate that the request is initiated by the customer \* merchant - Pass this value to indicate that the request is initiated by the merchant
 
         */
-        
-      limit?:number;
+       
+      payment_initiator?:PaymentInitiator;
        
       /**
-        * @description Returns a list of discounts currently attached to the subscription given by &#x60;{subscription_id}&#x60;. The list is sorted by date of creation, in descending order.
+        * @description Parameters for shipping_address
 
         */
-        
-      offset?:string;
-    }
-    export interface RetrieveResponse {  
-       subscription:Subscription;
        
-       customer:Customer;
+      shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
        
-       card?:Card;
-    }
-    
-    export interface RetrieveWithScheduledChangesResponse {  
-       subscription:Subscription;
+      /**
+        * @description **Note:** This operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/#3ds-implementation-guide) and pass it as input parameter to this API.
+
+Creates a new subscription for an existing customer. You can attach a plan, plan quantity, one or more addons and coupon while creating this subscription.
+
+If the plan does not have a trial period and if any of the recurring-item has charges, then the customer is charged immediately if auto_collection is turned &#x27;on&#x27;. In that case, subscription is created only if the customer has a payment method on file and attempted payment is successful.
+
+        */
        
-       customer:Customer;
+      statement_descriptor?:{additional_info?:string,descriptor?:string};
        
-       card?:Card;
-    }
-    
-    export interface RemoveScheduledChangesResponse {  
-       subscription:Subscription;
+      /**
+        * @description Parameters for payment_intent
+
+        */
        
-       customer:Customer;
+      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
        
-       card?:Card;
+      /**
+        * @description Parameters for contract_term
+
+        */
        
-       credit_notes?:CreditNote[];
+      contract_term?:{action_at_term_end?:'cancel' | 'renew' | 'evergreen',cancellation_cutoff_period?:number};
+       
+      /**
+        * @description Parameters for addons
+
+        */
+       
+      addons?:{billing_cycles?:number,id?:string,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
+       
+      /**
+        * @description Parameters for event_based_addons
+
+        */
+       
+      event_based_addons?:{charge_on?:ChargeOn,charge_once?:boolean,id?:string,on_event?:OnEvent,quantity?:number,quantity_in_decimal?:string,service_period_in_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
     }
-    
-    export interface RemoveScheduledCancellationResponse {  
+    export interface CreateWithItemsResponse {  
        subscription:Subscription;
        
        customer:Customer;
        
        card?:Card;
+       
+       invoice?:Invoice;
+       
+       unbilled_charges?:UnbilledCharge[];
     }
-    export interface RemoveScheduledCancellationInputParam {
+    export interface CreateWithItemsInputParam {
+      [key : string] : any;  
+      /**
+        * @description A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
+
+        */
+       
+      id?:string;
        
       /**
-        * @description Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
+        * @description The unique ID of the [business entity](/docs/api/advanced-features?prod_cat_ver&#x3D;2#mbe) this subscription should be [linked](/docs/api/advanced-features?prod_cat_ver&#x3D;2#mbe-linked-be) to. Applicable only when multiple business entities have been created for the site. This must be the same as the business entity of the &#x60;{customer_id}&#x60; for the operation to be successful.  
+**Note**
+
+An alternative way of passing this parameter is by means of a [custom HTTP header](/docs/api/advanced-features?prod_cat_ver&#x3D;2#mbe-header-main).
+.
+
+        */
+       
+      business_entity_id?:string;
+       
+      /**
+        * @description End of the trial period for the subscription. This overrides the trial period set for the plan-item. The value must be later than &#x60;start_date&#x60;. Set it to &#x60;0&#x60; to have no trial period.
+
+        */
+       
+      trial_end?:number;
+       
+      /**
+        * @description The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles [set for the plan-item price](https://apidocs.chargebee.com/docs/api/item_prices?prod_cat_ver&#x3D;2#item_price_billing_cycles) is used.
 
         */
        
       billing_cycles?:number;
-    }
-    export interface RemoveCouponsResponse {  
-       subscription:Subscription;
        
-       customer:Customer;
+      /**
+        * @description Item ids of [mandatorily attached addons](./attached_items?prod_cat_ver&#x3D;2) that are to be removed from the subscription.
+
+        */
        
-       card?:Card;
-    }
-    export interface RemoveCouponsInputParam {
+      mandatory_items_to_remove?:string[];
+       
+      /**
+        * @description Defines [Net D](https://www.chargebee.com/docs/net_d.html) for the subscription. Net D is the number of days within which any invoice raised for the subscription must be paid.
+
+* If a value is provided: Net D is set explicitly for the subscription to the value provided. The value must be one among those defined in the [site configuration](https://www.chargebee.com/docs/net_d.html#enable-net-d-for-chargebee-invoices).
+* If not provided: The attribute is not set and therefore not returned by the API. In this case, when an invoice is raised -- whether now or later -- the &#x60;net_term_days&#x60; defined at the [customer level](customers#customer_net_term_days) is considered.
+.
+
+        */
+       
+      net_term_days?:number;
+       
+      /**
+        * @description The date/time at which the subscription is to start. If not provided, the subscription starts immediately. You can provide a value in the past as well. This is called backdating the subscription creation and is done when the subscription has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
+
+* Backdating is enabled for subscription creation operations.
+* The current day of the month does not exceed the limit set in Chargebee for backdating such operations. This day is typically the day of the month by which the accounting for the previous month must be closed.
+* The date is not more than duration X into the past, where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, &#x60;start_date&#x60; cannot be earlier than 14th February.
+.
+
+        */
+       
+      start_date?:number;
+       
+      /**
+        * @description Defines whether payments need to be collected automatically for this subscription. Overrides customer&#x27;s auto-collection property. \* on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available. \* off - Automatic collection of charges will not be made for this subscription. Use this for offline payments.
+
+        */
+       
+      auto_collection?:AutoCollection;
+       
+      /**
+        * @description The number of subscription billing cycles (including the first one) to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html).
+
+        */
+       
+      terms_to_charge?:number;
+       
+      /**
+        * @description Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date) for Calendar Billing. Only applicable when using Calendar Billing. The default value is that which has been configured for the site. \* immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly.. \* delayed - Subscription period will be aligned with the configured billing date at the next renewal.
+
+        */
+       
+      billing_alignment_mode?:BillingAlignmentMode;
+       
+      /**
+        * @description Purchase order number for this subscription.
+
+        */
+       
+      po_number?:string;
        
       /**
         * @description List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
@@ -1332,6 +1502,879 @@ Creates a new subscription for an existing customer in Chargebee. Any available
         */
        
       coupon_ids?:string[];
+       
+      /**
+        * @description Id of the payment source to be attached to this subscription.
+
+        */
+       
+      payment_source_id?:string;
+       
+      /**
+        * @description If &#x60;true&#x60;, ignores the [hierarchy relationship](./customers?prod_cat_ver&#x3D;2#customer_relationship) and uses customer as payment and invoice owner.
+
+        */
+       
+      override_relationship?:boolean;
+       
+      /**
+        * @description A customer-facing note added to all invoices associated with this subscription. This note is one among [all the notes](/docs/api/invoices#invoice_notes) displayed on the invoice PDF.
+
+        */
+       
+      invoice_notes?:string;
+       
+      /**
+        * @description The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if &#x60;create_pending_invoices&#x60; is set to &#x60;true&#x60;, and if the site is configured to set invoice dates to the date of closing, then upon invoice closure, this date is changed to the invoice closing date. &#x60;taxes&#x60; and &#x60;line_item_taxes&#x60; are computed based on the tax configuration as of &#x60;invoice_date&#x60;. When passing this parameter, the following prerequisites must be met:
+
+* &#x60;invoice_date&#x60; must be in the past.
+* It is not earlier than &#x60;start_date&#x60;.
+* It is not more than one calendar month into the past. Eg. If today is 13th January, then you cannot pass a value that is earlier than 13th December.
+* &#x60;invoice_immediately&#x60; is true.
+.
+
+        */
+       
+      invoice_date?:number;
+       
+      /**
+        * @description A collection of key-value pairs that provides extra information about the subscription.  
+**Note:** There&#x27;s a character limit of 65,535.
+[Learn more](advanced-features?prod_cat_ver&#x3D;2#metadata).
+
+        */
+       
+      meta_data?:object;
+       
+      /**
+        * @description If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html). The default value is as per the [site settings](https://www.chargebee.com/docs/unbilled-charges.html#configuration).  
+**Note:** &#x60;invoice_immediately&#x60; only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter. .
+
+        */
+       
+      invoice_immediately?:boolean;
+       
+      /**
+        * @description Indicates whether the primary payment source should be replaced with this payment source. In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.
+
+        */
+       
+      replace_primary_payment_source?:boolean;
+       
+      /**
+        * @description The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.
+
+        */
+       
+      free_period?:number;
+       
+      /**
+        * @description The unit of time in multiples of which the free_period parameter is expressed. The value must be equal to or lower than the [period_unit](/docs/api/plans#create_a_plan_period_unit) attribute of the [plan](/docs/api/subscriptions#create_a_subscription_plan_id) chosen. \* week - Charge based on week(s) \* month - Charge based on month(s) \* day - Charge based on day(s) \* year - Charge based on year(s)
+
+        */
+       
+      free_period_unit?:FreePeriodUnit;
+       
+      /**
+        * @description Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as &#x60;billing_cycles&#x60; or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms).
+
+        */
+       
+      contract_term_billing_cycle_on_renewal?:number;
+       
+      /**
+        * @description Indicates whether the invoices for this subscription are generated with a &#x60;pending&#x60; &#x60;status&#x60;. This attribute is set to &#x60;true&#x60; automatically when the subscription has item prices that belong to &#x60;metered&#x60; items.
+
+You can also set this to &#x60;true&#x60; explicitly using the [create](/docs/api/subscriptions#create_subscription_for_items_create_pending_invoices)/[update](/docs/api/subscriptions#update_subscription_for_items_create_pending_invoices) subscription operations. This is useful in the following scenarios:
+
+* When tracking usages and calculating usage-based charges on your end. You can then add them to the subscription as a [one-time charge](https://www.chargebee.com/docs/charges.html) at the end of the billing term.
+* When you need to inspect all charges before closing invoices for this subscription.
+
+Applicable only when [Metered Billing](https://www.chargebee.com/docs/metered_billing.html) is enabled for the site
+.
+
+        */
+       
+      create_pending_invoices?:boolean;
+       
+      /**
+        * @description Set to &#x60;false&#x60; to override for this subscription, the [site-level setting](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing) for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute has a higher precedence than the same attribute at the [customer level](/docs/api/customers?prod_cat_ver&#x3D;2#customer_auto_close_invoices).
+
+        */
+       
+      auto_close_invoices?:boolean;
+       
+      /**
+        * @description If you want to bill the usages from the previous billing cycle, set this parameter to &#x60;true&#x60;. This is useful if the subscription has moved from another system into Chargebee and you haven&#x27;t closed the previous cycle&#x27;s invoice yet. This creates a &#x60;pending&#x60; invoice immediately on subscription creation, to which you can [add usages](/docs/api/usages#create_a_usage) for the previous cycle.
+
+If any non-&#x60;metered&#x60; items are present for the current term, they&#x27;re also added to this &#x60;pending&#x60; invoice. As with all &#x60;pending&#x60; invoices, this invoice is also [closed automatically](https://www.chargebee.com/docs/metered_billing.html#configuring-metered-billing) or via an [API call](/docs/api/invoices#close_a_pending_invoice). This parameter can be passed only when the &#x60;create_pending_invoices&#x60; is &#x60;true&#x60;
+.
+
+        */
+       
+      first_invoice_pending?:boolean;
+       
+      /**
+        * @description Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/2.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions) has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends. \* cancel_subscription - The subscription cancels. \* activate_subscription - The subscription activates and charges are raised for non-metered items. \* plan_default - The action [configured for the site](https://www.chargebee.com/docs/trial_periods.html#how-to-define-the-end-of-trial-actions-for-subscriptions) at the time when the trial ends, takes effect. This is the default value when &#x60;trial_end_action&#x60; is defined for the plan. \* site_default - The action [configured for the site](https://www.chargebee.com/docs/trial_periods.html#how-to-define-the-end-of-trial-actions-for-subscriptions) at the time when the trial ends, takes effect. This is the default value when &#x60;trial_end_action&#x60; is **not** defined for the plan.
+
+        */
+       
+      trial_end_action?:TrialEndAction;
+       
+      /**
+        * @description The type of initiator to be used for the payment request triggered by this operation. \* customer - Pass this value to indicate that the request is initiated by the customer \* merchant - Pass this value to indicate that the request is initiated by the merchant
+
+        */
+       
+      payment_initiator?:PaymentInitiator;
+       
+      /**
+        * @description Parameters for shipping_address
+
+        */
+       
+      shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
+       
+      /**
+        * @description **Note:** This endpoint optionally supports 3DS. To use it [create](./payment_intents?prod_cat_ver&#x3D;2#create_a_payment_intent) a &#x60;payment_intent&#x60; and provide it via this endpoint.
+
+Creates a new subscription for an existing customer in Chargebee. Any available [credits and excess payments](./customers?prod_cat_ver&#x3D;2#customer_balances) for the customer are automatically applied on the invoice.  
+**See also**
+
+* [Create a purchase](https://apidocs.chargebee.com/docs/api/purchases#create_a_purchase): an operation that creates a purchase representing multiple subscriptions bought together by a customer.
+
+        */
+       
+      statement_descriptor?:{additional_info?:string,descriptor?:string};
+       
+      /**
+        * @description Parameters for payment_intent
+
+        */
+       
+      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
+       
+      /**
+        * @description Parameters for contract_term
+
+        */
+       
+      contract_term?:{action_at_term_end?:'cancel' | 'renew' | 'evergreen',cancellation_cutoff_period?:number};
+       
+      /**
+        * @description Parameters for subscription_items
+
+        */
+       
+      subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
+       
+      /**
+        * @description Parameters for discounts
+
+        */
+       
+      discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
+       
+      /**
+        * @description Parameters for item_tiers
+
+        */
+       
+      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}[];
+    }
+    export interface ListResponse {  
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+       
+       list:{subscription:Subscription,customer:Customer,card?:Card}[];
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+       
+       next_offset?:string;
+    }
+    export interface ListInputParam {
+      [key : string]: any;  
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      limit?:number;
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      offset?:string;
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      include_deleted?:boolean;
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      customer_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      item_price_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      status?:{in?:string,is?:'in_trial' | 'paused' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing',is_not?:'in_trial' | 'paused' | 'transferred' | 'future' | 'active' | 'cancelled' | 'non_renewing',not_in?:string};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      cancel_reason?:{in?:string,is?:'tax_calculation_failed' | 'fraud_review_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_eu_customer' | 'non_compliant_customer' | 'not_paid' | 'no_card',is_not?:'tax_calculation_failed' | 'fraud_review_failed' | 'currency_incompatible_with_gateway' | 'non_compliant_eu_customer' | 'non_compliant_customer' | 'not_paid' | 'no_card',is_present?:'true' | 'false',not_in?:string};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      cancel_reason_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      remaining_billing_cycles?:{between?:string,gt?:string,gte?:string,is?:string,is_not?:string,is_present?:'true' | 'false',lt?:string,lte?:string};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      created_at?:{after?:string,before?:string,between?:string,on?:string};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      activated_at?:{after?:string,before?:string,between?:string,is_present?:'true' | 'false',on?:string};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      next_billing_at?:{after?:string,before?:string,between?:string,on?:string};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      cancelled_at?:{after?:string,before?:string,between?:string,on?:string};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      has_scheduled_changes?:{is?:'true' | 'false'};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      updated_at?:{after?:string,before?:string,between?:string,on?:string};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      offline_payment_method?:{in?:string,is?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit' | 'cash',is_not?:'eu_automated_bank_transfer' | 'bank_transfer' | 'mx_automated_bank_transfer' | 'custom' | 'ach_credit' | 'boleto' | 'check' | 'uk_automated_bank_transfer' | 'no_preference' | 'us_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'sepa_credit' | 'cash',not_in?:string};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      auto_close_invoices?:{is?:'true' | 'false'};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      override_relationship?:{is?:'true' | 'false'};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      sort_by?:{asc?:'updated_at' | 'created_at',desc?:'updated_at' | 'created_at'};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      business_entity_id?:{is?:string,is_not?:string,starts_with?:string};
+       
+      /**
+        * @description Returns a list of subscriptions meeting **all** the conditions specified in the filter parameters below.
+
+        */
+        
+      channel?:{in?:string,is?:'app_store' | 'web' | 'play_store',is_not?:'app_store' | 'web' | 'play_store',not_in?:string};
+    }
+    export interface ContractTermsForSubscriptionResponse {  
+      /**
+        * @description Retrieves a list of contract term resources for the subscription specified in the path.
+
+        */
+       
+       list:{contract_term:ContractTerm}[];
+       
+      /**
+        * @description Retrieves a list of contract term resources for the subscription specified in the path.
+
+        */
+       
+       next_offset?:string;
+    }
+    export interface ContractTermsForSubscriptionInputParam {
+      [key : string]: any;  
+      /**
+        * @description Retrieves a list of contract term resources for the subscription specified in the path.
+
+        */
+        
+      limit?:number;
+       
+      /**
+        * @description Retrieves a list of contract term resources for the subscription specified in the path.
+
+        */
+        
+      offset?:string;
+    }
+    export interface ListDiscountsResponse {  
+      /**
+        * @description Returns a list of discounts currently attached to the subscription given by &#x60;{subscription_id}&#x60;. The list is sorted by date of creation, in descending order.
+
+        */
+       
+       list:{discount:Discount}[];
+       
+      /**
+        * @description Returns a list of discounts currently attached to the subscription given by &#x60;{subscription_id}&#x60;. The list is sorted by date of creation, in descending order.
+
+        */
+       
+       next_offset?:string;
+    }
+    export interface ListDiscountsInputParam {
+      [key : string]: any;  
+      /**
+        * @description Returns a list of discounts currently attached to the subscription given by &#x60;{subscription_id}&#x60;. The list is sorted by date of creation, in descending order.
+
+        */
+        
+      limit?:number;
+       
+      /**
+        * @description Returns a list of discounts currently attached to the subscription given by &#x60;{subscription_id}&#x60;. The list is sorted by date of creation, in descending order.
+
+        */
+        
+      offset?:string;
+    }
+    export interface RetrieveResponse {  
+       subscription:Subscription;
+       
+       customer:Customer;
+       
+       card?:Card;
+    }
+    
+    export interface RetrieveWithScheduledChangesResponse {  
+       subscription:Subscription;
+       
+       customer:Customer;
+       
+       card?:Card;
+    }
+    
+    export interface RemoveScheduledChangesResponse {  
+       subscription:Subscription;
+       
+       customer:Customer;
+       
+       card?:Card;
+       
+       credit_notes?:CreditNote[];
+    }
+    
+    export interface RemoveScheduledCancellationResponse {  
+       subscription:Subscription;
+       
+       customer:Customer;
+       
+       card?:Card;
+    }
+    export interface RemoveScheduledCancellationInputParam {
+       
+      /**
+        * @description Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
+
+        */
+       
+      billing_cycles?:number;
+    }
+    export interface RemoveCouponsResponse {  
+       subscription:Subscription;
+       
+       customer:Customer;
+       
+       card?:Card;
+    }
+    export interface RemoveCouponsInputParam {
+       
+      /**
+        * @description List of coupons to be applied to this subscription. You can provide coupon ids or coupon codes.
+
+        */
+       
+      coupon_ids?:string[];
+    }
+    export interface UpdateResponse {  
+       subscription:Subscription;
+       
+       customer:Customer;
+       
+       card?:Card;
+       
+       invoice?:Invoice;
+       
+       unbilled_charges?:UnbilledCharge[];
+       
+       credit_notes?:CreditNote[];
+    }
+    export interface UpdateInputParam {
+      [key : string] : any;  
+      /**
+        * @description Identifier of the plan for this subscription.
+
+        */
+       
+      plan_id?:string;
+       
+      /**
+        * @description Represents the plan quantity for this subscription.
+
+        */
+       
+      plan_quantity?:number;
+       
+      /**
+        * @description Amount that will override the plan&#x27;s default price. The unit depends on the [type of currency](/docs/api#md_disabled). If &#x60;changes_scheduled_at&#x60; is in the past and a &#x60;plan_unit_price&#x60; is not passed, then the plan&#x27;s current unit price is considered even if the plan did not exist on the date as of when the change is scheduled.
+
+        */
+       
+      plan_unit_price?:number;
+       
+      /**
+        * @description Amount that will override the default setup fee. The unit depends on the [type of currency](/docs/api?prod_cat_ver&#x3D;1#md_disabled).
+
+        */
+       
+      setup_fee?:number;
+       
+      /**
+        * @description Should be true if the existing addons should be replaced with the ones that are being passed.
+
+        */
+       
+      replace_addon_list?:boolean;
+       
+      /**
+        * @description List of addons IDs that are mandatory to the plan and has to be removed from the subscription.
+
+        */
+       
+      mandatory_addons_to_remove?:string[];
+       
+      /**
+        * @description The decimal representation of the quantity of the plan purchased. Can be provided for quantity-based plans and only when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units ) is enabled.
+
+        */
+       
+      plan_quantity_in_decimal?:string;
+       
+      /**
+        * @description When [price overriding](https://www.chargebee.com/docs/price-override.html) is enabled for the site, the price or per-unit price of the item can be set here. The [value set for the item price](/docs/api/item_prices#item_price_price) is used by default. Provide the value as a decimal string in major units of the currency. Can be provided only when [multi-decimal pricing](/docs/api#handling_currency_units) is enabled. If &#x60;changes_scheduled_at&#x60; is in the past and a &#x60;unit_price_in_decimal&#x60; is not passed, then the item price&#x27;s current unit price is considered even if the item price did not exist on the date as of when the change is scheduled.
+
+        */
+       
+      plan_unit_price_in_decimal?:string;
+       
+      /**
+        * @description The document date displayed on the invoice PDF. The default value is the current date. Provide this value to backdate the invoice. Backdating an invoice is done for reasons such as booking revenue for a previous date or when the subscription is effective as of a past date. Moreover, if &#x60;create_pending_invoices&#x60; is set to &#x60;true&#x60;, and if the site is configured to set invoice dates to date of closing, then upon invoice closure, this date is changed to the invoice closing date. taxes and line_item_taxes are computed based on the tax configuration as of &#x60;invoice_date&#x60;. When passing this parameter, the following prerequisites must be met:
+
+* &#x60;invoice_date&#x60; must be in the past.
+* &#x60;invoice_date&#x60; is not more than one calendar month into the past. For example, if today is 13th January, then you cannot pass a value that is earlier than 13th December.
+* It is not earlier than &#x60;changes_scheduled_at&#x60;, &#x60;reactivate_from&#x60;, or &#x60;trial_end&#x60;.
+* &#x60;invoice_immediately&#x60; is &#x60;true&#x60;.
+.
+
+        */
+       
+      invoice_date?:number;
+       
+      /**
+        * @description The new start date of a &#x60;future&#x60; subscription. Applicable only for &#x60;future&#x60; subscriptions.
+
+        */
+       
+      start_date?:number;
+       
+      /**
+        * @description The time at which the trial has ended or will end for the subscription. Set it to &#x60;0&#x60; to have no trial period.  
+**Note**
+
+* This is only allowed when the subscription &#x60;status&#x60; is &#x60;future&#x60;, &#x60;in_trial&#x60;, or &#x60;cancelled&#x60;.
+* The value must not be earlier than &#x60;changes_scheduled_at&#x60; or &#x60;start_date&#x60;.
+* This parameter can be backdated (set to a value in the past) only when the subscription is in &#x60;cancelled&#x60; or &#x60;in_trial&#x60; &#x60;status&#x60;. Do this to keep a record of when the trial ended in case it ended at some point in the past. When &#x60;trial_end&#x60; is backdated, the subscription immediately goes into &#x60;active&#x60; or &#x60;non_renewing&#x60; status.
+
+        */
+       
+      trial_end?:number;
+       
+      /**
+        * @description The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan is used.
+
+        */
+       
+      billing_cycles?:number;
+       
+      /**
+        * @description The number of subscription billing cycles to [invoice in advance](https://www.chargebee.com/docs/advance-invoices.html). If a new term is started for the subscription due to this API call, then &#x60;terms_to_charge&#x60; is inclusive of this new term. See description for the &#x60;force_term_reset&#x60; parameter to learn more about when a subscription term is reset.
+
+        */
+       
+      terms_to_charge?:number;
+       
+      /**
+        * @description If the subscription &#x60;status&#x60; is &#x60;cancelled&#x60; and it is being reactivated via this operation, this is the date/time at which the subscription should be reactivated.  
+**Note:** It is recommended not to pass this parameter along with &#x60;changed_scheduled_at&#x60;. &#x60;reactivate_from&#x60; can be backdated (set to a value in the past). Use backdating when the subscription has been reactivated already but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
+
+* Backdating must be enabled for subscription reactivation operations.
+* The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is the day of the month by which the accounting for the previous month must be closed.
+* The date is on or after the last date/time any of the product catalog items of the subscription were changed.
+* The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, &#x60;changes_scheduled_at&#x60; cannot be earlier than 14th February.
+.
+
+        */
+       
+      reactivate_from?:number;
+       
+      /**
+        * @description Override the [billing alignment mode](https://www.chargebee.com/docs/calendar-billing.html#alignment-of-billing-date) chosen for the site for calendar billing. Only applicable when using calendar billing. \* immediate - Subscription period will be aligned with the configured billing date immediately, with credits or charges raised accordingly.. \* delayed - Subscription period will be aligned with the configured billing date at the next renewal.
+
+        */
+       
+      billing_alignment_mode?:BillingAlignmentMode;
+       
+      /**
+        * @description Defines whether payments need to be collected automatically for this subscription. Overrides customer&#x27;s auto-collection property. \* on - Whenever an invoice is created for this subscription, an automatic charge will be attempted on the payment method available. \* off - Automatic collection of charges will not be made for this subscription. Use this for offline payments.
+
+        */
+       
+      auto_collection?:AutoCollection;
+       
+      /**
+        * @description The preferred offline payment method for the subscription. \* sepa_credit - SEPA Credit \* cash - Cash \* no_preference - No Preference \* bank_transfer - Bank Transfer \* check - Check \* boleto - Boleto \* ach_credit - ACH Credit
+
+        */
+       
+      offline_payment_method?:OfflinePaymentMethod;
+       
+      /**
+        * @description Purchase order number for this subscription.
+
+        */
+       
+      po_number?:string;
+       
+      /**
+        * @description List of coupons to be applied to this subscription. You can provide coupon ids or [coupon codes](https://apidocs.chargebee.com/docs/api/coupon_codes). If &#x60;changes_scheduled_at&#x60; is in the past, then the currently available coupons can be used even if they were not available as of the date for when the change is scheduled.
+
+        */
+       
+      coupon_ids?:string[];
+       
+      /**
+        * @description If &#x60;true&#x60; then the existing &#x60;coupon_ids&#x60; list for the subscription is replaced by the one provided. If &#x60;false&#x60; then the provided list gets added to the existing &#x60;coupon_ids&#x60;.
+
+        */
+       
+      replace_coupon_list?:boolean;
+       
+      /**
+        * @description * When &#x60;true&#x60;: [Prorated credits or charges](https://www.chargebee.com/docs/1.0/proration.html#proration-mechanism) are created as applicable for this change.
+* When &#x60;false&#x60;: The subscription is changed without creating any credits or charges.
+* When not provided, the value configured in the [site settings](https://www.chargebee.com/docs/1.0/proration.html#proration-for-subscription-change) is considered.
+
+**Caveat**
+
+For further changes within the same billing term, when &#x60;prorate&#x60; is set to &#x60;true&#x60;, **credits** are **not created** when **all** the conditions below hold true:
+
+An immediate previous change was made
+
+* with &#x60;prorate&#x60; set to &#x60;false&#x60; and
+* no changes were made to the subscription&#x27;s billing term and
+* a change was made to either the subscription&#x27;s plan, its addons, or the prices of the plan or addons.
+
+        */
+       
+      prorate?:boolean;
+       
+      /**
+        * @description Set this to true if you want the update to be applied at the end of the current subscription billing cycle.
+
+        */
+       
+      end_of_term?:boolean;
+       
+      /**
+        * @description Say the subscription has the renewal date as 28th of every month. When the plan-item price of the subscription is set to one that has the same billing period as the current plan-item price, the subscription change does not change the term. In other words, the subscription still renews on the 28th. Passing this parameter as &#x60;true&#x60; will have the subscription reset its term to the current date (provided &#x60;end_of_term&#x60; is false).   
+**Note**: When the new plan-item price has a billing period different from the current plan-item price of the subscription, the term is always reset, regardless of the value passed for this parameter.
+
+        */
+       
+      force_term_reset?:boolean;
+       
+      /**
+        * @description When the &#x60;status&#x60; of the subscription is &#x60;cancelled&#x60;, this parameter determines whether the subscription is reactivated upon making this API request. Unless passed explicitly as &#x60;false&#x60;, this parameter is implied as &#x60;true&#x60; when you provide &#x60;plan_id&#x60; or &#x60;addons[id]&#x60;
+
+        */
+       
+      reactivate?:boolean;
+       
+      /**
+        * @description The Chargebee payment token generated by Chargebee JS.
+
+        */
+       
+      token_id?:string;
+       
+      /**
+        * @description A customer-facing note added to all invoices associated with this subscription. This note is one among [all the notes](/docs/api/invoices#invoice_notes) displayed on the invoice PDF.
+
+        */
+       
+      invoice_notes?:string;
+       
+      /**
+        * @description A collection of key-value pairs that provides extra information about the subscription.  
+**Note:** There&#x27;s a character limit of 65,535.
+[Learn more](advanced-features?prod_cat_ver&#x3D;1#metadata).
+
+        */
+       
+      meta_data?:object;
+       
+      /**
+        * @description If there are charges raised immediately for the subscription, this parameter specifies whether those charges are to be invoiced immediately or added to [unbilled charges](https://www.chargebee.com/docs/unbilled-charges.html). The default value is as per the [site settings](https://www.chargebee.com/docs/unbilled-charges.html#configuration).  
+**Note:** &#x60;invoice_immediately&#x60; only affects charges that are raised at the time of execution of this API call. Any charges scheduled to be raised in the future are not affected by this parameter. .
+
+        */
+       
+      invoice_immediately?:boolean;
+       
+      /**
+        * @description If &#x60;true&#x60;, ignores the [hierarchy relationship](./customers?prod_cat_ver&#x3D;2#customer_relationship) and uses customer as payment and invoice owner.
+
+        */
+       
+      override_relationship?:boolean;
+       
+      /**
+        * @description When &#x60;change_option&#x60; is set to &#x60;specific_date&#x60;, then set the date/time at which the subscription change is to happen or has happened. **Note:** It is recommended not to pass this parameter along with &#x60;reactivate_from&#x60;. &#x60;changes_scheduled_at&#x60; can be set to a value in the past. This is called backdating the subscription change and is performed when the subscription change has already been provisioned but its billing has been delayed. Backdating is allowed only when the following prerequisites are met:
+
+* Backdating must be enabled for subscription change operations.
+* Only the following changes can be backdated:
+  * Changes in the recurring items or their prices.
+  * Addition of non-recurring items.
+* Subscription &#x60;status&#x60; is &#x60;active&#x60;, &#x60;cancelled&#x60;, or &#x60;non_renewing&#x60;.
+* The current day of the month does not exceed the limit set in Chargebee for backdating subscription change. This limit is typically the day of the month by which the accounting for the previous month must be closed.
+* The date is on or after &#x60;current_term_start&#x60;.
+* The date is on or after the last date/time any of the following changes were made:
+  * Changes in the recurring items or their prices.
+  * Addition of non-recurring items.
+* The date is not more than duration X into the past where X is the billing period of the plan. For example, if the period of the plan in the subscription is 2 months and today is 14th April, &#x60;changes_scheduled_at&#x60; cannot be earlier than 14th February.
+.
+
+        */
+       
+      changes_scheduled_at?:number;
+       
+      /**
+        * @description When the quote is converted, this attribute determines the date/time as of when the subscription change is to be carried out. \* end_of_term - The change is carried out at the end of the current billing cycle of the subscription. \* specific_date - The change is carried out as of the date specified under &#x60;changes_scheduled_at&#x60;. \* immediately - The change is carried out immediately.
+
+        */
+       
+      change_option?:ChangeOption;
+       
+      /**
+        * @description Number of billing cycles the new contract term should run for, on contract renewal. The default value is the same as &#x60;billing_cycles&#x60; or a custom value depending on the [site configuration](https://www.chargebee.com/docs/contract-terms.html#configuring-contract-terms).
+
+        */
+       
+      contract_term_billing_cycle_on_renewal?:number;
+       
+      /**
+        * @description The period of time by which the first term of the subscription is to be extended free-of-charge. The value must be in multiples of free_period_unit.
+
+        */
+       
+      free_period?:number;
+       
+      /**
+        * @description The unit of time in multiples of which the free_period parameter is expressed. The value must be equal to or lower than the [period_unit](/docs/api/plans#create_a_plan_period_unit) attribute of the [plan](/docs/api/subscriptions#create_a_subscription_plan_id) chosen. \* week - Charge based on week(s) \* month - Charge based on month(s) \* day - Charge based on day(s) \* year - Charge based on year(s)
+
+        */
+       
+      free_period_unit?:FreePeriodUnit;
+       
+      /**
+        * @description Applicable only when [End-of-trial Action](https://www.chargebee.com/docs/2.0/trial_periods_hidden.html#how-to-define-the-end-of-trial-actions-for-subscriptions) has been enabled for the site. Whenever the subscription has a trial period, this attribute (parameter) is returned (required) and specifies the operation to be carried out for the subscription once the trial ends. \* activate_subscription - The subscription activates and charges are raised for non-metered items. \* cancel_subscription - The subscription cancels. \* plan_default - The action [configured for the site](https://www.chargebee.com/docs/trial_periods.html#how-to-define-the-end-of-trial-actions-for-subscriptions) at the time when the trial ends, takes effect. This is the default value when &#x60;trial_end_action&#x60; is defined for the plan. \* site_default - The action [configured for the site](https://www.chargebee.com/docs/trial_periods.html#how-to-define-the-end-of-trial-actions-for-subscriptions) at the time when the trial ends, takes effect. This is the default value when &#x60;trial_end_action&#x60; is **not** defined for the plan.
+
+        */
+       
+      trial_end_action?:TrialEndAction;
+       
+      /**
+        * @description Parameters for card
+
+        */
+       
+      card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway_account_id?:string,last_name?:string,number?:string};
+       
+      /**
+        * @description Parameters for payment_method
+
+        */
+       
+      payment_method?:{additional_information?:object,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type?:Type};
+       
+      /**
+        * @description Parameters for payment_intent
+
+        */
+       
+      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
+       
+      /**
+        * @description Parameters for billing_address
+
+        */
+       
+      billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
+       
+      /**
+        * @description Parameters for shipping_address
+
+        */
+       
+      shipping_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
+       
+      /**
+        * @description **Note:** This operation optionally supports 3DS verification flow. To achieve the same, create the [Payment Intent](/docs/api/#3ds-implementation-guide) and pass it as input parameter to this API.
+
+You can modify the plan, plan quantity and add or remove addons for the subscription. By default the changes are applied immediately and the charges (/credits) are prorated and adjusted with the next billing term. You may also choose to effect the changes at the end of the current term by passing **end_of_term** as &quot;true&quot;. In this case proration will not be done.
+
+Only the parameters that are passed are modified for the subscription. Rest will reflect the existing values.
+
+By default, the addons passed are appended to the existing list of addons for this subscription. In case a passed addon already exists for this subscription, quantity value is replaced. If you want to completely replace the addons for this subscription, pass **replace_addon_list** as &quot;true&quot;.
+
+[Card](/docs/api/cards#card_attributes) and &#x27;vat_number&#x27; attributes can also be passed during subscription update. If they are passed, corresponding Billing Info attributes - the [Billing Address](/docs/api/customers#billing_address_attributes) and &#x27;vat_number&#x27; - will be replaced automatically.
+
+Passing credit card details to this API involves PCI liability at your end as sensitive card info passes through your servers. If you wish to avoid that, you can use one of the following integration methodologies if applicable
+
+* If you are using Stripe gateway, you can use [Stripe.js](https://stripe.com/docs/stripe.js) with your checkout form. Take a look at this [Stripe tutorial](https://stripe.com/docs/payments/accept-a-payment-charges) for more details.
+* If you are using Braintree gateway, you can use [Braintree.js](https://www.braintreepayments.com/docs/javascript) with your checkout form. Please refer this [tutorial](https://www.chargebee.com/tutorials/braintree-js-example.html) for more details.
+* If you are using Authorize.Net gateway, you use [Accept.js](https://developer.authorize.net/api/reference/features/acceptjs.html) with your checkout form.
+* If you are using the Adyen gateway, you will have to use the Adyen&#x27;s [Client Side Encryption](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/cse-integration-ecommerce) to encrypt sensitive cardholder data. Once the cardholder data is encrypted, pass the value in adyen.encrypted.data as temp token in this API.
+* You can also use our [Hosted Pages](https://www.chargebee.com/docs/hosted_pages.html) based integration.
+
+
+
+
+        */
+       
+      statement_descriptor?:{additional_info?:string,descriptor?:string};
+       
+      /**
+        * @description Parameters for customer
+
+        */
+       
+      customer?:{business_customer_without_vat_number?:boolean,einvoicing_method?:EinvoicingMethod,entity_identifier_scheme?:string,entity_identifier_standard?:string,is_einvoice_enabled?:boolean,registered_for_gst?:boolean,vat_number?:string,vat_number_prefix?:string};
+       
+      /**
+        * @description Parameters for contract_term
+
+        */
+       
+      contract_term?:{action_at_term_end?:'cancel' | 'renew_once' | 'renew' | 'evergreen',cancellation_cutoff_period?:number};
+       
+      /**
+        * @description Parameters for addons
+
+        */
+       
+      addons?:{billing_cycles?:number,id?:string,proration_type?:ProrationType,quantity?:number,quantity_in_decimal?:string,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string}[];
+       
+      /**
+        * @description Parameters for event_based_addons
+
+        */
+       
+      event_based_addons?:{charge_on?:ChargeOn,charge_once?:boolean,id?:string,on_event?:OnEvent,quantity?:number,quantity_in_decimal?:string,service_period_in_days?:number,unit_price?:number,unit_price_in_decimal?:string}[];
     }
     export interface UpdateForItemsResponse {  
        subscription:Subscription;
@@ -1653,7 +2696,7 @@ Applicable only when [Metered Billing](https://www.chargebee.com/docs/metered_bi
 
         */
        
-      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
+      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
        
       /**
         * @description Parameters for billing_address
@@ -1878,7 +2921,7 @@ When dunning (payment failure retry settings) is configured with the last retry
 
         */
        
-      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
+      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
     }
     export interface AddChargeAtTermEndResponse {  
        estimate:Estimate;
@@ -2660,7 +3703,7 @@ For non-renewing subscriptions,&#x60;resume_date&#x60; should be before the canc
 
         */
        
-      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
+      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_token?:string,id?:string,payment_method_type?:'giropay' | 'ideal' | 'sepa_instant_transfer' | 'google_pay' | 'netbanking_emandates' | 'klarna_pay_now' | 'dotpay' | 'boleto' | 'direct_debit' | 'faster_payments' | 'sofort' | 'upi' | 'venmo' | 'amazon_payments' | 'apple_pay' | 'bancontact' | 'paypal_express_checkout' | 'pay_to' | 'card',reference_id?:string};
     }
     export interface RemoveScheduledPauseResponse {  
        subscription:Subscription;