---
title: "Get Plan Macro"
slug: "get-plan-macro"
updated: 2024-10-27T01:00:15Z
published: 2024-10-27T01:00:15Z
canonical: "docs.cspcontrolcenter.com/get-plan-macro"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cspcontrolcenter.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Plan Macro

Get the list of Plan Macros used as parameters to define the sale price for offers during reseller plan creation

## URL

https://contoso-prod-api.azurewebsites.net/api/ResellerPlan/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 plan macro is as follows:

```json
{
    "OperationType": null,
    "Status": "Success",
    "RequestCorrelationID": "7cc6756d-3a33-437e-8e59-69422b547889",
    "ErrorMessage": null,
    "ErrorDetail": null,
    "Data": [
        {
            "ID": 1,
            "Name": "Copy Partner Price"
        },
        {
            "ID": 2,
            "Name": "Copy Provider Selling Price"
        },
        {
            "ID": 3,
            "Name": "Apply X% on Partner Price"
        },
        {
            "ID": 4,
            "Name": "Apply X% on Markup"
        },
        {
            "ID": 5,
            "Name": "Apply X% on Provider Selling Price"
        }
    ]
}
```

### 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** \| \| --- \| --- \| \| **ID** \| Record Serial number in API output \| \| **Name** \| Name of Marco, explanation of each macro below - **Copy Partner Price**: This will apply your cost as the sale price on all the products part of your plan. - **Copy Provider Selling Price**: This will apply the retail price as the sale price on all the products part of the plan. - **Apply X % on Partner Price**: This will allow you to add a positive/negative percentage margin, keeping your cost as the base price. - **Apply X % on Markup**: This will calculate the difference between your cost and retail price and allow you to add a positive/negative percentage margin on that difference value. - **Apply X % on Provider Selling Price**: This will allow you to add a positive/negative percentage margin, keeping the retail cost as the base price. \| |
| **Attribute** | **Description** |
| **ID** | Record Serial number in API output |
| **Name** | Name of Marco, explanation of each macro below - **Copy Partner Price**: This will apply your cost as the sale price on all the products part of your plan. - **Copy Provider Selling Price**: This will apply the retail price as the sale price on all the products part of the plan. - **Apply X % on Partner Price**: This will allow you to add a positive/negative percentage margin, keeping your cost as the base price. - **Apply X % on Markup**: This will calculate the difference between your cost and retail price and allow you to add a positive/negative percentage margin on that difference value. - **Apply X % on Provider Selling Price**: This will allow you to add a positive/negative percentage margin, keeping the retail cost as the base price. |