Revenue Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with Revenue Cloud Developer Resources
Product Catalog Management
Salesforce Pricing
Product Configurator
Transaction Management
Quote and Order Capture
Quote and Order Capture Standard Objects
Quote and Order Capture Fields on Standard Objects
Quote and Order Capture Tooling API Objects
Quote and Order Capture Platform Event
Quote and Order Capture Business APIs
Resources
Instant Pricing (POST)
Place Order (POST)
Place Quote (POST)
Place Sales Transaction (POST)
Create Ramp Deal (POST)
Delete Ramp Deal (POST)
Update Ramp Deal (POST)
View Ramp Deal (GET)
Request Bodies
Response Bodies
Quote and Order Capture Apex Reference
Quote and Order Capture Standard Invocable Actions
Quote and Order Capture Metadata API Types
Asset Lifecycle
Usage Management
Rate Management
Dynamic Revenue Orchestrator
Billing
Revenue Cloud Associated Objects
PDF

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 (POST) API by specifying this context ID to apply the ramp deal updates. See Place Sales Transaction (POST) API.

Resource
/connect/revenue-management/sales-transaction-contexts/resourceId/actions/ramp-deal-create
Resource example
https://yourInstance.salesforce.com/services/data/v64.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
{
  "transactionId": "0Q0xx0000004C92CAE",
  "transactionLineId": "0QLxx0000004C9VGAU",
  "subscriptionTerm": 14,
  "subscriptionTermUnit": "MONTHS",
  "trialTerm": 45,
  "trialTermUnit": "DAYS",
  "segmentType": "YEARLY",
  "executionSettings": {
       "executePricing": true,
       "executeConfigRules": false
   }
}
Properties
Name Type Description Required or Optional Available Version
execution​Settings Execution Settings Input[] Settings to run the pricing or configuration rules. Optional 62.0
segment​Type String

Type of segment that the user wants to create. Valid values are:

  • FREE_TRIAL
  • CUSTOM
  • YEARLY
 Required 62.0
subscription​Term Integer Subscription length of the term-defined product. Required 62.0
subscription​TermUnit String

Unit of time for the subscription length. Valid value is:

  • MONTHS
 Required 62.0
transaction​Id String ID of the sales transaction that’s configured, such as quote or order. Required 62.0
transaction​LineId 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
trialTerm​Unit 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