Get a list of active plans in C3 instance
URL
GET https://contoso-prod-api.azurewebsites.net/api/plans/downloadDetails
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": "062e22ba-d614-4127-ac3a-917eda5855cd",
"ErrorMessage": null,
"ErrorDetail": null,
"Data": [
{
"Name": "Standard NCE Commercial Monthly/Monthly MSRP Plan",
"Description": "Contains only NCE Commercial products with Monhtly term & Monthly Billing cyle with no discount on Retail Price",
"ParentPlanId": null,
"InternalPlanId": "2D1876B1-1234-4FF3-916B-FA3A82F27F03",
"CurrencyCode": "USD",
"PlanStatus": "Success",
"MacroDetails": "Apply X% on Provider Selling Price",
"MacroValue": 2.0000,
"IsPublic": true,
"ShareableUrl": "https://csp-qa-web-01-v2.azurewebsites.net//#/signup/2/2D1876B1-4687-4FF3-916B-FA3A82F27F03",
"PurchaseCurrency": "PlanCurrency (USD)",
"InvoiceCurrency": "PlanCurrency (USD)",
"MarketCode": "US"
}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:
|