chargebee 2.26.0 → 2.27.0

package/types/resources/DifferentialPrice.d.ts

@@ -1,83 +1,314 @@
 ///<reference path='./../core.d.ts'/>
 declare module 'chargebee' {
   export interface DifferentialPrice {
+    
+    /**
+      * @description A unique and immutable ID for the differential price. It is auto-generated when the differential price is created.
+
+      */
+    
     id:string;
+    
+    /**
+      * @description The ID of the item price (&#x60;addon&#x60; or &#x60;charge&#x60;) whose price should change according to the plan-item it is applied to.
+
+      */
+    
     item_price_id:string;
+    
+    /**
+      * @description The ID of the plan-item, in relation to which, the differential pricing for the addon or charge is defined. For example, this would be the id of the *Standard* or *Enterprise* plans-items mentioned in the [examples above](./differential_prices?prod_cat_ver&#x3D;2).
+
+      */
+    
     parent_item_id:string;
+    
+    /**
+      * @description The differential price. If the pricing model of the &#x60;item_price_id&#x60; is &#x60;tiered&#x60;, &#x60;volume&#x60;, or &#x60;stairstep&#x60;, pass &#x60;tiers&#x60; instead of this.
+
+      */
+    
     price?:number;
+    
+    /**
+      * @description The price of the item when the pricing_model is &#x60;flat_fee&#x60;. When the pricing model is &#x60;per_unit&#x60;, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
+
+      */
+    
     price_in_decimal?:string;
+    
+    /**
+      * @description The item family state. \* active - New items can be created with the item family. \* deleted - No items allowed for the item family.
+
+      */
+    
     status?:'deleted' | 'active';
+    
+    /**
+      * @description Version number of this resource. The &#x60;resource_version&#x60; is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
+
+      */
+    
     resource_version?:number;
+    
+    /**
+      * @description Timestamp when this differential price was last updated.
+
+      */
+    
     updated_at?:number;
+    
+    /**
+      * @description Timestamp at which this differential price was created.
+
+      */
+    
     created_at:number;
+    
+    /**
+      * @description Timestamp at which this differential price was last modified.
+
+      */
+    
     modified_at:number;
+    
+    /**
+      * @description The currency code (ISO 4217 format) of the plan
+
+      */
+    
     currency_code:string;
+    
+    /**
+      * @description List of quantity-based pricing tiers for the differential price. Applicable only for &#x60;tiered&#x60;, &#x60;volume&#x60;, and &#x60;stairstep&#x60; &#x60;pricing_model&#x60; s. The tiers are exactly the same as those set for the item price. Only the &#x60;price&#x60; attribute for the various tiers can be overridden for the differential price.
+
+      */
+    
     tiers?:DifferentialPrice.Tier[];
+    
+    /**
+      * @description When &#x60;item_price_id&#x60; is a charge-item, you can specify the plan period for which the price applies. Although an array, currently you can specify only one period. In other words, only index &#x60;0&#x60; is allowed. Create another differential price to specify another period. Is permitted only when &#x60;item_price_id&#x60; is a charge-item.
+
+      */
+    
     parent_periods?:DifferentialPrice.ParentPeriod[];
   }
   export namespace DifferentialPrice {
-    export class DifferentialPriceResource {
+    export class DifferentialPriceResource {  
+      /**
+        * @description Delete a differential price using a &#x60;differential_price_id&#x60; and &#x60;item_price_id&#x60;.
+
+        */
+      
       delete(differential_price_id:string, input:DeleteInputParam):ChargebeeRequest<DeleteResponse>;
+       
+      /**
+        * @description Create a differential price for addon item price, addon item price with tiered pricing, or charge item price.
+
+        */
+      
       create(item_price_id:string, input:CreateInputParam):ChargebeeRequest<CreateResponse>;
+       
+      /**
+        * @description Returns a list of differential prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
+
+        */
+      
       list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+       
+      /**
+        * @description Retrieve a differential price using a &#x60;differential_price_id&#x60; and &#x60;item_price_id&#x60;.
+
+        */
+      
       retrieve(differential_price_id:string, input:RetrieveInputParam):ChargebeeRequest<RetrieveResponse>;
+       
+      /**
+        * @description Update a differential price using a &#x60;differential_price_id&#x60; and &#x60;item_price_id&#x60;.
+
+        */
+      
       update(differential_price_id:string, input:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
     }
-    export interface DeleteResponse {
-      differential_price:DifferentialPrice;
+    export interface DeleteResponse {  
+       differential_price:DifferentialPrice;
     }
     export interface DeleteInputParam {
+       
+      /**
+        * @description The id of the item price (&#x60;addon&#x60; or &#x60;charge&#x60;) whose price should change according to the plan-item it is applied to.
+
+        */
+       
       item_price_id:string;
     }
-    export interface CreateResponse {
-      differential_price:DifferentialPrice;
+    export interface CreateResponse {  
+       differential_price:DifferentialPrice;
     }
     export interface CreateInputParam {
+       
+      /**
+        * @description The id of the plan-item, in relation to which, the differential pricing for the addon or charge is defined. For example, this would be the id of the *Standard* or *Enterprise* plans-items mentioned in the [examples above](./differential_prices?prod_cat_ver&#x3D;2).
+
+        */
+       
       parent_item_id:string;
+       
+      /**
+        * @description The differential price. If the pricing model of the &#x60;item_price_id&#x60; is &#x60;tiered&#x60;, &#x60;volume&#x60;, or &#x60;stairstep&#x60;, pass &#x60;tiers&#x60; instead of this.
+
+        */
+       
       price?:number;
+       
+      /**
+        * @description The price of the item when the pricing_model is &#x60;flat_fee&#x60;. When the pricing model is &#x60;per_unit&#x60;, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
+
+        */
+       
       price_in_decimal?:string;
+       
+      /**
+        * @description Parameters for parent_periods
+
+        */
+       
       parent_periods?:{period?:any[],period_unit:'week' | 'month' | 'year' | 'day'}[];
+       
+      /**
+        * @description Parameters for tiers
+
+        */
+       
       tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
     }
-    export interface ListResponse {
-      list:{differential_price:DifferentialPrice}[];
-      next_offset?:string;
+    export interface ListResponse {  
+      /**
+        * @description Returns a list of differential prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
+
+        */
+       
+       list:{differential_price:DifferentialPrice}[];
+       
+      /**
+        * @description Returns a list of differential prices satisfying **all** the conditions specified in the filter parameters below. The list is sorted by the date of creation in descending order (latest first).
+
+        */
+       
+       next_offset?:string;
     }
     export interface ListInputParam {
-      [key : string]: any;
+      [key : string]: any;  
+      /**
+        * @description The number of resources to be returned.
+
+        */
+        
       limit?:number;
+       
+      /**
+        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
+
+        */
+        
       offset?:string;
+       
+      /**
+        * @description The id of the item price (&#x60;addon&#x60; or &#x60;charge&#x60;) whose price should change according to the plan-item it is applied to.
+
+        */
+        
       item_price_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      /**
+        * @description Item Id of Addon / Charge item price for which differential pricing is applied to
+
+        */
+        
       item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      /**
+        * @description A unique and immutable id for the differential price. It is auto-generated when the differential price is created.
+
+        */
+        
       id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      /**
+        * @description The id of the plan-item, in relation to which, the differential pricing for the addon or charge is defined. For example, this would be the id of the *Standard* or *Enterprise* plans-items mentioned in the [examples above](./differential_prices?prod_cat_ver&#x3D;2).
+
+        */
+        
       parent_item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
     }
-    export interface RetrieveResponse {
-      differential_price:DifferentialPrice;
+    export interface RetrieveResponse {  
+       differential_price:DifferentialPrice;
     }
     export interface RetrieveInputParam {
+       
+      /**
+        * @description Retrieve a differential price using a &#x60;differential_price_id&#x60; and &#x60;item_price_id&#x60;.
+
+        */
+        
       item_price_id:string;
     }
-    export interface UpdateResponse {
-      differential_price:DifferentialPrice;
+    export interface UpdateResponse {  
+       differential_price:DifferentialPrice;
     }
     export interface UpdateInputParam {
+       
+      /**
+        * @description The id of the item price (&#x60;addon&#x60; or &#x60;charge&#x60;) whose price should change according to the plan-item it is applied to.
+
+        */
+       
       item_price_id:string;
+       
+      /**
+        * @description The differential price. If the pricing model of the &#x60;item_price_id&#x60; is &#x60;tiered&#x60;, &#x60;volume&#x60;, or &#x60;stairstep&#x60;, pass &#x60;tiers&#x60; instead of this.
+
+        */
+       
       price?:number;
+       
+      /**
+        * @description The price of the item when the pricing_model is &#x60;flat_fee&#x60;. When the pricing model is &#x60;per_unit&#x60;, it is the price per unit quantity of the item. Not applicable for the other pricing models. The value is in decimal and in major units of the currency. Also, this is only applicable when [multi-decimal pricing](https://apidocs.chargebee.com/docs/api#handling_currency_units) is enabled.
+
+        */
+       
       price_in_decimal?:string;
+       
+      /**
+        * @description Parameters for parent_periods
+
+        */
+       
       parent_periods?:{period?:any[],period_unit:'week' | 'month' | 'year' | 'day'}[];
+       
+      /**
+        * @description Parameters for tiers
+
+        */
+       
       tiers?:{ending_unit?:number,ending_unit_in_decimal?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
     }
-    export interface Tier {
+    export interface Tier {  
       starting_unit?:number;
+       
       ending_unit?:number;
+       
       price?:number;
+       
       starting_unit_in_decimal?:string;
+       
       ending_unit_in_decimal?:string;
+       
       price_in_decimal?:string;
     }
-    export interface ParentPeriod {
+    export interface ParentPeriod {  
       period_unit?:'week' | 'month' | 'year' | 'day';
+       
       period?:any[];
     }
   }

package/types/resources/Discount.d.ts

@@ -1,22 +1,129 @@
 ///<reference path='./../core.d.ts'/>
 declare module 'chargebee' {
   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: \* percentage - The specified percentage will be given as discount. \* fixed_amount - The specified amount 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). \* 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;. \* 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.
+
+      */
+    
     duration_type:DurationType;
+    
+    /**
+      * @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;. \* year - A period of 1 calendar year. \* month - A period of 1 calendar month. \* week - A period of 7 days. \* day - A period of 24 hours.
+
+      */
+    
     period_unit?:PeriodUnit;
+    
+    /**
+      * @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:ApplyOn;
+    
+    /**
+      * @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;
   }
 }

package/types/resources/Download.d.ts

@@ -1,8 +1,26 @@
 ///<reference path='./../core.d.ts'/>
 declare module 'chargebee' {
   export interface Download {
+    
+    /**
+      * @description The URL at which the file is available for download.
+
+      */
+    
     download_url:string;
+    
+    /**
+      * @description The time until which the &#x60;download_url&#x60; is valid.
+
+      */
+    
     valid_till:number;
+    
+    /**
+      * @description The [media type](https://en.wikipedia.org/wiki/Media_type) of the file.
+
+      */
+    
     mime_type?:string;
   }
 }

package/types/resources/EntitlementOverride.d.ts

@@ -1,34 +1,128 @@
 ///<reference path='./../core.d.ts'/>
 declare module 'chargebee' {
   export interface EntitlementOverride {
+    
+    /**
+      * @description Unique identifier for the entitlement override. This is always auto-generated.
+
+      */
+    
     id:string;
+    
+    /**
+      * @description The &#x60;id&#x60; of the subscription to which this entitlement override belongs.
+
+      */
+    
     entity_id?:string;
+    
+    /**
+      * @description The name of Chargebee resource that this entitlement override is associated with. The value is always &#x60;subscription&#x60;.
+
+      */
+    
     entity_type?:string;
+    
+    /**
+      * @description The &#x60;id&#x60; of the &#x60;feature&#x60; towards which this entitlement override has been granted.
+
+      */
+    
     feature_id?:string;
+    
+    /**
+      * @description The &#x60;name&#x60; of the &#x60;feature&#x60; towards which this entitlement override has been granted.
+
+      */
+    
     feature_name?:string;
+    
+    /**
+      * @description The level of entitlement that the item has towards the feature. The possible values depend on the value of &#x60;feature.type&#x60;:
+
+* When &#x60;feature.type&#x60; is &#x60;quantity&#x60; and:
+  * If &#x60;feature.levels[is_unlimited]&#x60; is not &#x60;true&#x60; for any one of &#x60;feature.levels[]&#x60;, then the value can be any one of &#x60;feature.levels[value][]&#x60;.
+  * If &#x60;feature.levels[is_unlimited]&#x60; is &#x60;true&#x60; for one of the &#x60;feature.levels[]&#x60;, then the value can also be:
+    * any one of &#x60;feature.levels[value][]&#x60;
+    * or it can be &#x60;unlimited&#x60; (case-insensitive), indicating unlimited entitlement.
+* When &#x60;type&#x60; is &#x60;range&#x60; and:
+  * If &#x60;feature.levels[is_unlimited]&#x60; is not &#x60;true&#x60; for any one of &#x60;feature.levels[]&#x60;, then the value can be any whole number between &#x60;levels[value][0]&#x60; and &#x60;levels[value][1]&#x60; (inclusive).
+  * If &#x60;feature.levels[is_unlimited]&#x60; is &#x60;true&#x60; for one of the &#x60;feature.levels[]&#x60;, then the value can be:
+    * any whole number equal to or greater than &#x60;levels[value][0]&#x60;
+    * or it can be &#x60;unlimited&#x60; (case-insensitive), indicating unlimited entitlement.
+* When &#x60;type&#x60; is &#x60;custom&#x60;, then the value can be any one of &#x60;feature.levels[value][]&#x60;.
+* When &#x60;type&#x60; is &#x60;switch&#x60;, then the value is set as &#x60;true&#x60; if the feature is available; it is set as &#x60;false&#x60; when the feature is unavailable.
+
+      */
+    
     value?:string;
+    
+    /**
+      * @description The display name for the entitlement level. The default values are auto-generated based on &#x60;feature.type&#x60; as follows:
+
+* When &#x60;feature.type&#x60; is &#x60;quantity&#x60; or &#x60;range&#x60;, then &#x60;name&#x60; is the space-separated concatenation of &#x60;value&#x60; and the pluralized version of &#x60;feature.unit&#x60;. For example, if &#x60;value&#x60; is &#x60;20&#x60; and &#x60;feature.unit&#x60; is &#x60;user&#x60;, then &#x60;name&#x60; becomes &#x60;20 users&#x60;.
+* When &#x60;feature.type&#x60; is &#x60;custom&#x60;, then &#x60;name&#x60; is the same as &#x60;value&#x60;
+
+      */
+    
     name?:string;
+    
+    /**
+      * @description The expiry date for the &#x60;entitlement_override&#x60;. Once expired, the &#x60;entitlement_override&#x60; object is no longer returned.
+
+      */
+    
     expires_at?:number;
   }
   export namespace EntitlementOverride {
-    export class EntitlementOverrideResource {
+    export class EntitlementOverrideResource {  
+      /**
+        * @description Retrieve the list of entitlement overrides for a subscription.
+
+        */
+      
       list_entitlement_override_for_subscription(subscription_id:string, input?:ListEntitlementOverrideForSubscriptionInputParam):ChargebeeRequest<ListEntitlementOverrideForSubscriptionResponse>;
+       
       add_entitlement_override_for_subscription(subscription_id:string, input?:AddEntitlementOverrideForSubscriptionInputParam):ChargebeeRequest<AddEntitlementOverrideForSubscriptionResponse>;
     }
-    export interface ListEntitlementOverrideForSubscriptionResponse {
-      list:{entitlement_override:EntitlementOverride}[];
-      next_offset?:string;
+    export interface ListEntitlementOverrideForSubscriptionResponse {  
+      /**
+        * @description Retrieve the list of entitlement overrides for a subscription.
+
+        */
+       
+       list:{entitlement_override:EntitlementOverride}[];
+       
+      /**
+        * @description Retrieve the list of entitlement overrides for a subscription.
+
+        */
+       
+       next_offset?:string;
     }
     export interface ListEntitlementOverrideForSubscriptionInputParam {
-      [key : string]: any;
+      [key : string]: any;  
+      /**
+        * @description The number of resources to be returned.
+
+        */
+        
       limit?:number;
+       
+      /**
+        * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
+
+        */
+        
       offset?:string;
     }
-    export interface AddEntitlementOverrideForSubscriptionResponse {
-      entitlement_override:EntitlementOverride;
+    export interface AddEntitlementOverrideForSubscriptionResponse {  
+       entitlement_override:EntitlementOverride;
     }
     export interface AddEntitlementOverrideForSubscriptionInputParam {
+       
       action?:Action;
+       
       entitlement_overrides?:{expires_at?:number,feature_id:string,value?:string}[];
     }