chargebee 2.28.0 → 2.29.0

package/types/resources/Coupon.d.ts

@@ -1,7 +1,7 @@
 ///<reference path='./../core.d.ts'/>
 declare module 'chargebee' {
   export interface Coupon {
-    
+    [key : string] : any;
     /**
       * @description Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.  
 **Note:**
@@ -181,11 +181,11 @@ Note that this does not change when the [redemptions](/docs/api/coupons?#coupon_
   export namespace Coupon {
     export class CouponResource {  
       /**
-        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
+        * @description This API creates a new coupon for a specific promotion or offers.
 
         */
       
-      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+      create_for_items(input:CreateForItemsInputParam):ChargebeeRequest<CreateForItemsResponse>;
        
       /**
         * @description This API updates a coupon that is created for a specific promotion or offers.
@@ -195,11 +195,18 @@ Note that this does not change when the [redemptions](/docs/api/coupons?#coupon_
       update_for_items(coupon_id:string, input?:UpdateForItemsInputParam):ChargebeeRequest<UpdateForItemsResponse>;
        
       /**
-        * @description This API unarchives a specific coupon using the coupon ID.
+        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
 
         */
       
-      unarchive(coupon_id:string):ChargebeeRequest<UnarchiveResponse>;
+      list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
+       
+      /**
+        * @description This API retrieves a specific coupon using the coupon ID.
+
+        */
+      
+      retrieve(coupon_id:string):ChargebeeRequest<RetrieveResponse>;
        
       /**
         * @description If no Subscriptions/Invoices are linked to this Coupon, the Coupon will be deleted from your Chargebee site. This action cannot be undone.
@@ -223,149 +230,189 @@ The value for [redemptions](./coupons?prod_cat_ver&#x3D;2#coupon_redemptions) is
       copy(input:CopyInputParam):ChargebeeRequest<CopyResponse>;
        
       /**
-        * @description This API retrieves a specific coupon using the coupon ID.
+        * @description This API unarchives a specific coupon using the coupon ID.
 
         */
       
-      retrieve(coupon_id:string):ChargebeeRequest<RetrieveResponse>;
-       
+      unarchive(coupon_id:string):ChargebeeRequest<UnarchiveResponse>;
+    }
+    export interface CreateForItemsResponse {  
+       coupon:Coupon;
+    }
+    export interface CreateForItemsInputParam {
+      [key : string] : any;  
       /**
-        * @description This API creates a new coupon for a specific promotion or offers.
+        * @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.
+.
 
         */
-      
-      create_for_items(input:CreateForItemsInputParam):ChargebeeRequest<CreateForItemsResponse>;
-    }
-    export interface ListResponse {  
+       
+      id:string;
+       
       /**
-        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
+        * @description The display name used in web interface for identifying the coupon.  
+**Note:**
+
+
+When the name of the coupon set contains a special character; for example: &#x60;#&#x60;, the API returns an error.
+Make sure that you [encode](https://www.urlencoder.org/) the name of the coupon set in the path parameter before making an API call.
+.
 
         */
        
-       list:{coupon:Coupon}[];
+      name:string;
        
       /**
-        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
+        * @description Display name used in invoice. If it is not configured then name is used in invoice.
 
         */
        
-       next_offset?:string;
-    }
-    export interface ListInputParam {
-      [key : string]: any;  
+      invoice_name?:string;
+       
       /**
-        * @description The number of resources to be returned.
+        * @description The type of deduction. \* percentage - The specified percentage will be deducted. \* fixed_amount - The specified amount will be deducted. \* offer_quantity - The specified units will be offered for free.
 
         */
-        
-      limit?:number;
+       
+      discount_type?:'fixed_amount' | 'percentage';
        
       /**
-        * @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 The value of the deduction. The format of this value depends on the [kind of currency](/docs/api#currencies).
 
         */
-        
-      offset?:string;
+       
+      discount_amount?:number;
        
       /**
-        * @description Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.  
-**Note:**
+        * @description The currency code ([ISO 4217 format](https://www.chargebee.com/docs/2.0/supported-currencies.html)) of the coupon. Applicable for *fixed_amount* coupons alone.
 
+        */
+       
+      currency_code?:string;
+       
+      /**
+        * @description The percentage of the original amount that should be deducted from it.
 
-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.
+        */
+       
+      discount_percentage?:number;
+       
+      /**
+        * @description The amount on the invoice to which the coupon is applied. \* invoice_amount - The coupon is applied to the invoice &#x60;sub_total&#x60;. \* each_unit_of_specified_items - Discount will be applied to each unit of plan and addon items specified. \* each_specified_item - The coupon is applied to the &#x60;invoice.line_item.amount&#x60; that corresponds to the item price specified by &#x60;item_price_id&#x60;. \* specified_items_total - Discount will be applied to the total of plan and addon items specified.
 
         */
-        
-      id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      apply_on:'invoice_amount' | 'each_specified_item';
        
       /**
-        * @description The display name used in web interface for identifying the coupon.  
-**Note:**
+        * @description Specifies the time duration for which this coupon is attached to the subscription. \* forever - The coupon is attached to the subscription and applied on the invoices until explicitly removed. \* one_time - The coupon 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 **(Deprecated)** The duration of time in months for which the coupon is attached to the subscription. Applicable only when &#x60;duration_type&#x60; is &#x60;limited_period&#x60;.   
+**Note:** This parameter has been deprecated. Use &#x60;period&#x60; and &#x60;period_unit&#x60; instead.
 
-When the name of the coupon set contains a special character; for example: &#x60;#&#x60;, the API returns an error.
-Make sure that you [encode](https://www.urlencoder.org/) the name of the coupon set in the path parameter before making an API call.
+        */
+       
+      duration_month?:number;
+       
+      /**
+        * @description Date upto which the coupon can be applied to new subscriptions.
 
         */
-        
-      name?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      valid_till?:number;
        
       /**
-        * @description The type of deduction
+        * @description Maximum number of times this coupon can be redeemed.  
+**Note:**
+
+
+If not specified, the coupon can be redeemed an indefinite number of times.
+.
 
         */
-        
-      discount_type?:{in?:string,is?:'fixed_amount' | 'percentage',is_not?:'fixed_amount' | 'percentage',not_in?:string};
+       
+      max_redemptions?:number;
        
       /**
-        * @description Specifies the time duration for which this coupon is attached to the subscription.
+        * @description A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices#invoice_notes) displayed on the invoice PDF.
 
         */
-        
-      duration_type?:{in?:string,is?:'limited_period' | 'one_time' | 'forever',is_not?:'limited_period' | 'one_time' | 'forever',not_in?:string};
+       
+      invoice_notes?:string;
        
       /**
-        * @description Status of the coupon.
+        * @description A collection of key-value pairs that provides extra information about the coupon.  
+**Note:** There&#x27;s a character limit of 65,535.
+[Learn more](advanced-features?prod_cat_ver&#x3D;2#metadata).
 
         */
-        
-      status?:{in?:string,is?:'archived' | 'expired' | 'deleted' | 'active',is_not?:'archived' | 'expired' | 'deleted' | 'active',not_in?:string};
+       
+      meta_data?:object;
        
       /**
-        * @description The amount on the invoice to which the coupon is applied.
+        * @description The coupon is included in MRR calculations for your site. This attribute is only applicable for coupons of &#x60;duration_type &#x3D; one_time&#x60; and when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude one-time coupons from MRR calculations, this value is always returned &#x60;false&#x60;.
 
         */
-        
-      apply_on?:{in?:string,is?:'invoice_amount' | 'each_specified_item',is_not?:'invoice_amount' | 'each_specified_item',not_in?:string};
+       
+      included_in_mrr?:boolean;
        
       /**
-        * @description Timestamp indicating when this coupon is created.
+        * @description The duration of time for which the coupon is attached to the subscription, in &#x60;period_units&#x60;. Applicable only when [duration_type](/docs/api/coupons?#coupon_duration_type) is [limited_period](/docs/api/coupons?#coupon_duration_type).
 
         */
-        
-      created_at?:{after?:string,before?:string,between?:string,on?:string};
+       
+      period?:number;
        
       /**
-        * @description To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-11-09.
+        * @description The unit of time for period. Applicable only when [duration_type](/docs/api/coupons?#coupon_duration_type) is [limited_period](/docs/api/coupons?#coupon_duration_type). \* month - A period of 1 calendar month. \* week - A period of 7 days. \* year - A period of 1 calendar year. \* day - A period of 24 hours.
 
         */
-        
-      updated_at?:{after?:string,before?:string,between?:string,on?:string};
+       
+      period_unit?:PeriodUnit;
        
       /**
-        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
+        * @description Status of the coupon. \* expired - Cannot be applied to a subscription. A coupon may expire due to exceeding [max_redemptions](/docs/api/coupons?#coupon_max_redemptions) or [valid_till](/docs/api/coupons?#coupon_valid_till) date is past. Existing associations remain unaffected. \* archived - Cannot be applied to a subscription. Existing associations remain unaffected. \* active - Can be applied to a subscription. \* deleted - Indicates the coupon has been deleted.
 
         */
-        
-      sort_by?:{asc?:'created_at',desc?:'created_at'};
+       
+      status?:'archived' | 'active';
        
       /**
-        * @description The currency code ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)) of the coupon. Applicable for *fixed_amount* coupons alone.
+        * @description Parameters for item_constraints
 
         */
-        
-      currency_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+       
+      item_constraints?:{constraint:'all' | 'criteria' | 'none' | 'specific',item_price_ids?:any[],item_type:'charge' | 'addon' | 'plan'}[];
        
       /**
-        * @description Parameters for addon
+        * @description Parameters for item_constraint_criteria
 
         */
-        
-      addon?:{};
+       
+      item_constraint_criteria?:{currencies?:any[],item_family_ids?:any[],item_price_periods?:any[],item_type?:'charge' | 'addon' | 'plan'}[];
        
       /**
-        * @description Parameters for plan
+        * @description Parameters for &#x60;coupon_constraints&#x60;. Multiple &#x60;coupon_constraints&#x60; can be passed by specifying unique indices.
 
         */
-        
-      plan?:{};
+       
+      coupon_constraints?:{entity_type:'customer',type:'max_redemptions' | 'unique_by',value?:string}[];
     }
     export interface UpdateForItemsResponse {  
        coupon:Coupon;
     }
     export interface UpdateForItemsInputParam {
-       
+      [key : string] : any;  
       /**
         * @description The display name used in web interface for identifying the coupon.  
 **Note:**
@@ -463,7 +510,9 @@ If not specified, the coupon can be redeemed an indefinite number of times.
       invoice_notes?:string;
        
       /**
-        * @description A set of key-value pairs stored as additional information for the coupon. [Learn more](./#meta_data).
+        * @description A collection of key-value pairs that provides extra information about the coupon.  
+**Note:** There&#x27;s a character limit of 65,535.
+[Learn more](advanced-features?prod_cat_ver&#x3D;2#metadata).
 
         */
        
@@ -511,243 +560,229 @@ If not specified, the coupon can be redeemed an indefinite number of times.
        
       coupon_constraints?:{entity_type:'customer',type:'max_redemptions' | 'unique_by',value?:string}[];
     }
-    export interface UnarchiveResponse {  
-       coupon:Coupon;
-    }
-    
-    export interface DeleteResponse {  
-       coupon:Coupon;
-    }
-    
-    export interface CopyResponse {  
-       coupon:Coupon;
-    }
-    export interface CopyInputParam {
-       
+    export interface ListResponse {  
       /**
-        * @description Your Chargebee site name having the coupon to be copied.  
-**Note:** Unless you are copying from a twin site (acme \&amp; acme-test are twin sites), [contact support](https://chargebee.freshdesk.com/support/home) to have this allow-listed.
+        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
 
         */
        
-      from_site:string;
+       list:{coupon:Coupon}[];
        
       /**
-        * @description Id of the coupon to be copied. The new coupon created in this site will have the same Id.
+        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
 
         */
        
-      id_at_from_site:string;
-       
+       next_offset?:string;
+    }
+    export interface ListInputParam {
+      [key : string]: any;  
       /**
-        * @description Id of copied coupon in this site.
+        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
 
         */
-       
-      id?:string;
+        
+      limit?:number;
        
       /**
-        * @description If copy action is performed as part of Chargebee site merge action, pass the value as true.  
-**Note:** If this parameter is passed true coupon state, redemptions, coupon set and coupon codes associated with this coupon will be copied.
+        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
 
         */
-       
-      for_site_merging?:boolean;
-    }
-    export interface RetrieveResponse {  
-       coupon:Coupon;
-    }
-    
-    export interface CreateForItemsResponse {  
-       coupon:Coupon;
-    }
-    export interface CreateForItemsInputParam {
+        
+      offset?:string;
        
       /**
-        * @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.
-.
+        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
 
         */
-       
-      id:string;
+        
+      id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description The display name used in web interface for identifying the coupon.  
-**Note:**
-
-
-When the name of the coupon set contains a special character; for example: &#x60;#&#x60;, the API returns an error.
-Make sure that you [encode](https://www.urlencoder.org/) the name of the coupon set in the path parameter before making an API call.
-.
+        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
 
         */
-       
-      name:string;
+        
+      name?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
        
       /**
-        * @description Display name used in invoice. If it is not configured then name is used in invoice.
+        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
 
         */
-       
-      invoice_name?:string;
+        
+      discount_type?:{in?:string,is?:'fixed_amount' | 'percentage',is_not?:'fixed_amount' | 'percentage',not_in?:string};
        
       /**
-        * @description The type of deduction. \* percentage - The specified percentage will be deducted. \* fixed_amount - The specified amount will be deducted. \* offer_quantity - The specified units will be offered for free.
+        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
 
         */
-       
-      discount_type:'fixed_amount' | 'percentage';
+        
+      duration_type?:{in?:string,is?:'limited_period' | 'one_time' | 'forever',is_not?:'limited_period' | 'one_time' | 'forever',not_in?:string};
        
       /**
-        * @description The value of the deduction. The format of this value depends on the [kind of currency](/docs/api#currencies).
+        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
 
         */
-       
-      discount_amount?:number;
+        
+      status?:{in?:string,is?:'archived' | 'expired' | 'deleted' | 'active',is_not?:'archived' | 'expired' | 'deleted' | 'active',not_in?:string};
        
       /**
-        * @description The currency code ([ISO 4217 format](https://www.chargebee.com/docs/2.0/supported-currencies.html)) of the coupon. Applicable for *fixed_amount* coupons alone.
+        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
 
         */
-       
-      currency_code?:string;
+        
+      apply_on?:{in?:string,is?:'invoice_amount' | 'each_specified_item',is_not?:'invoice_amount' | 'each_specified_item',not_in?:string};
        
       /**
-        * @description The percentage of the original amount that should be deducted from it.
+        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
 
         */
-       
-      discount_percentage?:number;
+        
+      created_at?:{after?:string,before?:string,between?:string,on?:string};
        
       /**
-        * @description The amount on the invoice to which the coupon is applied. \* invoice_amount - The coupon is applied to the invoice &#x60;sub_total&#x60;. \* each_unit_of_specified_items - Discount will be applied to each unit of plan and addon items specified. \* each_specified_item - The coupon is applied to the &#x60;invoice.line_item.amount&#x60; that corresponds to the item price specified by &#x60;item_price_id&#x60;. \* specified_items_total - Discount will be applied to the total of plan and addon items specified.
+        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
 
         */
-       
-      apply_on:'invoice_amount' | 'each_specified_item';
+        
+      updated_at?:{after?:string,before?:string,between?:string,on?:string};
        
       /**
-        * @description Specifies the time duration for which this coupon is attached to the subscription. \* forever - The coupon is attached to the subscription and applied on the invoices until explicitly removed. \* one_time - The coupon 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;.
+        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
 
         */
-       
-      duration_type:'limited_period' | 'one_time' | 'forever';
+        
+      sort_by?:{asc?:'created_at',desc?:'created_at'};
        
       /**
-        * @description **(Deprecated)** The duration of time in months for which the coupon is attached to the subscription. Applicable only when &#x60;duration_type&#x60; is &#x60;limited_period&#x60;.   
-**Note:** This parameter has been deprecated. Use &#x60;period&#x60; and &#x60;period_unit&#x60; instead.
+        * @description List all the available coupons that are created for a specific promotion or offers. You can find list of coupon codes that are currently active, expired, archived or deleted.
 
         */
-       
-      duration_month?:number;
+        
+      currency_code?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
+    }
+    export interface RetrieveResponse {  
+       coupon:Coupon;
+    }
+    
+    export interface DeleteResponse {  
+       coupon:Coupon;
+    }
+    
+    export interface CopyResponse {  
+       coupon:Coupon;
+    }
+    export interface CopyInputParam {
        
       /**
-        * @description Date upto which the coupon can be applied to new subscriptions.
+        * @description Your Chargebee site name having the coupon to be copied.  
+**Note:** Unless you are copying from a twin site (acme \&amp; acme-test are twin sites), [contact support](https://chargebee.freshdesk.com/support/home) to have this allow-listed.
 
         */
        
-      valid_till?:number;
+      from_site:string;
        
       /**
-        * @description Maximum number of times this coupon can be redeemed.  
-**Note:**
-
-
-If not specified, the coupon can be redeemed an indefinite number of times.
-.
+        * @description Id of the coupon to be copied. The new coupon created in this site will have the same Id.
 
         */
        
-      max_redemptions?:number;
+      id_at_from_site:string;
        
       /**
-        * @description A customer-facing note added to all invoices associated with this API resource. This note becomes one among [all the notes](/docs/api/invoices#invoice_notes) displayed on the invoice PDF.
+        * @description Id of copied coupon in this site.
 
         */
        
-      invoice_notes?:string;
+      id?:string;
        
       /**
-        * @description A set of key-value pairs stored as additional information for the coupon. [Learn more](./#meta_data).
+        * @description If copy action is performed as part of Chargebee site merge action, pass the value as true.  
+**Note:** If this parameter is passed true coupon state, redemptions, coupon set and coupon codes associated with this coupon will be copied.
 
         */
        
-      meta_data?:object;
-       
-      /**
-        * @description The coupon is included in MRR calculations for your site. This attribute is only applicable for coupons of &#x60;duration_type &#x3D; one_time&#x60; and when the feature is enabled in Chargebee. Note: If the site-level setting is to exclude one-time coupons from MRR calculations, this value is always returned &#x60;false&#x60;.
+      for_site_merging?:boolean;
+    }
+    export interface UnarchiveResponse {  
+       coupon:Coupon;
+    }
+    
+    export interface ItemConstraint {  
+         /**
+          * @description Item type for which this criteria is applicable for. \* charge - Charge \* plan - Plan \* addon - Addon
 
-        */
+          */
        
-      included_in_mrr?:boolean;
+      item_type:'charge' | 'addon' | 'plan';
        
-      /**
-        * @description The duration of time for which the coupon is attached to the subscription, in &#x60;period_units&#x60;. Applicable only when [duration_type](/docs/api/coupons?#coupon_duration_type) is [limited_period](/docs/api/coupons?#coupon_duration_type).
+         /**
+          * @description Constraint applicable for the item \* specific - Coupon applicable to specific items. \* all - Coupon applicable to all items. \* criteria - Coupon applicable based on criteria. \* none - Coupon not applicable to any items.
 
-        */
+          */
        
-      period?:number;
+      constraint:'all' | 'criteria' | 'none' | 'specific';
        
-      /**
-        * @description The unit of time for period. Applicable only when [duration_type](/docs/api/coupons?#coupon_duration_type) is [limited_period](/docs/api/coupons?#coupon_duration_type). \* month - A period of 1 calendar month. \* week - A period of 7 days. \* year - A period of 1 calendar year. \* day - A period of 24 hours.
+         /**
+          * @description List of item price ids for which this coupon is applicable.
 
-        */
-       
-      period_unit?:PeriodUnit;
+          */
        
-      /**
-        * @description Status of the coupon. \* expired - Cannot be applied to a subscription. A coupon may expire due to exceeding [max_redemptions](/docs/api/coupons?#coupon_max_redemptions) or [valid_till](/docs/api/coupons?#coupon_valid_till) date is past. Existing associations remain unaffected. \* archived - Cannot be applied to a subscription. Existing associations remain unaffected. \* active - Can be applied to a subscription. \* deleted - Indicates the coupon has been deleted.
+      item_price_ids?:any[];
+    }
+    export interface ItemConstraintCriteria {  
+         /**
+          * @description Item type for which this criteria is applicable for. \* charge - Charge is a type of item \* plan - Plan is a type of item \* addon - Addon is a type of item
 
-        */
+          */
        
-      status?:'archived' | 'active';
+      item_type:'charge' | 'addon' | 'plan';
        
-      /**
-        * @description Parameters for item_constraints
+         /**
+          * @description List of currencies ([ISO 4217 format](https://www.chargebee.com/docs/supported-currencies.html)) for which this coupon is applicable.
 
-        */
+          */
        
-      item_constraints?:{constraint:'all' | 'criteria' | 'none' | 'specific',item_price_ids?:any[],item_type:'charge' | 'addon' | 'plan'}[];
+      currencies?:any[];
        
-      /**
-        * @description Parameters for item_constraint_criteria
+         /**
+          * @description List of families for which this coupon is applicable.
 
-        */
+          */
        
-      item_constraint_criteria?:{currencies?:any[],item_family_ids?:any[],item_price_periods?:any[],item_type?:'charge' | 'addon' | 'plan'}[];
+      item_family_ids?:any[];
        
-      /**
-        * @description Parameters for &#x60;coupon_constraints&#x60;. Multiple &#x60;coupon_constraints&#x60; can be passed by specifying unique indices.
+         /**
+          * @description List of frequencies for which this coupon is applicable. Allowed frequencies are \[day, week, month, year\].
 
-        */
-       
-      coupon_constraints?:{entity_type:'customer',type:'max_redemptions' | 'unique_by',value?:string}[];
-    }
-    export interface ItemConstraint {  
-      item_type?:'charge' | 'addon' | 'plan';
-       
-      constraint?:'all' | 'criteria' | 'none' | 'specific';
+          */
        
-      item_price_ids?:any[];
+      item_price_periods?:any[];
     }
-    export interface ItemConstraintCriteria {  
-      item_type?:'charge' | 'addon' | 'plan';
+    export interface CouponConstraint {  
+         /**
+          * @description The resource type for the constraint. This, along with &#x60;type&#x60; and &#x60;value&#x60;, helps define the specific rule applied. \* customer - The constraint is based on &#x60;customer&#x60; records.
+
+          */
        
-      currencies?:any[];
+      entity_type:'customer';
        
-      item_family_ids?:any[];
+         /**
+          * @description Type of coupon constraints \* unique_by - Indicates - when &#x60;entity_type&#x60; is &#x60;customer&#x60; - that the coupon can be redeemed only once for every unique value of a specified &#x60;customer&#x60; attribute. The &#x60;customer&#x60; attribute is specified using &#x60;value&#x60;. For example, if &#x60;value&#x60; is &#x60;email&#x60;, then the coupon can be redeemed only once for every unique value of &#x60;customer.email&#x60;. In other words, when there are multiple &#x60;customer&#x60; records with the same value for &#x60;email&#x60;, once the coupon has been redeemed for one of those customer records, no further redemptions of the coupon are allowed for any of those &#x60;customer&#x60; records. \* max_redemptions - The coupon can be redeemed up to a set number of times for a specific resource type. The maximum redemptions are specified using &#x60;value&#x60;, and the resource type is specified using &#x60;entity_type&#x60;. For example, if &#x60;entity_type&#x60; is &#x60;customer&#x60; and &#x60;value&#x60; is &#x60;10&#x60; then the coupon can only be redeemed up to 10 times for any particular &#x60;customer&#x60; record.
+
+          */
        
-      item_price_periods?:any[];
-    }
-    export interface CouponConstraint {  
-      entity_type?:'customer';
+      type:'max_redemptions' | 'unique_by';
        
-      type?:'max_redemptions' | 'unique_by';
+         /**
+          * @description The value of the coupon constraint. The possible values depend on the value of &#x60;constraints[type]&#x60;:
+
+* When &#x60;type&#x60; is &#x60;unique_by&#x60;, then &#x60;value&#x60; can be &#x60;email&#x60; or &#x60;id&#x60;.
+
+* When &#x60;type&#x60; is &#x60;max_redemptions&#x60;, then &#x60;value&#x60; can be any integer in the range &#x60;1&#x60; &#x60;coupon.max_redemptions&#x60;, inclusive.
+
+
+          */
        
       value?:string;
     }