Create Ramp Deal Input

Input representation of the request to create a ramp deal.

JSON Example

1{
2  "transactionId": "0Q0xx0000004C92CAE",
3  "transactionLineId": "0QLxx0000004C9VGAU",
4  "subscriptionTerm": 14,
5  "subscriptionTermUnit": "MONTHS",
6  "trialTerm": 45,
7  "trialTermUnit": "DAYS",
8  "segmentType": "YEARLY",
9  "executionSettings": {
10       "executePricing": true,
11       "executeConfigRules": false
12   }
13}

Properties

Name	Type	Description	Required or Optional	Available Version
`executionSettings`	Execution Settings Input[]	Settings to run the pricing or configuration rules.	Optional	62.0
`segmentType`	String	Type of segment that the user wants to create. Valid values are `FREE_TRIAL`, `CUSTOM`, or `YEARLY`.	Required	62.0
`subscriptionTerm`	Integer	Subscription length of the term-defined product.	Required	62.0
`subscriptionTermUnit`	String	Unit of time for the subscription length. Valid value is `MONTHS`.	Required	62.0
`transactionId`	String	ID of the sales transaction that’s configured, such as quote or order.	Required	62.0
`transactionLineId`	String	Quote line item ID or order item ID that the price ramp is created for.	Required	62.0
`trialTerm`	Integer	Length of the trial period, if any.	Optional	62.0
`trialTermUnit`	String	Unit of time for the trial period. Valid value is `DAYS`.	Optional. Required if `trialTerm` property is specified.	62.0