chargebee 2.40.0 → 3.0.0-beta.1

package/types/resources/QuotedSubscription.d.ts

@@ -1,499 +1,111 @@
 ///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+
 declare module 'chargebee' {
   export interface QuotedSubscription {
-    
-    /**
-      * @description A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
-
-      */
-    
-    id:string;
-    
-    /**
-      * @description Applicable only when &#x60;operation_type&#x60; of the quote is &#x60;create_subscription_for_customer&#x60;. For subscriptions in the &#x60;future&#x60; &#x60;status&#x60;, this is the date/time when the subscription is set to start. The quote can be converted on a date/time after this date. This is called backdating the subscription creation. Backdating is performed when the subscription has already been provisioned but the conversion action 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 subscription&#x27;s plan is 2 months and today is 14th April, the &#x60;start_date&#x60; cannot be earlier than 14th February.
-
-      */
-    
-    start_date?:number;
-    
-    /**
-      * @description End of the trial period for the subscription. Presence of this value for &#x27;future&#x27; subscription implies the subscription will go into &#x27;in_trial&#x27; state when it starts.
-
-      */
-    
-    trial_end?:number;
-    
-    /**
-      * @description * When the subscription is not on a contract term: this value is the number of billing cycles remaining after the current cycle, at the end of which, the subscription cancels.
-* When the subscription is on a [contract term](contract_terms): this value is the number of billing cycles remaining in the contract term after the current billing cycle.
-
-      */
-    
-    remaining_billing_cycles?:number;
-    
-    /**
-      * @description Purchase order number for this subscription.
-
-      */
-    
-    po_number?:string;
-    
-    /**
-      * @description The decimal representation of the quantity of the plan purchased. Returned for quantity-based plans when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units ) is enabled.
-
-      */
-    
-    plan_quantity_in_decimal?:string;
-    
-    /**
-      * @description The decimal representation of the price or per-unit price of the plan. The value is in major units of the currency. Always returned when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units ) is enabled.
-
-      */
-    
-    plan_unit_price_in_decimal?:string;
-    
-    /**
-      * @description Applicable only when &#x60;operation_type&#x60; of the quote is &#x60;change_subscription&#x60;. When &#x60;change_option&#x60; is set to &#x60;specific_date&#x60;, then this is the date/time at which the subscription change is scheduled to occur. The quote can be converted on a date/time after this date. This is called backdating the subscription change and performed when the subscription change has already been provisioned but the conversion action 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 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 subscription&#x27;s plan is 2 months and today is 14th April, &#x60;changes_scheduled_at&#x60; cannot be earlier than 14th February.
-
-      */
-    
-    changes_scheduled_at?:number;
-    
-    /**
-      * @description Applicable only when &#x60;operation_type&#x60; of the quote is &#x60;change_subscription&#x60;. 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 scheduled to be carried out at the end of the billing cycle of the subscription. \* specific_date - The change is carried out as of &#x60;changes_scheduled_at&#x60;. \* immediately - The change is carried out immediately upon quote conversion.
-
-      */
-    
-    change_option?:'end_of_term' | 'immediately' | 'specific_date';
-    
-    /**
-      * @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 List of coupons for this subscription
-
-      */
-    
-    coupons?:QuotedSubscription.Coupon[];
-    
-    /**
-      * @description List of discounts for this quoted subscription.
-
-      */
-    
-    discounts?:QuotedSubscription.Discount[];
-    
-    /**
-      * @description Details of individual [item prices](/docs/api/item_prices?prod_cat_ver&#x3D;2) that are part of this subscription
-
-      */
-    
-    subscription_items?:QuotedSubscription.SubscriptionItem[];
-    
-    /**
-      * @description List of item tier.
-
-      */
-    
-    item_tiers?:QuotedSubscription.ItemTier[];
-    
-    /**
-      * @description The details of the contract term to be created when this quote is invoiced.
-
-      */
-    
-    quoted_contract_term?:QuotedSubscription.QuotedContractTerm;
+    id: string;
+    plan_id: string;
+    plan_quantity: number;
+    plan_unit_price?: number;
+    setup_fee?: number;
+    billing_period?: number;
+    billing_period_unit?: 'day' | 'week' | 'month' | 'year';
+    start_date?: number;
+    trial_end?: number;
+    remaining_billing_cycles?: number;
+    po_number?: string;
+    auto_collection?: AutoCollection;
+    plan_quantity_in_decimal?: string;
+    plan_unit_price_in_decimal?: string;
+    changes_scheduled_at?: number;
+    change_option?: 'end_of_term' | 'specific_date' | 'immediately';
+    contract_term_billing_cycle_on_renewal?: number;
+    addons?: QuotedSubscription.Addon[];
+    event_based_addons?: QuotedSubscription.EventBasedAddon[];
+    coupons?: QuotedSubscription.Coupon[];
+    subscription_items?: QuotedSubscription.SubscriptionItem[];
+    item_tiers?: QuotedSubscription.ItemTier[];
+    quoted_contract_term?: QuotedSubscription.QuotedContractTerm;
   }
-  export namespace QuotedSubscription {
-    
-    
-    export interface Coupon {  
-         /**
-          * @description Used to uniquely identify the coupon
 
-          */
-       
-      coupon_id:string;
+  export namespace QuotedSubscription {
+    export interface Addon {
+      id: string;
+      quantity?: number;
+      unit_price?: number;
+      amount?: number;
+      trial_end?: number;
+      remaining_billing_cycles?: number;
+      quantity_in_decimal?: string;
+      unit_price_in_decimal?: string;
+      amount_in_decimal?: string;
+      proration_type?: 'full_term' | 'partial_term' | 'none';
     }
-    export interface Discount {  
-         /**
-          * @description An immutable unique id for the discount. It is always auto-generated.
-
-          */
-       
-      id:string;
-       
-         /**
-          * @description The name of the discount as it should appear on customer-facing pages and documents such as [invoices](/docs/api/invoices?prod_cat_ver&#x3D;2) and [hosted pages](/docs/api/hosted_pages?prod_cat_ver&#x3D;2). This is auto-generated based on the &#x60;type&#x60;, &#x60;amount&#x60;, and &#x60;currency_code&#x60; of the discount. For example, it can be &#x60;10% off&#x60; or &#x60;10$ off&#x60;.
-
-          */
-       
-      invoice_name?:string;
-       
-         /**
-          * @description The type of discount. Possible value are: \* fixed_amount - The specified amount will be given as discount. \* percentage - The specified percentage will be given as discount.
-
-          */
-       
-      type:'fixed_amount' | 'percentage';
-       
-         /**
-          * @description The percentage of the original amount that should be deducted from it. Only applicable when &#x60;discount.type&#x60; is percentage.
-
-          */
-       
-      percentage?:number;
-       
-         /**
-          * @description The value of the discount. [The format of this value](https://apidocs.chargebee.com/docs/api?prod_cat_ver&#x3D;2#currencies) depends on the kind of currency. This is only applicable when &#x60;discount.type&#x60; is &#x60;fixed_amount&#x60;.
-
-          */
-       
-      amount?:number;
-       
-         /**
-          * @description The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)) of the discount. This is only applicable when &#x60;discount.type&#x60; is &#x60;fixed_amount&#x60;.
-
-          */
-       
-      currency_code?:string;
-       
-         /**
-          * @description Specifies the time duration for which this discount is attached to the subscription. \* forever - The discount is attached to the subscription and applied on the invoices till it is [explicitly removed](/docs/api/subscriptions?prod_cat_ver&#x3D;2#update_subscription_for_items_discounts_operation_type). \* one_time - The discount stays attached to the subscription till it is applied on an invoice **once** . It is removed after that from the subscription. \* limited_period - The discount is attached to the subscription and applied on the invoices for a limited duration. This duration starts from the point it is applied to an invoice for the first time and expires after a period specified by &#x60;period&#x60; and &#x60;period_unit&#x60;.
-
-          */
-       
-      duration_type:'limited_period' | 'one_time' | 'forever';
-       
-         /**
-          * @description The duration of time for which the discount is attached to the subscription, in &#x60;period_units&#x60;. Applicable only when &#x60;duration_type&#x60; is &#x60;limited_period&#x60;.
-
-          */
-       
-      period?:number;
-       
-         /**
-          * @description The unit of time for &#x60;period&#x60;. Applicable only when &#x60;duration_type&#x60; is &#x60;limited_period&#x60;. \* day - A period of 24 hours. \* year - A period of 1 calendar year. \* week - A period of 7 days. \* month - A period of 1 calendar month.
-
-          */
-       
-      period_unit?:'week' | 'month' | 'year' | 'day';
-       
-         /**
-          * @description The discount is included in MRR calculations for your site. This attribute is only applicable when &#x60;duration_type&#x60; is &#x60;one_time&#x60; and when the [feature is enabled](https://www.chargebee.com/docs/reporting.html#dashboards_flexible-mrr-calculation) in Chargebee. Also, If the [site-level setting](https://www.chargebee.com/docs/reporting.html#chart_flexible-mrr-calculation) is to exclude one-time discounts from MRR calculations, this value is always returned &#x60;false&#x60;.
-
-          */
-       
-      included_in_mrr:boolean;
-       
-         /**
-          * @description The amount on the invoice to which the discount is applied. \* invoice_amount - The discount is applied to the invoice &#x60;sub_total&#x60;. \* specific_item_price - The discount is applied to the &#x60;invoice.line_item.amount&#x60; that corresponds to the item price specified by &#x60;item_price_id&#x60;.
-
-          */
-       
-      apply_on:'specific_item_price' | 'invoice_amount';
-       
-         /**
-          * @description The [id of the item price](/docs/api/subscriptions?prod_cat_ver&#x3D;2#subscription_subscription_items_item_price_id) in the subscription to which the discount is to be applied. Relevant only when &#x60;apply_on&#x60; &#x3D; &#x60;specific_item_price&#x60;.
-
-          */
-       
-      item_price_id?:string;
-       
-         /**
-          * @description Timestamp indicating when this discount is created.
-
-          */
-       
-      created_at:number;
-       
-         /**
-          * @description Specifies till when the limited period discount is applicable. This attribute will be sent in the response only for &#x60;limited_period&#x60; duration type discount.
-
-          */
-       
-      apply_till?:number;
-       
-         /**
-          * @description Specifies the number of times the discount has been applied.
-
-          */
-       
-      applied_count?:number;
-       
-         /**
-          * @description Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.  
-**Note:**
-
-
-When the coupon ID contains a special character; for example: &#x60;#&#x60;, the API returns an error.
-Make sure that you [encode](https://www.urlencoder.org/) the coupon ID in the path parameter before making an API call.
-
-          */
-       
-      coupon_id:string;
-       
-         /**
-          * @description The index number of the subscription to which the item price is added. Provide a unique number between &#x60;0&#x60; and &#x60;4&#x60; (inclusive) for each subscription that is to be created.
-
-          */
-       
-      index:number;
+    export interface EventBasedAddon {
+      id: string;
+      quantity: number;
+      unit_price: number;
+      service_period_in_days?: number;
+      on_event:
+        | 'subscription_creation'
+        | 'subscription_trial_start'
+        | 'plan_activation'
+        | 'subscription_activation'
+        | 'contract_termination';
+      charge_once: boolean;
+      quantity_in_decimal?: string;
+      unit_price_in_decimal?: string;
     }
-    export interface SubscriptionItem {  
-         /**
-          * @description The unique identifier of the item price.
-
-          */
-       
-      item_price_id:string;
-       
-         /**
-          * @description The type of item. There must be one and only one item of type &#x60;plan&#x60; in this list. \* plan - Plan \* addon - Addon \* charge - Charge
-
-          */
-       
-      item_type:'charge' | 'addon' | 'plan';
-       
-         /**
-          * @description The quantity of the item purchased
-
-          */
-       
-      quantity?:number;
-       
-         /**
-          * @description The decimal representation of the quantity of the item purchased. Can be provided for quantity-based item prices and only when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
-
-          */
-       
-      quantity_in_decimal?:string;
-       
-         /**
-          * @description The price/per unit price of the item. When not provided, [the value set](/docs/api/item_prices?prod_cat_ver&#x3D;2#item_price_attributes) for the item price is used. This is only applicable when the &#x60;pricing_model&#x60; of the item price is &#x60;flat_fee&#x60; or &#x60;per_unit&#x60;. Also, it is only allowed when [price overriding](https://www.chargebee.com/docs/price-override.html) is enabled for the site. The value depends on the type of currency. If &#x60;changes_scheduled_at&#x60; is in the past and a &#x60;unit_price&#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.
-
-          */
-       
-      unit_price?:number;
-       
-         /**
-          * @description The decimal representation of the price or per-unit price of the plan. The value is in major units of the currency. Always returned when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
-
-          */
-       
-      unit_price_in_decimal?:string;
-       
-         /**
-          * @description The total amount for the item as determined from &#x60;unit_price&#x60;, &#x60;free_quantity&#x60;, &#x60;quantity&#x60; and &#x60;item_tiers&#x60; as applicable. The value depends on the [type of currency](./#handling_currency_units).
-
-          */
-       
-      amount?:number;
-       
-         /**
-          * @description The decimal representation of the total amount for the item, in major units of the currency. Always returned when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
-
-          */
-       
-      amount_in_decimal?:string;
-       
-         /**
-          * @description The &#x60;free_quantity&#x60; of the plan-item as [specified](./item_prices?prod_cat_ver&#x3D;2) for the item price.
-
-          */
-       
-      free_quantity?:number;
-       
-         /**
-          * @description The &#x60;free_quantity_in_decimal&#x60; as set for the item price. Returned for quantity-based item prices when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
-
-          */
-       
-      free_quantity_in_decimal?:string;
-       
-         /**
-          * @description The date/time when the trial period of the item ends. Applies to plan-items and----when [enabled](https://www.chargebee.com/docs/2.0/addons-trial.html)----addon-items as well.
-
-          */
-       
-      trial_end?:number;
-       
-         /**
-          * @description For the plan-item price:  
-the value determines the number of billing cycles the subscription runs before canceling automatically. If not provided, then [the value set](./item_prices?prod_cat_ver&#x3D;2#item_price_attributes) for the plan-item price is used.  
-
-For addon-item prices:  
-If [addon billing cycles](https://www.chargebee.com/docs/2.0/addons-billingcycle.html) are enabled then this is the number of subscription billing cycles for which the addon is included. If not provided, then [the value set under attached addons](./attached_items?prod_cat_ver&#x3D;2#attached_item_attributes) is used. Further, if that value is not provided, then [the value set for the addon-item price](./item_prices?prod_cat_ver&#x3D;2#item_price_attributes) is used.
-
-          */
-       
-      billing_cycles?:number;
-       
-         /**
-          * @description The service period of the item in days from the day of charge.
-
-          */
-       
-      service_period_days?:number;
-       
-         /**
-          * @description When &#x60;charge_on_option&#x60; option is set to &#x60;on_event&#x60;, this parameter specifies the event at which the charge-item is applied to the subscription. This parameter only applies to charge-items. \* plan_activation - same as subscription activation, but also includes the case when the plan-item of the subscription is changed. \* subscription_activation - the moment a subscription enters an &#x60;active&#x60; or &#x60;non-renewing&#x60; state. Also includes reactivations of canceled subscriptions. \* contract_termination - when a contract term is [terminated](./subscriptions?prod_cat_ver&#x3D;2#cancel_subscription_for_items_contract_term_cancel_option). \* subscription_trial_start - the time when the trial period of the subscription begins. \* subscription_creation - the time of creation of the subscription.
-
-          */
-       
-      charge_on_event?:'subscription_creation' | 'subscription_activation' | 'subscription_trial_start' | 'contract_termination' | 'plan_activation';
-       
-         /**
-          * @description Indicates if the charge-item is to be charged only once or each time the &#x60;charge_on_event&#x60; occurs. This parameter only applies to charge-items.
-
-          */
-       
-      charge_once?:boolean;
-       
-         /**
-          * @description Indicates when the charge-item is to be charged. This parameter only applies to charge-items. \* on_event - The item is charged at the occurrence of the event specified as &#x60;charge_on_event&#x60;. \* immediately - The item is charged immediately on being added to the subscription.
-
-          */
-       
-      charge_on_option?:'on_event' | 'immediately';
-       
-         /**
-          * @description null
-
-          */
-       
-      proration_type?:'partial_term' | 'full_term' | 'none';
-      
-      billing_period?:number;
-       
-      billing_period_unit?:'day' | 'week' | 'month' | 'year';
+    export interface Coupon {
+      coupon_id: string;
     }
-    export interface ItemTier {  
-         /**
-          * @description The id of the item price to which this tier belongs.
-
-          */
-       
-      item_price_id:string;
-       
-         /**
-          * @description The lowest value in the quantity tier.
-
-          */
-       
-      starting_unit:number;
-       
-         /**
-          * @description The highest value in the quantity tier.
-
-          */
-       
-      ending_unit?:number;
-       
-         /**
-          * @description The per-unit price for the tier when the &#x60;pricing_model&#x60; is &#x60;tiered&#x60; or &#x60;volume&#x60;. The total cost for the item price when the &#x60;pricing_model&#x60; is &#x60;stairstep&#x60;. The value is in the minor unit of the currency.
-
-          */
-       
-      price:number;
-       
-         /**
-          * @description The decimal representation of the the lowest value of quantity in this tier. This is zero for the lowest tier. For all other tiers, it is the same as &#x60;ending_unit_in_decimal&#x60; of the next lower tier. Returned only when the pricing_model is &#x60;tiered&#x60;, &#x60;volume&#x60; or &#x60;stairstep&#x60; and [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
-
-          */
-       
-      starting_unit_in_decimal?:string;
-       
-         /**
-          * @description The decimal representation of the highest value of quantity in this tier. This attribute is not applicable for the highest tier. For all other tiers, it must be equal to the &#x60;starting_unit_in_decimal&#x60; of the next higher tier. Returned only when the pricing_model is &#x60;tiered&#x60;, &#x60;volume&#x60; or &#x60;stairstep&#x60; and [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
-
-          */
-       
-      ending_unit_in_decimal?:string;
-       
-         /**
-          * @description The decimal representation of the per-unit price for the tier when the &#x60;pricing_model&#x60; is &#x60;tiered&#x60; or &#x60;volume&#x60;. When the &#x60;pricing_model&#x60; is &#x60;stairstep&#x60;, it is the decimal representation of the total price for the item. The value is in major units of the currency. Returned when the plan is quantity-based and [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
-
-          */
-       
-      price_in_decimal?:string;
-       
-         /**
-          * @description The index number of the subscription to which the item price is added. Provide a unique number between &#x60;0&#x60; and &#x60;4&#x60; (inclusive) for each subscription that is to be created.
-
-          */
-       
-      index:number;
+    export interface SubscriptionItem {
+      item_price_id: string;
+      item_type: 'plan' | 'addon' | 'charge';
+      quantity?: number;
+      quantity_in_decimal?: string;
+      metered_quantity?: string;
+      last_calculated_at?: number;
+      unit_price?: number;
+      unit_price_in_decimal?: string;
+      amount?: number;
+      amount_in_decimal?: string;
+      billing_period?: number;
+      billing_period_unit?: 'day' | 'week' | 'month' | 'year';
+      free_quantity?: number;
+      free_quantity_in_decimal?: string;
+      trial_end?: number;
+      billing_cycles?: number;
+      service_period_days?: number;
+      charge_on_event?:
+        | 'subscription_creation'
+        | 'subscription_trial_start'
+        | 'plan_activation'
+        | 'subscription_activation'
+        | 'contract_termination';
+      charge_once?: boolean;
+      charge_on_option?: 'immediately' | 'on_event';
+      proration_type?: 'full_term' | 'partial_term' | 'none';
     }
-    export interface QuotedContractTerm {  
-         /**
-          * @description The start date of the contract term
-
-          */
-       
-      contract_start:number;
-       
-         /**
-          * @description The end date of the contract term
-
-          */
-       
-      contract_end:number;
-       
-         /**
-          * @description The number of billing cycles of the subscription that the contract term is for.
-
-          */
-       
-      billing_cycle:number;
-       
-         /**
-          * @description Action to be taken when the contract term completes. \* renew -
-* Contract term completes and a new contract term is started for the number of billing cycles specified in [&#x60;contract_billing_cycle_on_renewal&#x60;](subscriptions#create_subscription_for_customer_contract_term_billing_cycle_on_renewal).
-* The &#x60;action_at_term_end&#x60; for the new contract term is set to &#x60;renew&#x60;.
-\* renew_once - Used when you want to renew the contract term just once. Does the following:
-* Contract term completes and a new contract term is started for the number of billing cycles specified in [&#x60;contract_billing_cycle_on_renewal&#x60;](subscriptions#create_subscription_for_customer_contract_term_billing_cycle_on_renewal).
-* The &#x60;action_at_term_end&#x60; for the new contract term is set to &#x60;cancel&#x60;.
-\* cancel - Contract term completes and subscription is canceled. \* evergreen - Contract term completes and the subscription renews.
-
-
-          */
-       
-      action_at_term_end:'cancel' | 'renew_once' | 'renew' | 'evergreen';
-       
-         /**
-          * @description The sum of the [totals](invoices#invoice_total) of all the invoices raised as part of the contract term. For &#x60;active&#x60; contract terms, this is a predicted value. The value depends on the [type of currency](./#handling_currency_units). If the subscription was [imported](#import_a_subscription) with the contract term, then this value includes the value passed for &#x60;total_amount_raised&#x60;.
-
-          */
-       
-      total_contract_value:number;
-       
-         /**
-          * @description The number of days before [&#x60;contract_end&#x60;](contract_terms#contract_term_contract_end), during which the customer is barred from canceling the contract term. The customer is allowed to cancel the contract term via the Self-Serve Portal only before this period. This allows you to have sufficient time for processing the contract term closure
-
-          */
-       
-      cancellation_cutoff_period?:number;
+    export interface ItemTier {
+      item_price_id: string;
+      starting_unit: number;
+      ending_unit?: number;
+      price: number;
+      starting_unit_in_decimal?: string;
+      ending_unit_in_decimal?: string;
+      price_in_decimal?: string;
+      index: number;
+    }
+    export interface QuotedContractTerm {
+      contract_start: number;
+      contract_end: number;
+      billing_cycle: number;
+      action_at_term_end: 'renew' | 'evergreen' | 'cancel' | 'renew_once';
+      total_contract_value: number;
+      cancellation_cutoff_period?: number;
     }
+    // REQUEST PARAMS
+    //---------------
   }
-}
+}