You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**product_id** | **int** | The ID of the product |
8
-
**item_price** | **float** | The price at which this product will be added to the deal |
9
-
**quantity** | **int** | Quantity – e.g. how many items of this product will be added to the deal |
10
-
**discount** | **float** | The value of the discount. The `discount_type` field can be used to specify whether the value is an amount or a percentage. | [optional][default to 0]
11
-
**discount_type** | **string** | The type of the discount's value. | [optional][default to 'percentage']
12
-
**duration** | **float** | The duration of the product. If omitted, will be set to 1. | [optional][default to 1]
7
+
**product_id** | **int** | The ID of the product |[optional]
8
+
**item_price** | **float** | The price at which this product will be added to the deal |[optional]
9
+
**quantity** | **int** | Quantity – e.g. how many items of this product will be added to the deal |[optional]
10
+
**discount** | **float** | The value of the discount. The `discount_type` field can be used to specify whether the value is an amount or a percentage | [optional][default to 0]
11
+
**discount_type** | **string** | The type of the discount's value | [optional][default to 'percentage']
12
+
**duration** | **float** | The duration of the product. If omitted, will be set to 1 | [optional][default to 1]
13
13
**duration_unit** | **string** | The type of the duration. (For example hourly, daily, etc.) | [optional]
14
-
**product_variation_id** | **int** | The ID of the product variation to use. When omitted, no variation will be used. | [optional]
14
+
**product_variation_id** | **int** | The ID of the product variation to use. When omitted, no variation will be used | [optional]
15
15
**comments** | **string** | A textual comment associated with this product-deal attachment | [optional]
16
16
**tax** | **float** | The product tax | [optional]
17
-
**tax_method** | **string** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal. | [optional]
18
-
**enabled_flag** | **bool** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default. | [optional][default to true]
17
+
**tax_method** | **string** | The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal | [optional]
18
+
**enabled_flag** | **bool** | Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default | [optional][default to true]
**billing_frequency_cycles** | **int** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional]
21
+
**billing_start_date** | **string** | Only available in Advanced and above plans The billing start date. Must be between 15 years in the past and 15 years in the future | [optional]
19
22
**id** | **int** | The ID of the deal-product (the ID of the product attached to the deal) | [optional]
20
23
**company_id** | **int** | The ID of the company | [optional]
21
24
**deal_id** | **int** | The ID of the deal | [optional]
**name** | **string** | The name of the product |[optional]
8
8
**code** | **string** | The product code | [optional]
9
9
**unit** | **string** | The unit in which this product is sold | [optional]
10
10
**tax** | **float** | The tax percentage | [optional][default to 0]
11
11
**active_flag** | **bool** | Whether this product will be made active or not | [optional][default to true]
12
12
**selectable** | **bool** | Whether this product can be selected in deals or not | [optional][default to true]
13
13
**visible_to** | [**VisibleTo**](VisibleTo.md) | The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=\"https://support.pipedrive.com/en/article/visibility-groups\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>.<h4>Essential / Advanced plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner &amp; followers</td><tr><td>`3`</td><td>Entire company</td></tr></table><h4>Professional / Enterprise plan</h4><table><tr><th style=\"width: 40px\">Value</th><th>Description</th></tr><tr><td>`1`</td><td>Owner only</td><tr><td>`3`</td><td>Owner's visibility group</td></tr><tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr><tr><td>`7`</td><td>Entire company</td></tr></table> | [optional]
14
-
**owner_id** | **int** | The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used. | [optional]
14
+
**owner_id** | **int** | The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used | [optional]
15
15
**prices** | **object[]** | An array of objects, each containing: `currency` (string), `price` (number), `cost` (number, optional), `overhead_cost` (number, optional). Note that there can only be one price per product per currency. When `prices` is omitted altogether, a default price of 0 and a default currency based on the company's currency will be assigned. | [optional]
**billing_frequency_cycles** | **int** | Only available in Advanced and above plans The number of times the billing frequency repeats for a product in a deal When `billing_frequency` is set to `one-time`, this field must be `null` For all the other values of `billing_frequency`, `null` represents a product billed indefinitely Must be a positive integer less or equal to 312 | [optional]
16
18
17
19
[[Back to Model list]](../../README.md#models)[[Back to API list]](../../README.md#endpoints)[[Back to README]](../../README.md)
0 commit comments