Create Ramp Deal (POST)

Create a ramp deal for a customer on a product. Sales reps can use ramp deals to provide yearly deals to a customer, resulting in long-term revenue and customer relationship. A customer can create, update, or view multiple segments of periods for their subscription term with different attributes for each segment.

This API request creates segments based on the specified input properties such as term, segment type, and trial details. The API response includes the context ID and the updated context object for the sales transaction. You must call the Place Sales Transaction API by specifying this context ID to apply the ramp deal updates. See Place Sales Transaction API .

This API is applicable when you’re working with line ramps. To work with ramp deals for groups, you must use the Place Sales Transaction API and specify the groupRampActions property.

Note

Resource

1/connect/revenue-management/sales-transaction-contexts/{resourceId}/actions/ramp-deal-create

Resource Example

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/revenue-management/sales-transaction-contexts/{0QLxx0000004CfIGAU}/actions/ramp-deal-create

Available Version

62.0

HTTP Methods

POST

Path Parameter for POST

Name	Type	Description	Required or Optional	Available Version
`resourceId`	String	ID of the quote line item, order item, or context.	Required	62.0

Request Body for POST

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

Response Body for POST

Ramp Deal Service