Get opportunity pricing plan costs without specifying an opportunity
Changed onRead initial costs for a pricing plan of an opportunity item without specifying an opportunity.
'Required: Accept-Language' header with Locale format. For example: en-US
Request
- Base URLhttps://marketplace.appdirect.com/api
- Authnone declared. Required headers: Accept-Language
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Pricing plan ID
Sales agent's user ID
Sales agent's company ID
Opportunity currency, using the ISO-4217 currency code
Headers
Locale. Format: 'en-US'
Response
Success
Example response
{
"pricingPlanId": "a01c46d4-8925-4719-a891-2c036e2216a1",
"pricing": [
{
"costId": "0121502b-0bac-4927-825c-d1f6c19e79c7",
"costTypeCategory": "ONE_TIME",
"frequency": "ONE_TIME",
"costType": "CONTRACT_FEE",
"pricingStrategy": "FLAT",
"priceRanges": [],
"description": "Contract charge",
"unit": "CONTRACT_FEE",
"quantity": "1.0000000000",
"salePrice": "300.0000000000",
"wholesalePrice": "300.0000000000",
"totalSalePrice": "300.0000000000"
},
{
"costId": "78092def-eeb6-42dc-917e-182e38b53d16",
"costTypeCategory": "RECURRING",
"frequency": "MONTHLY",
"costType": "RECURRING_FLAT",
"pricingStrategy": "FLAT",
"priceRanges": [],
"description": "Recurring monthly flat+ppu+ot with contract+ot+tf with included",
"quantity": "1.0000000000",
"salePrice": "10.0000000000",
"wholesalePrice": "10.0000000000",
"totalSalePrice": "10.0000000000"
},
{
"costId": "ea5b596d-950f-427b-87d0-7c82340b468b",
"costTypeCategory": "ONE_TIME",
"frequency": "ONE_TIME",
"costType": "SETUP_FEE",
"pricingStrategy": "FLAT",
"priceRanges": [],
"description": "Recurring monthly flat+ppu+ot with contract+ot+tf with included",
"quantity": "1.0000000000",
"salePrice": "100.0000000000",
"wholesalePrice": "100.0000000000",
"totalSalePrice": "100.0000000000"
},
{
"costId": "6160b953-88f7-49ec-a90d-aef0f9ae5d17",
"costTypeCategory": "RECURRING",
"frequency": "MONTHLY",
"costType": "RECURRING_PER_UNIT",
"pricingStrategy": "UNIT",
"priceRanges": [
{
"min": "0.0000000000"
}
],
"description": "Per User Fee",
"unit": "USER",
"quantity": "0.0000000000",
"salePrice": "8.5000000000",
"wholesalePrice": "8.5000000000",
"totalSalePrice": "0.0000000000"
},
{
"costTypeCategory": "RECURRING",
"frequency": "MONTHLY",
"costType": "INCLUDED",
"pricingStrategy": "UNIT",
"priceRanges": [
{
"min": "1.0000000000",
"max": "1.0000000000"
}
],
"description": "INCLUDED",
"unit": "USER",
"quantity": "1.0000000000",
"salePrice": "0.0000000000",
"wholesalePrice": "0.0000000000",
"totalSalePrice": "0.0000000000"
}
],
"contractConfiguration": {
"minimumServiceLength": 12,
"minimumServiceLengthUnit": "MONTHLY",
"renewalConfiguration": "AUTO_RENEW",
"terminationFee": {
"feeType": "FIXED",
"amount": 400,
"description": "Termination fee!"
},
"terminationFeeGracePeriodUnit": "NONE",
"endOfContractGracePeriodUnit": "INFINITY",
"contractCancellationPeriodUnit": "NONE",
"unitTerms": {},
"blockContractUpgrades": false,
"blockContractDowngrades": false,
"blockSwitchToShorterContract": false,
"keepContractDateOnPlanChange": false,
"isDefault": true
},
"unitDefinitions": [
{
"unit": "USER",
"minimum": "1.0000000000",
"meteredUsage": false,
"allowDecimals": false,
"readOnly": false,
"quantity": "1.0000000000",
"increment": 1,
"pricePerIncrement": false
}
]
}Changes
- breaking
the response's body type changed from no type to
objectfor status - breaking
the response's body type changed from no type to
objectfor status - breaking
the response's body type changed from no type to
objectfor status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status
- breaking