- 16 Jul 2023
- 1 Minute to read
- Print
- DarkLight
- PDF
Get active Plan Offer Details
- Updated on 16 Jul 2023
- 1 Minute to read
- Print
- DarkLight
- PDF
Get list of offers inside a Plan
URL
GET https://contoso-prod-api.azurewebsites.net/api/plans/{{InternalPlanId}}/downloadplanoffersDetails
Request headers
Key | Value |
Authorization | Bearer <access_token> |
Content-Type | Application/json |
Request body
The request doesn’t require any parameters / body
Response body
An example response for the request to get active customers is as follows:
{
"OperationType": null,
"Status": "Success",
"RequestCorrelationID": "b8080e2f-3376-4408-847c-c8354634d190",
"ErrorMessage": null,
"ErrorDetail": null,
"Data": [
{
"PlanName": "Nonprofit - Legacy Licensing - Discount 00.0%",
"ProviderName": "Microsoft",
"FriendlyOfferName": "Dynamics 365 Customer Insights Attach (Nonprofit Staff Pricing)",
"OfferName": "Dynamics 365 Customer Insights Attach (Nonprofit Staff Pricing)",
"Description": "Subscription that includes Dynamics 365 Customer Insights Attach",
"ConsumptionType": "Quantity",
"ProviderSettings": "{\"ProviderCategory\" :\"Charity\", \"MinimumQuantity\" : 1,\"MaximumQuantity\" : 10000000,\"IsTrail\" : \"FALSE\",\"HasAddOns\" : \"TRUE\",\"Limit\" : 0,\"LimitUnitOfMeasure\" :\"None\",\"IsAutoRenewable\" : \"TRUE\",\"IsAvailableForPurchase\" : \"TRUE\"}",
"Settings": "{\"IsAddon\" : \"false\"}",
"BillingCycle": "Monthly",
"CurrencyCode": "USD",
"CurrencySymbol": "$",
"PriceforPartner": 225.0000,
"RetailPrice": 250.000000000000,
"SalePrice": 250.0000,
"categoryname": "OnlineServices",
"providerreferenceid": "8a0b610b-cf54-4188-980e-7492926b4c13",
"isimmediateprovisioning": true,
"onpurchasebillingaction": “Prorate”,
"onreleasebillingaction": “Prorate”,
"isactive": true,
"isaddon": false,
"billingtypename": "Price",
"validity": “1 Year(s)”1,
"macrovalue": 0.0000,
"macroname": "Apply X% on Provider Selling Price",
"Lastpricechangehappenedon": null
},
Here is the explanation for the properties in the response (JSON)
Property | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||
OperationType | Can be ignored | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Status | Indicates the status of the request. Possible values – Success / Error | ||||||||||||||||||||||||||||||||||||||||||||||||||||
RequestCorrelationID | Internal ID generated by C3 for correspondence for troubleshooting issues, if any. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
ErrorMessage | Message in case the request runs into an error during processing | ||||||||||||||||||||||||||||||||||||||||||||||||||||
ErrorDetail | Additional detail related to the error in case there is an error while processing the request | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Data | Contains a list of customer objects represented by the following attributes:
|