Get active Plan Offer Details

Prev Next

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": "12354846-d8c3-7876d-817a-42f6d9398deb",
    "ErrorMessage": null,
    "ErrorDetail": null,
    "Data": [
        {
            "PlanName": "Standard NCE Commercial Monthly/Monthly MSRP Plan",
            "ProviderName": "Microsoft",
            "FriendlyOfferName": "Dynamics 365 Commerce",
            "OfferName": "Dynamics 365 Commerce",
            "Description": "User subscription that includes Dynamics 365 Commerce, Enterprise Edition",
            "ConsumptionType": "Quantity",
            "ProviderSettings": "{\"ProviderCategory\" :\"commercial\",\"Segment\" : \"commercial\", \"MinimumQuantity\" : 20,\"MaximumQuantity\" : 10000000,\"IsTrail\" : \"FALSE\",\"HasAddOns\" : \"FALSE\",\"UpgradeTargetOffers\" :[\r\n  \"CFQ7TTC0LH2Z:0002\"\r\n],\"IsAutoRenewable\" : \"TRUE\",\"IsAvailableForPurchase\" : \"TRUE\",\"AttestationType\" : null,\"EnforceAttestation\" : \"FALSE\"}",
            "Settings": "{\"IsAddon\" : \"false\"}",
            "BillingCycle": "Monthly",
            "CurrencyCode": "EUR",
            "CurrencySymbol": "€",
            "PriceforPartner": 165.1400,
            "RetailPrice": 235.920000000000,
            "SalePrice": 202.2000,
            "CategoryName": "OnlineServicesNCE",
            "ProviderReferenceId": "NL:CFQ7TTC0LH2Z:0002",
            "InternalPlanProductId": "12345-3558-4D8D-9B5E-4C16C2B01B10",
            "IsimmediateProvisioning": true,
            "OnPurchaseBillingAction": "Prorate",
            "OnReleaseBillingAction": "Prorate",
            "Isactive": true,
            "Isaddon": false,
            "BillingTypename": "Price",
            "Validity": "1Month(s)",
            "MacroValue": null,
            "MacroName": null,
            "LastPriceChangeHappendon": "2024-10-02T16:05:36.033",
            "MarketCode": "NL",
            "IsTrialOffer": false
        },

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:

Attribute

Description

PlanName

Name of plan defined in C3

ProviderName

Microsoft or Partner

FriendlyOfferName

Friendly name defined inside plan for an offer which is visible on customer side

OfferName

Name of offer defined inside the plan coming from MS price list

Description

Description of the offer

ConsumptionType

Quantity or Usage

ProviderSettings

Offer’s attributes inherited from MS price list

Settings

Offer’s attributes

BillingCycle

Monthly/Annual/One-time

CurrencyCode

Invoice currency

PriceforPartner

Price per unit (license) from Microsoft/Provider

RetailPrice

Estimated retail price

SalePrice

Sale Price defined by partner for an offer

Categoryname

Possible Values are:

  • OnlineServices 
  • AzurePlan
  • PerpetualSoftware
  • OnlineServicesNCE
  • SoftwareSubscriptions
  • Azure
  • Custom
  • Bundles

Providerreferenceid

Offer Id of the product

InternalPlanProductIdUnique identifier for plan-offer generated by C3

Isimmediateprovisioning

If offer will get provisioned immediately after purchase

Possible values: True/False

Onpurchasebillingaction

Possible billing action if in case of new license purchase change: Prorate/Full Charge

Onreleasebillingaction

Possible billing action if in case of license change: Prorate/Full Charge/No Refund

Isactive

If offer is still purchasable in Partner Center: True/False

Isaddon

True/False

billingtypename

Price/Percentage/Markup

validity

Validity of an offer

macrovalue

Value of Macro defined for a plan

macroname

Name of Macro applied on a plan

Possible Values are :
Copy Partner Price
Copy Provider Selling Price

Apply X% on Partner Price

Apply X% on Provider Selling Price

Apply X% on Margin

Lastpricechangehappenedon

Date of last price change, if any

MarketCodeMarket for the offer
IsTrialOfferTrue/False