chargebee 2.45.0 → 2.47.0

package/types/resources/PriceVariant.d.ts

@@ -3,115 +3,44 @@
 declare module 'chargebee' {
   export interface PriceVariant {
     
-    /**
-      * @description The unique and immutable identifier of the price variant.
 
-      */
-    
     id:string;
-    
-    /**
-      * @description A unique name of the price variant.
 
-      */
-    
     name:string;
-    
-    /**
-      * @description A unique display name for the price variant.
 
-      */
-    
     external_name?:string;
-    
-    /**
-      * @description Description of the price variant.
 
-      */
     variant_group?:string;
+
     description?:string;
-    
-    /**
-      * @description Status of a price variant. \* active - Active price variant. This price variant can be attached to [item prices](https://apidocs.chargebee.com/docs/api/item_prices?lang=curl). \* deleted - Deleted price variant. The `id` and `name` of the deleted price variant can be reused. \* archived - Archived price variant. This price variant is no longer `active` and cannot be attached to new [item prices](https://apidocs.chargebee.com/docs/api/item_prices?lang=curl). Existing item prices that already have this price variant attached will continue to remain as is.
 
-      */
-    
     status?:'active' | 'archived' | 'deleted';
-    
-    /**
-      * @description Timestamp indicating when this price variant is created.
 
-      */
-    
     created_at:number;
-    
-    /**
-      * @description The version number of this resource. For every change made to the resource, `resource_version` is updated with a new timestamp in milliseconds.
 
-      */
-    
     resource_version?:number;
-    
-    /**
-      * @description Timestamp indicating when this price variant was last updated.
 
-      */
-    
     updated_at?:number;
-    
-    /**
-      * @description Timestamp indicating when this price variant was archived.
 
-      */
-    
     archived_at?:number;
-    
-    /**
-      * @description The list of price variant attribute values.
-
-Attributes can be used to store additional information about the price variant. For example, for a price variant called 'Germany', the attributes can be 'Country':'Germany', 'City':'Berlin' and so on.
 
-      */
-    
     attributes?:PriceVariant.Attribute[];
 
     business_entity_id?:string;
+
+    deleted:boolean;
+
   }
   export namespace PriceVariant {
     export class PriceVariantResource {  
-      /**
-        * @description This endpoint allows the creation of a new price variant that can be attached to [item prices](https://apidocs.chargebee.com/docs/api/item_prices?lang=curl).
-
-        */
-      
       create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
        
-      /**
-        * @description This endpoint retrieves the details of a specific price variant using its unique identifier.
-
-        */
-      
       retrieve(price_variant_id:string):ChargebeeRequest<RetrieveResponse>;
        
-      /**
-        * @description This endpoint modifies the details of an existing price variant.
-
-        */
-      
       update(price_variant_id:string, input:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
        
-      /**
-        * @description Deletes the price variant. This is not allowed if price variant is attached to any [item price](https://apidocs.chargebee.com/docs/api/item_prices?lang&#x3D;curl). Once deleted, the &#x60;id&#x60; and &#x60;name&#x60; of the price variant can be reused.
-
-        */
-      
       delete(price_variant_id:string):ChargebeeRequest<DeleteResponse>;
        
-      /**
-        * @description This endpoint is used to retrieve a list of price variants.
-
-        */
-      
       list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
     }
     export interface CreateResponse {  
@@ -119,45 +48,18 @@ Attributes can be used to store additional information about the price variant.
     }
     export interface CreateInputParam {
        
-      /**
-        * @description The unique and immutable identifier of the price variant.
-
-        */
+      attributes:{name:string,value:string}[];
        
       id:string;
        
-      /**
-        * @description A unique name of the price variant.
-
-        */
-       
       name:string;
        
-      /**
-        * @description A unique display name for the price variant.
-
-        */
-       
       external_name?:string;
        
-      /**
-        * @description Description of the price variant.
-
-        */
-       
       description?:string;
        
-      /**
-        * @description The list of price variant attribute values.
-
-Attributes can be used to store additional information about the price variant. For example, for a price variant called &#x27;Germany&#x27;, the attributes can be &#x27;Country&#x27;:&#x27;Germany&#x27;, &#x27;City&#x27;:&#x27;Berlin&#x27; and so on.
-
-        */
-       
-      attributes:{name:string,value:string}[];
-
       variant_group?:string;
-
+       
       business_entity_id?:string;
     }
     export interface RetrieveResponse {  
@@ -169,137 +71,96 @@ Attributes can be used to store additional information about the price variant.
     }
     export interface UpdateInputParam {
        
-      /**
-        * @description A unique name of the price variant.
-
-        */
+      attributes:{name:string,value:string}[];
        
       name?:string;
        
-      /**
-        * @description A unique display name for the price variant.
-
-        */
-       
       external_name?:string;
        
-      /**
-        * @description Description of the price variant.
-
-        */
-       
       description?:string;
-
-      variant_group?:string;
        
-      /**
-        * @description Status of a price variant. \* active - Active price variant. This price variant can be attached to [item prices](https://apidocs.chargebee.com/docs/api/item_prices?lang&#x3D;curl). \* deleted - Deleted price variant. The &#x60;id&#x60; and &#x60;name&#x60; of the deleted price variant can be reused. \* archived - Archived price variant. This price variant is no longer &#x60;active&#x60; and cannot be attached to new [item prices](https://apidocs.chargebee.com/docs/api/item_prices?lang&#x3D;curl). Existing item prices that already have this price variant attached will continue to remain as is.
-
-        */
+      variant_group?:string;
        
       status?:'active' | 'archived';
-       
-      /**
-        * @description The list of price variant attribute values.
-
-Attributes can be used to store additional information about the price variant. For example, for a price variant called &#x27;Germany&#x27;, the attributes can be &#x27;Country&#x27;:&#x27;Germany&#x27;, &#x27;City&#x27;:&#x27;Berlin&#x27; and so on.
-
-        */
-       
-      attributes:{name:string,value:string}[];
     }
     export interface DeleteResponse {  
        price_variant:PriceVariant;
     }
     
     export interface ListResponse {  
-      /**
-        * @description This endpoint is used to retrieve a list of price variants.
-
-        */
-       
        list:{price_variant:PriceVariant}[];
        
-      /**
-        * @description This endpoint is used to retrieve a list of price variants.
-
-        */
-       
        next_offset?:string;
     }
     export interface ListInputParam {
       [key : string]: any;  
       /**
-        * @description This endpoint is used to retrieve a list of price variants.
+        * @description The number of resources to be returned.
 
         */
         
       limit?:number;
        
       /**
-        * @description This endpoint is used to retrieve a list of price variants.
+        * @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 This endpoint is used to retrieve a list of price variants.
+        * @description Filter variant based on their [id](#).
 
         */
         
       id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description This endpoint is used to retrieve a list of price variants.
+        * @description Filter variant based on their &#x60;name&#x60;s.
 
         */
         
       name?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description This endpoint is used to retrieve a list of price variants.
+        * @description Filter variant based on their &#x60;status&#x60;.
 
         */
         
       status?:{in?:string,is?:'active' | 'archived',is_not?:'active' | 'archived',not_in?:string};
        
       /**
-        * @description This endpoint is used to retrieve a list of price variants.
+        * @description Filter product based on their &#x60;updated time&#x60;.
 
         */
         
       updated_at?:{after?:string,before?:string,between?:string,on?:string};
        
       /**
-        * @description This endpoint is used to retrieve a list of price variants.
+        * @description Filter product based on their &#x60;created time&#x60;.
 
         */
         
       created_at?:{after?:string,before?:string,between?:string,on?:string};
        
       /**
-        * @description This endpoint is used to retrieve a list of price variants.
+        * @description The unique ID of the [business entity](/docs/api?prod_cat_ver&#x3D;2#mbe) of this subscription. This is always the same as the [business entity](/docs/api/subscriptions?prod_cat_ver&#x3D;2#subscription_customer_id) of the customer.  
+The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.  
+**Note**
+
+[Multiple Business Entities](/docs/api?prod_cat_ver&#x3D;2#mbe) is a feature available only on Product Catalog 2.0.
 
         */
         
-      sort_by?:{asc?:'name' | 'id' | 'status' | 'created_at' | 'updated_at',desc?:'name' | 'id' | 'status' | 'created_at' | 'updated_at'};
-      
       business_entity_id?:{is?:string,is_present?:'true' | 'false'};
+       
+      include_site_level_resources?:{is?:'true' | 'false'};
+       
+      sort_by?:{asc?:'name' | 'id' | 'status' | 'created_at' | 'updated_at',desc?:'name' | 'id' | 'status' | 'created_at' | 'updated_at'};
     }
     export interface Attribute {  
-         /**
-          * @description Attribute name
-
-          */
-       
       name:string;
        
-         /**
-          * @description Attribute value
-
-          */
-       
       value:string;
     }
   }

package/types/resources/Quote.d.ts

@@ -80,6 +80,8 @@ declare module 'chargebee' {
 
     business_entity_id?:string;
 
+    deleted:boolean;
+
   }
   export namespace Quote {
     export class QuoteResource {  
@@ -814,6 +816,8 @@ NOTE: Not to be used if *consolidated invoicing* feature is enabled.
        
       entity_type:'item_level_coupon' | 'document_level_coupon' | 'promotional_credits' | 'prorated_credits' | 'item_level_discount' | 'document_level_discount';
        
+      discount_type?:'fixed_amount' | 'percentage';
+       
       entity_id?:string;
        
       coupon_set_code?:string;

package/types/resources/QuotedSubscription.d.ts

@@ -114,6 +114,12 @@ declare module 'chargebee' {
        
       amount?:number;
        
+      current_term_start?:number;
+       
+      current_term_end?:number;
+       
+      next_billing_at?:number;
+       
       amount_in_decimal?:string;
        
       billing_period?:number;

package/types/resources/Rule.d.ts

@@ -0,0 +1,38 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+declare module 'chargebee' {
+  export interface Rule {
+    
+
+    id:string;
+
+    namespace:string;
+
+    rule_name:string;
+
+    rule_order?:number;
+
+    status:'active' | 'disabled';
+
+    conditions?:string;
+
+    outcome?:string;
+
+    deleted:boolean;
+
+    created_at:number;
+
+    modified_at:number;
+
+  }
+  export namespace Rule {
+    export class RuleResource {  
+      retrieve(rule_id:string):ChargebeeRequest<RetrieveResponse>;
+    }
+    export interface RetrieveResponse {  
+       rule:Rule;
+    }
+    
+    
+  }
+}

package/types/resources/Subscription.d.ts

@@ -134,6 +134,8 @@ declare module 'chargebee' {
 
     referral_info?:Subscription.ReferralInfo;
 
+    billing_override?:Subscription.BillingOverride;
+
     invoice_notes?:string;
 
     meta_data?:object;
@@ -450,6 +452,8 @@ declare module 'chargebee' {
        
       contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel',cancellation_cutoff_period?:number,contract_start?:number};
        
+      billing_override?:{max_excess_payment_usage?:number,max_refundable_credits_usage?:number};
+       
       subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string,usage_accumulation_reset_frequency?:UsageAccumulationResetFrequency}[];
        
       discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,included_in_mrr?:boolean,item_price_id?:string,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
@@ -944,6 +948,8 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
        
       contract_term?:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number,contract_start?:number};
        
+      billing_override?:{max_excess_payment_usage?:number,max_refundable_credits_usage?:number};
+       
       subscription_items:{billing_cycles?:number,charge_on_event?:ChargeOnEvent,charge_on_option?:ChargeOnOption,charge_once?:boolean,item_price_id:string,item_type?:ItemType,proration_type?:ProrationType,quantity?:number,quantity_in_decimal?:string,service_period_days?:number,trial_end?:number,unit_price?:number,unit_price_in_decimal?:string,usage_accumulation_reset_frequency?:UsageAccumulationResetFrequency}[];
        
       discounts:{amount?:number,apply_on:ApplyOn,duration_type:DurationType,id?:string,included_in_mrr?:boolean,item_price_id?:string,operation_type:OperationType,percentage?:number,period?:number,period_unit?:PeriodUnit}[];
@@ -1403,6 +1409,8 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
        
       coupons?:{apply_till?:number,coupon_id?:string}[];
        
+      exhausted_coupon_ids?:string[];
+       
       id?:string;
        
       trial_end?:number;
@@ -1644,6 +1652,12 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
        
       amount?:number;
        
+      current_term_start?:number;
+       
+      current_term_end?:number;
+       
+      next_billing_at?:number;
+       
       amount_in_decimal?:string;
        
       billing_period?:number;
@@ -1804,6 +1818,11 @@ The ID of the business entity created for the site. For Product Catalog 1.0, all
        
       post_purchase_widget_enabled:boolean;
     }
+    export interface BillingOverride {  
+      max_excess_payment_usage?:number;
+       
+      max_refundable_credits_usage?:number;
+    }
     export interface ContractTerm {  
       id:string;
        

package/types/resources/Transaction.d.ts

@@ -461,6 +461,7 @@ declare module 'chargebee' {
        
       processor_error_message?:string;
        
+      error_cause_id?:string;
     }
   }
 }

package/types/resources/UsageEvent.d.ts

@@ -0,0 +1,46 @@
+///<reference path='./../core.d.ts'/>
+///<reference path='./../index.d.ts'/>
+declare module 'chargebee' {
+  export interface UsageEvent {
+    
+
+    subscription_id:string;
+
+    deduplication_id:string;
+
+    usage_timestamp:number;
+
+    properties:object;
+
+  }
+  export namespace UsageEvent {
+    export class UsageEventResource {  
+      create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
+       
+      batch_ingest(input:BatchIngestInputParam):ChargebeeRequest<BatchIngestResponse>;
+    }
+    export interface CreateResponse {  
+       usage_event:UsageEvent;
+    }
+    export interface CreateInputParam {
+       
+      deduplication_id:string;
+       
+      subscription_id:string;
+       
+      usage_timestamp:number;
+       
+      properties:object;
+    }
+    export interface BatchIngestResponse {  
+       batch_id:string;
+       
+       failed_events:any[];
+    }
+    export interface BatchIngestInputParam {
+       
+      events:{deduplication_id:string,properties:object,subscription_id:string,usage_timestamp:number}[];
+    }
+    
+  }
+}