chargebee 2.28.0 → 2.29.0

package/types/resources/DifferentialPrice.d.ts

@@ -96,63 +96,103 @@ declare module 'chargebee' {
   export namespace DifferentialPrice {
     export class DifferentialPriceResource {  
       /**
-        * @description Delete a differential price using a `differential_price_id` and `item_price_id`.
+        * @description Create a differential price for addon item price, addon item price with tiered pricing, or charge item price.
 
         */
       
-      delete(differential_price_id:string, input:DeleteInputParam):ChargebeeRequest<DeleteResponse>;
+      create(item_price_id:string, input:CreateInputParam):ChargebeeRequest<CreateResponse>;
        
       /**
-        * @description Create a differential price for addon item price, addon item price with tiered pricing, or charge item price.
+        * @description Retrieve a differential price using a &#x60;differential_price_id&#x60; and &#x60;item_price_id&#x60;.
 
         */
       
-      create(item_price_id:string, input:CreateInputParam):ChargebeeRequest<CreateResponse>;
+      retrieve(differential_price_id:string, input:RetrieveInputParam):ChargebeeRequest<RetrieveResponse>;
        
       /**
-        * @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).
+        * @description Update a differential price using a &#x60;differential_price_id&#x60; and &#x60;item_price_id&#x60;.
 
         */
       
-      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+      update(differential_price_id:string, input:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
        
       /**
-        * @description Retrieve a differential price using a &#x60;differential_price_id&#x60; and &#x60;item_price_id&#x60;.
+        * @description Delete 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>;
+      delete(differential_price_id:string, input:DeleteInputParam):ChargebeeRequest<DeleteResponse>;
        
       /**
-        * @description Update a differential price using a &#x60;differential_price_id&#x60; and &#x60;item_price_id&#x60;.
+        * @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).
 
         */
       
-      update(differential_price_id:string, input:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
+      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
     }
-    export interface DeleteResponse {  
+    export interface CreateResponse {  
        differential_price:DifferentialPrice;
     }
-    export interface DeleteInputParam {
+    export interface CreateInputParam {
        
       /**
-        * @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.
+        * @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 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 CreateResponse {  
+    export interface UpdateResponse {  
        differential_price:DifferentialPrice;
     }
-    export interface CreateInputParam {
+    export interface UpdateInputParam {
        
       /**
-        * @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).
+        * @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.
 
         */
        
-      parent_item_id:string;
+      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.
@@ -182,6 +222,18 @@ declare module 'chargebee' {
        
       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 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 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).
@@ -200,105 +252,68 @@ declare module 'chargebee' {
     export interface ListInputParam {
       [key : string]: any;  
       /**
-        * @description The number of resources to be returned.
+        * @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).
 
         */
         
       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.
+        * @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).
 
         */
         
       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.
+        * @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).
 
         */
         
       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
+        * @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).
 
         */
         
       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.
+        * @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).
 
         */
         
       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).
+        * @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).
 
         */
         
       parent_item_id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
     }
-    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 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.
+    export interface Tier {  
+         /**
+          * @description The lower limit of a range of units for the tier
 
-        */
+          */
        
-      item_price_id:string;
+      starting_unit:number;
        
-      /**
-        * @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.
+         /**
+          * @description The upper limit of a range of units for the tier
 
-        */
+          */
        
-      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'}[];
+      ending_unit?:number;
        
-      /**
-        * @description Parameters for tiers
+         /**
+          * @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](https://apidocs.chargebee.com/docs/api#handling_currency_units).
 
-        */
-       
-      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 {  
-      starting_unit?:number;
+          */
        
-      ending_unit?:number;
-       
-      price?:number;
+      price:number;
        
       starting_unit_in_decimal?:string;
        
@@ -307,7 +322,17 @@ declare module 'chargebee' {
       price_in_decimal?:string;
     }
     export interface ParentPeriod {  
-      period_unit?:'week' | 'month' | 'year' | 'day';
+         /**
+          * @description The unit of time for &#x60;period&#x60;. \* month - A period of 1 calendar month. \* day - A period of 24 hours. \* week - A period of 7 days. \* year - A period of 1 calendar year.
+
+          */
+       
+      period_unit:'week' | 'month' | 'year' | 'day';
+       
+         /**
+          * @description The billing period of the plan in &#x60;period_unit&#x60;s. For example, a 6 month plan has &#x60;period&#x60; as 6 and &#x60;period_unit&#x60; as &#x60;month&#x60;.
+
+          */
        
       period?:any[];
     }

package/types/resources/EntitlementOverride.d.ts

@@ -76,14 +76,38 @@ declare module 'chargebee' {
   }
   export namespace EntitlementOverride {
     export class EntitlementOverrideResource {  
+      /**
+        * @description Upserts or removes a set of `entitlement_overrides` for a `subscription` depending on the `action` specified. The API returns the upserted or deleted `entitlement_overrides` after successfully completing the operation. The operation returns an error when the first `entitlement_override` fails to be processed. Either all the `entitlement_overrides` provided in the request are processed or none.
+
+        */
+      
+      add_entitlement_override_for_subscription(subscription_id:string, input?:AddEntitlementOverrideForSubscriptionInputParam):ChargebeeRequest<AddEntitlementOverrideForSubscriptionResponse>;
+       
       /**
         * @description Retrieve the list of entitlement overrides for a subscription.
 
         */
       
       list_entitlement_override_for_subscription(subscription_id:string, input?:ListEntitlementOverrideForSubscriptionInputParam):ChargebeeRequest<ListEntitlementOverrideForSubscriptionResponse>;
+    }
+    export interface AddEntitlementOverrideForSubscriptionResponse {  
+       entitlement_override:EntitlementOverride;
+    }
+    export interface AddEntitlementOverrideForSubscriptionInputParam {
        
-      add_entitlement_override_for_subscription(subscription_id:string, input?:AddEntitlementOverrideForSubscriptionInputParam):ChargebeeRequest<AddEntitlementOverrideForSubscriptionResponse>;
+      /**
+        * @description The specific action to be performed for each &#x60;entitlement_override&#x60; specified. . \* remove - Deletes the &#x60;entitlement_override&#x60; for the &#x60;feature_id&#x60; and &#x60;item_id&#x60; combination, if it exists. \* upsert - If the &#x60;entitlement_override&#x60; already exists for the &#x60;feature_id&#x60; and &#x60;{subscription_id}&#x60; combination, the &#x60;value&#x60; of the &#x60;entitlement_override&#x60; is updated. If it doesn&#x27;t exist, a new &#x60;entitlement_override&#x60; is created.
+
+        */
+       
+      action?:Action;
+       
+      /**
+        * @description Parameters for entitlement_overrides
+
+        */
+       
+      entitlement_overrides?:{expires_at?:number,feature_id:string,value?:string}[];
     }
     export interface ListEntitlementOverrideForSubscriptionResponse {  
       /**
@@ -103,28 +127,19 @@ declare module 'chargebee' {
     export interface ListEntitlementOverrideForSubscriptionInputParam {
       [key : string]: any;  
       /**
-        * @description The number of resources to be returned.
+        * @description Retrieve the list of entitlement overrides for a subscription.
 
         */
         
       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.
+        * @description Retrieve the list of entitlement overrides for a subscription.
 
         */
         
       offset?:string;
     }
-    export interface AddEntitlementOverrideForSubscriptionResponse {  
-       entitlement_override:EntitlementOverride;
-    }
-    export interface AddEntitlementOverrideForSubscriptionInputParam {
-       
-      action?:Action;
-       
-      entitlement_overrides?:{expires_at?:number,feature_id:string,value?:string}[];
-    }
     
   }
 }