Add a Product To a Deal
Last updated
Was this helpful?
Last updated
Was this helpful?
Deal ID
The ID of the deal
Product ID
The ID of the product
Item Price
The price value of the product
Quantity
The quantity of the product
Tax
The product tax (Optional)
Default : 0
Comments
The comments of the product (Optional)
Discount
The value of the discount (Optional)
The discount_type
field can be used to specify whether the value is an amount or a percentage.
Default : 0
Is Enabled
Whether this product is enabled for the deal (Optional)
Not possible to disable the product if the deal has installments associated and the product is the last one enabled
Not possible to enable the product if the deal has installments associated and the product is recurring Default : true
Tax Method
The tax option to be applied to the product.
none (default)
exclusive
inclusiv
Discount Type
The value of the discount (Optional)
percentage
amount
Product Variation ID
The ID of the product variation (Optional)
Billing Frequency
How often a customer is billed for access to a service or product (Optional)
Only available in Advanced and above plans
One-time (Default)
Annually
Semi-annually
Quarterly
Monthly
Weekly
Billing Frequency Cycles
The number of times the billing frequency repeats for a product in a deal (Optional)
Only available in Advanced and above plans
When billing_frequency
is set to one-time
, this field must be null
When billing_frequency
is set to weekly
, this field cannot 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 208
Billing Start Date
The billing start date (Optional)
Only available in Advanced and above plans Must be between 10 years in the past and 10 years in the future Format : YYYY-MM-DD