Retrieve Revenue Contract SSP Details

This API is to retrieve the Standalone Selling Price (SSP) details of order financial IDs from Revenue Contract.

Method - GET

API End Point

/apis/recorder/v1/revenue_contract/<RC ID><ofid=>&object=rc_ssps

Path Parameters

Key	Values
1. object 2. ofid	1. rc_ssp 2. Order Financial ID For e.g. OFID-001

Sample API End Point

apis/recorder/v1/revenue_contract/RC-423?ofid=OFID_SNOW-1554_AA_1&object=rc_ssp

• Above sample endpoint will fetch Standalone Selling Price (SSP) Details of Order Financial ID - OFID_SNOW-1554_AA_1 of RC-423 in RightRev system.

Screenshot for reference

Response

"{
    ""rc_ssp"": [
        {
            ""OFID_SNOW-1554_AA_1"": {
                ""above_mid_point"": 110,
                ""below_midpoint"": 70,
                ""derived_above_midpoint_price"": 1100,
                ""derived_below_midpoint_price"": 700,
                ""derived_midpoint_price"": 900,
                ""effective_end_date"": ""2024-12-31"",
                ""effective_start_date"": ""2021-01-01"",
                ""mid_point"": 90,
                ""order_financial_id"": ""OFID_SNOW-1554_AA_1"",
                ""ssp_batch_name"": ""SSP_16Jan"",
                ""ssp_ceiling_percentage"": 110,
                ""ssp_date"": ""2021-02-01"",
                ""ssp_expression"": null,
                ""ssp_floor_percentage"": 70,
                ""ssp_hierarchy"": ""2"",
                ""ssp_method"": ""Upload"",
                ""ssp_percent"": 90,
                ""ssp_policy_name"": ""SSP_16Jan"",
                ""ssp_transaction_range_identifier"": ""mid_point"",
                ""ssp_value_id"": ""1aeece10-6974-47de-a02c-6a8ecd9c6db3"",
                ""ssp_within_range"": true,
                ""term"": null,
                ""total_list_price"": 1000,
                ""total_sell_price"": 900,
                ""total_ssp_price"": 900,
                ""transaction_price"": 900,
                ""value_type"": ""Percent""
            }
        }
    ],
    ""total_records"": 1
}"

Description of the fields

Field Name	Description	Example
rc_ssp	List of SSP records for the Revenue Contract.
Order Financial ID	Order Financial ID for which SSP values are calculated.	OFID_SNOW-1554_AA_1
above_mid_point	Upper percentage range for SSP.	110
below_midpoint	Lower percentage range for SSP.	70
derived_above_midpoint_price	Derived SSP price using above-midpoint %.	1100
derived_below_midpoint_price	Derived SSP price using below-midpoint %.	700
derived_midpoint_price	Derived midpoint SSP price.	46191
effective_end_date	End date of SSP validity.	2024‑12‑31
effective_start_date	Start date of SSP validity.	2021‑01‑01
mid_point	Midpoint percentage range for SSP.	90
order_financial_id	Order Financial ID tied to SSP line.	OFID_SNOW-1554_AA_1
ssp_batch_name	Name of the SSP batch used.	SSP_16Jan
ssp_ceiling_percentage	Max % allowed for SSP range.	110
ssp_date	Date used for selecting SSP record.	2021‑02‑01
ssp_expression	Formula used for SSP (if formula-based).	null
ssp_floor_percentage	Minimum % allowed for SSP range.	70
ssp_hierarchy	SSP hierarchy level used when determining SSP.	2
ssp_method	Source/method used for SSP (Upload / Formula / Override).	Upload
ssp_percent	Final SSP % selected for pricing.	90
ssp_policy_name	SSP policy applied to the line.	SSP_16Jan
ssp_transaction_range_identifier	Indicates which SSP position is used (mid_point / above / below).	mid_point
ssp_value_id	Unique identifier for the SSP value entry.	1aeece10‑6974‑47de‑a02c‑6a8ecd9c6db3
ssp_within_range	Whether value is within SSP policy range.	TRUE
term	Term or duration used for SSP.	null
total_list_price	Total list price for the line.	1000
total_sell_price	Total selling price for the line.	900
total_ssp_price	SSP price assigned to the line.	900
transaction_price	Final transaction price used for revenue allocation.	900
value_type	Pricing type used (Amount / Percent / Range).	Percent
total_records	Total number of SSP records returned.	1