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
Request Bodies
Configuration Options Input
Configurator Preference Input
Context Input
Context Node Input
Execution Settings Input
Instant Pricing Input
Object Graph Input
Object Input Map
Object with Reference Input
Place Order Input
Place Quote Input
Place Sales Transaction Input
Create Ramp Deal Input
Delete Ramp Deal Input
Update Ramp Deal Input
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 Input

Input representation of the request to create a ramp deal.
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