chargebee 2.46.0 → 2.48.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/Purchase.d.ts

@@ -3,120 +3,24 @@
 declare module 'chargebee' {
   export interface Purchase {
     
-    /**
-      * @description The unique identifier of the purchase resource. This is always autogenerated.
 
-      */
-    
     id?:string;
-    
-    /**
-      * @description The unique identifier of the [customer](https://apidocs.chargebee.com/docs/api/customers) that made this purchase.
 
-      */
-    
     customer_id:string;
-    
-    /**
-      * @description The time at which this purchase was created.
 
-      */
-    
     created_at?:number;
-    
-    /**
-      * @description The time at which the purchase was modified.
 
-      */
-    
     modified_at?:number;
-    
-    /**
-      * @description The unique identifiers of the [subscriptions](https://apidocs.chargebee.com/docs/api/subscriptions) that are created as part of this purchase. These IDs remain even when the associated subscriptions have been deleted.
 
-      */
-    
     subscription_ids?:string[];
-    
-    /**
-      * @description The unique identifier of the [invoice(s)](invoices) created immediately as part of this purchase.
 
-      */
-    
     invoice_ids?:string[];
+
   }
   export namespace Purchase {
     export class PurchaseResource {  
-      /**
-        * @description Creates a `purchase` resource. A purchase can contain one or more of the following:
-
-* subscriptions (a [subscription](subscriptions) resource consists of item prices such that at least one of the item prices belongs to an [item](items) of `type` `plan`.)
-* group of one-time charges (aka [charge item prices](item_prices#types))
-
-When you call this API, the invoices for the subscription(s) and one-time charge(s) are created immediately and not left [unbilled](subscriptions?prod_cat_ver=2#create_subscription_for_items_invoice_immediately).  
-**Note**
-
-Providing `shipping_addresses[]` is required when the [Orders feature](https://www.chargebee.com/docs/2.0/orders.html#configuration_step-1-configure-site-wide-settings) has been enabled.
-
-### Specifying `purchase_item` groups {#groups}
-
-
-When creating a purchase, you must specify the *group* or `index` to which each item price belongs. You can do this by setting the `purchase_items[index]` for each item price. Item prices with the same `purchase_items[index]` belong to the same group.
-
-
-The grouping of item prices allows you to specify the `discounts[]` applicable for each group and indicate which item prices should be added to any subscriptions you want to create. Groups can be one of two types:
-
-* Subscription groups
-* One-time charge groups
-
-The following subsections describe the types of groups in detail.  
-**Note**
-
-You can specify up to 10 groups,
-
-* with a recommended subscription group of 5. To increase this limit to a maximum of 8, contact eap@chargebee.com.
-* with a maximum of 10 one-time charge groups by default.
-
-The total limit for group items for a single purchase is 60.
-
-#### Subscription groups {#subscription}
-
-To create a subscription, specify a *subscription group* . A subscription [group](#groups) is a group of item prices that contains exactly one item price of `type` `plan`. To create multiple subscriptions, provide multiple subscription groups.  
-**Note**
-
-A subscription group can have up to 20 non-plan item prices. To increase this limit to a maximum of 60, contact eap@chargebee.com.  
-
-#### Custom Fields {#custom-fields}
-
-Purchase API supports custom fields of Subscriptions, use the following format to specify custom fields in Purchase API: **`subscription_info[custom_field]`**.
-
-#### One-time charge groups {#one-time}
-
-A one-time charge [group](#groups) is a group of charge item prices (i.e. item prices belonging to items of `type` `charge`). Charge item prices can be added to subscription groups as well. The charges within and across each one-time group must be unique.  
-**Note**
-
-* A one-time charge group can have up to 20 item prices. To increase this limit to a maximum of 60, contact eap@chargebee.com.
-* A charge item price can only be added to a single one-time charge group. However, it can be part of multiple [subscription groups](#subscription).
-
-### Applying discounts {#discounts}
-
-Discounts, both [manual discounts](discounts) and <coupons>, can be applied to groups by specifying the `discounts[]` array. The following table describes the method of application based on whether `discounts[index][i]` is provided:
-
-|                      |                                                                                                                                                                **`discounts[index][i]` is provided**                                                                                                                                                                 |                                                                                     **`discounts[index][i]` is not provided**                                                                                      |
-|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **Coupons**          | * The coupon is applied exclusively to the invoice for group `i`. * The coupon is applied exclusively to the invoice created immediately upon invoking this API. * If group `i` is a [subscription group](#subscription), then the coupon is applied to invoices for subscription renewals based on coupon attributes such as `duration_type` and `max_redemptions`. | * The coupon is applied to all the invoices immediately generated upon invoking this API. * The coupon is not applied to subsequent invoices, such as those generated upon subscription renewal.                   |
-| **Manual discounts** | * The manual discount is applied exclusively to the invoice for group `i`. * The manual discount is applied exclusively to the invoice created immediately upon invoking this API. * The manual discount is not applied to subsequent invoices, such as those generated upon subscription renewal.                                                                   | * The manual discount is applied to all the invoices immediately generated upon invoking this API. * The manual discount is not applied to subsequent invoices, such as those generated upon subscription renewal. |
-
-
-        */
-      
       create(input:CreateInputParam):ChargebeeRequest<CreateResponse>;
        
-      /**
-        * @description Returns an estimate for creating a &#x60;purchase&#x60; resource. The operation works exactly like [Create a purchase](purchases#create_a_purchase), except that only an [estimate](estimates) resource is returned without an actual &#x60;purchase&#x60; resource being created.
-
-        */
-      
       estimate(input:EstimateInputParam):ChargebeeRequest<EstimateResponse>;
     }
     export interface CreateResponse {  
@@ -124,203 +28,54 @@ Discounts, both [manual discounts](discounts) and &lt;coupons&gt;, can be applie
     }
     export interface CreateInputParam {
        
-      /**
-        * @description The unique identifier of the [customer](https://apidocs.chargebee.com/docs/api/customers) that made this purchase.
-
-        */
-       
-      customer_id:string;
-       
-      /**
-        * @description Payment source attached to this purchase. If present, the customer&#x27;s payment sources won&#x27;t be used to collect any payment for this purchase.
-
-        */
-       
-      payment_source_id?:string;
+      invoice_info?:{notes?:string,po_number?:string};
        
-      /**
-        * @description Parameters for invoice_info
-
-        */
+      payment_schedule?:{amount?:number,scheme_id?:string};
        
-      invoice_info?:{notes?:string,po_number?:string};
+      statement_descriptor?:{descriptor?:string};
        
-      /**
-        * @description Parameters for purchase_items
-
-        */
+      payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
        
       purchase_items:{index:number,item_price_id:string,quantity?:number,quantity_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
        
-      /**
-        * @description Parameters for item_tiers
-
-        */
-       
       item_tiers:{ending_unit?:number,ending_unit_in_decimal?:string,index:number,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
        
-      /**
-        * @description Parameters for shipping_addresses
-
-        */
-       
       shipping_addresses?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string}[];
        
-      /**
-        * @description Parameters for discounts
-
-        */
-       
       discounts?:{amount?:number,coupon_id?:string,included_in_mrr?:boolean,index?:number,percentage?:number}[];
        
-      /**
-        * @description Parameters for subscription_info
-
-        */
-       
       subscription_info:{billing_cycles?:number,contract_term_billing_cycle_on_renewal?:number,index:number,meta_data?:object,subscription_id?:string}[];
        
-      /**
-        * @description Creates a &#x60;purchase&#x60; resource. A purchase can contain one or more of the following:
-
-* subscriptions (a [subscription](subscriptions) resource consists of item prices such that at least one of the item prices belongs to an [item](items) of &#x60;type&#x60; &#x60;plan&#x60;.)
-* group of one-time charges (aka [charge item prices](item_prices#types))
-
-When you call this API, the invoices for the subscription(s) and one-time charge(s) are created immediately and not left [unbilled](subscriptions?prod_cat_ver&#x3D;2#create_subscription_for_items_invoice_immediately).  
-**Note**
-
-Providing &#x60;shipping_addresses[]&#x60; is required when the [Orders feature](https://www.chargebee.com/docs/2.0/orders.html#configuration_step-1-configure-site-wide-settings) has been enabled.
-
-### Specifying &#x60;purchase_item&#x60; groups {#groups}
-
-
-When creating a purchase, you must specify the *group* or &#x60;index&#x60; to which each item price belongs. You can do this by setting the &#x60;purchase_items[index]&#x60; for each item price. Item prices with the same &#x60;purchase_items[index]&#x60; belong to the same group.
-
-
-The grouping of item prices allows you to specify the &#x60;discounts[]&#x60; applicable for each group and indicate which item prices should be added to any subscriptions you want to create. Groups can be one of two types:
-
-* Subscription groups
-* One-time charge groups
-
-The following subsections describe the types of groups in detail.  
-**Note**
-
-You can specify up to 10 groups,
-
-* with a recommended subscription group of 5. To increase this limit to a maximum of 8, contact eap@chargebee.com.
-* with a maximum of 10 one-time charge groups by default.
-
-The total limit for group items for a single purchase is 60.
-
-#### Subscription groups {#subscription}
-
-To create a subscription, specify a *subscription group* . A subscription [group](#groups) is a group of item prices that contains exactly one item price of &#x60;type&#x60; &#x60;plan&#x60;. To create multiple subscriptions, provide multiple subscription groups.  
-**Note**
-
-A subscription group can have up to 20 non-plan item prices. To increase this limit to a maximum of 60, contact eap@chargebee.com.  
-
-#### Custom Fields {#custom-fields}
-
-Purchase API supports custom fields of Subscriptions, use the following format to specify custom fields in Purchase API: **&#x60;subscription_info[custom_field]&#x60;**.
-
-#### One-time charge groups {#one-time}
-
-A one-time charge [group](#groups) is a group of charge item prices (i.e. item prices belonging to items of &#x60;type&#x60; &#x60;charge&#x60;). Charge item prices can be added to subscription groups as well. The charges within and across each one-time group must be unique.  
-**Note**
-
-* A one-time charge group can have up to 20 item prices. To increase this limit to a maximum of 60, contact eap@chargebee.com.
-* A charge item price can only be added to a single one-time charge group. However, it can be part of multiple [subscription groups](#subscription).
-
-### Applying discounts {#discounts}
-
-Discounts, both [manual discounts](discounts) and &lt;coupons&gt;, can be applied to groups by specifying the &#x60;discounts[]&#x60; array. The following table describes the method of application based on whether &#x60;discounts[index][i]&#x60; is provided:
-
-|                      |                                                                                                                                                                **&#x60;discounts[index][i]&#x60; is provided**                                                                                                                                                                 |                                                                                     **&#x60;discounts[index][i]&#x60; is not provided**                                                                                      |
-|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **Coupons**          | * The coupon is applied exclusively to the invoice for group &#x60;i&#x60;. * The coupon is applied exclusively to the invoice created immediately upon invoking this API. * If group &#x60;i&#x60; is a [subscription group](#subscription), then the coupon is applied to invoices for subscription renewals based on coupon attributes such as &#x60;duration_type&#x60; and &#x60;max_redemptions&#x60;. | * The coupon is applied to all the invoices immediately generated upon invoking this API. * The coupon is not applied to subsequent invoices, such as those generated upon subscription renewal.                   |
-| **Manual discounts** | * The manual discount is applied exclusively to the invoice for group &#x60;i&#x60;. * The manual discount is applied exclusively to the invoice created immediately upon invoking this API. * The manual discount is not applied to subsequent invoices, such as those generated upon subscription renewal.                                                                   | * The manual discount is applied to all the invoices immediately generated upon invoking this API. * The manual discount is not applied to subsequent invoices, such as those generated upon subscription renewal. |
-
-
-        */
+      contract_terms:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number,index:number}[];
        
-      contract_terms:{action_at_term_end?:'cancel' | 'renew_once' | 'renew' | 'evergreen',cancellation_cutoff_period?:number,index:number}[];
-      statement_descriptor?:{descriptor?:string};
-      payment_schedule?:{amount?:number,scheme_id?:string};
+      customer_id:string;
+       
+      payment_source_id?:string;
     }
     export interface EstimateResponse {  
        estimate:Estimate;
     }
     export interface EstimateInputParam {
        
-      /**
-        * @description Indicates the Client profile id for the customer. This is applicable only if you use [Chargebee&#x27;s AvaTax for Communications](https://www.chargebee.com/docs/avatax-for-communication.html) integration.
-
-        */
-       
-      client_profile_id?:string;
-       
-      /**
-        * @description The unique identifier of the [customer](https://apidocs.chargebee.com/docs/api/customers) that made this purchase.
-
-        */
-       
-      customer_id?:string;
-       
-      /**
-        * @description Parameters for customer
-
-        */
-       
       customer?:{customer_type?:CustomerType,entity_code?:EntityCode,exempt_number?:string,exemption_details?:any[],registered_for_gst?:boolean,taxability?:Taxability,vat_number?:string,vat_number_prefix?:string};
        
-      /**
-        * @description Parameters for billing_address
-
-        */
-       
       billing_address?:{city?:string,country?:string,line1?:string,line2?:string,line3?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
        
-      /**
-        * @description Parameters for purchase_items
-
-        */
-       
       purchase_items:{index:number,item_price_id:string,quantity?:number,quantity_in_decimal?:string,unit_amount?:number,unit_amount_in_decimal?:string}[];
        
-      /**
-        * @description Parameters for item_tiers
-
-        */
-       
       item_tiers:{ending_unit?:number,ending_unit_in_decimal?:string,index:number,item_price_id?:string,price?:number,price_in_decimal?:string,starting_unit?:number,starting_unit_in_decimal?:string}[];
        
-      /**
-        * @description Parameters for shipping_addresses
-
-        */
-       
       shipping_addresses?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string}[];
        
-      /**
-        * @description Parameters for discounts
-
-        */
-       
       discounts?:{amount?:number,coupon_id?:string,included_in_mrr?:boolean,index?:number,percentage?:number}[];
        
-      /**
-        * @description Parameters for subscription_info
-
-        */
-       
       subscription_info:{billing_cycles?:number,contract_term_billing_cycle_on_renewal?:number,index:number,subscription_id?:string}[];
        
-      /**
-        * @description Returns an estimate for creating a &#x60;purchase&#x60; resource. The operation works exactly like [Create a purchase](purchases#create_a_purchase), except that only an [estimate](estimates) resource is returned without an actual &#x60;purchase&#x60; resource being created.
-
-        */
+      contract_terms:{action_at_term_end?:'renew' | 'evergreen' | 'cancel' | 'renew_once',cancellation_cutoff_period?:number,index:number}[];
        
-      contract_terms:{action_at_term_end?:'cancel' | 'renew_once' | 'renew' | 'evergreen',cancellation_cutoff_period?:number,index:number}[];
+      client_profile_id?:string;
+       
+      customer_id?:string;
     }
     
   }