Get Plan Macro

Prev Next

Retrieves the list of supported pricing macros that can be used when creating reseller plans. Pricing macros define how the selling price of an offer is calculated relative to the partner cost, retail price, or markup. These macros enable automated pricing strategies across all offers assigned to a reseller plan.

Endpoint

{{apiUrl}}/api/common/resellerPlanMacros

Endpoint Parameters

ParameterRequiredDescription
{{apiUrl}}YesC3 Portal API URL.

Request Headers

HeaderValue
AuthorizationBearer <access_token>
Content-Typeapplication/json

Request Body

No request body is required for this endpoint.

Successful Response

A successful request returns all pricing macros supported by C3 for reseller plan creation. These macros determine how sales prices are calculated for offers assigned to a reseller plan.

Sample Response

{
  "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"
    }
    {
      "ID": 6,
      "Name": "Apply X% Margin on Partner Price"
    }
    {
      "ID": 7,
      "Name": "Apply X% ERP on List Price"
    }
  ]
}

Response Properties

PropertyDescription
OperationTypeReserved for internal use. Can be ignored.
StatusIndicates the result of the request. Possible values: Success or Error.
RequestCorrelationIDUnique identifier generated by C3 for request tracking and troubleshooting.
ErrorMessageError message returned if request processing fails.
ErrorDetailAdditional information related to the error.
DataCollection of supported reseller plan pricing macros.

Pricing Macro Attributes

AttributeDescription
IDUnique identifier for the pricing macro.
NameName of the pricing macro used during reseller plan creation.

Supported Pricing Macros

Macro NameDescription
Copy Partner PriceSets the selling price equal to the partner acquisition cost. No markup or margin is applied.
Example: Partner price = 10, Provider selling price = 15
Sale price: 10
Copy Provider Selling PriceSets the selling price equal to the provider's suggested retail price (ERP).
Example: Partner price = 10, Provider selling price = 15
Sale price: 15
Apply X% on Partner PriceApplies a positive or negative percentage adjustment to the partner cost. The partner cost is used as the base value.
Example: Partner price = 10, Provider selling price = 15, Percentage(X) = 20
Sale price: 10+(10* (20/100)) = 12
Apply X% on MarkupCalculates the markup difference between partner cost and provider selling price, then applies a percentage adjustment on that markup amount.
Example: Partner price = 10, Provider selling price = 15, Percentage(X) = 20
Sale price: 10 + ((15 - 10) * (20 / 100)) = 11
Apply X% on Provider Selling PriceApplies a positive or negative percentage adjustment to the provider selling price. The retail price is used as the base value.
Example: Partner price = 10, Provider selling price = 15, Percentage(X) = -20
Sale price: 15 + (15 * (-20 / 100)) = 12
Apply X% Margin on Partner Price
Calculates the sale price by applying the specified margin percentage to the partner price.

Formula: Sale Price = Partner Price / (1 - (X / 100))


Example: Partner Price = 10, Provider Selling Price = 15, X = 20
Sale Price: 10 / (1 - (20 / 100)) = 12.5

Apply X% ERP on List Price

Calculates the sale price as X% of the ERP (Retail Price) added to the Cost to Partner.

Formula: Sale Price = ((X × Retail Price) / 100) + Cost to Partner


Example: Cost to Partner = 96, ERP Price = 100, X = 3
Sale Price: ((3 × 100) / 100) + 96 = 99


If the Partner Margin % is less than or equal to X, the calculated sale price is overridden and the Cost to Partner is used as the Sale Price.

Partner Margin % Formula: ((Retail Price - Cost To Partner) / Retail Price) × 100


Example: Retail Price = 100, Cost to Partner = 96,
Partner Margin % = ((100 - 96) / 100) × 100 = 4%
If X = 4 or greater than 4, the Sale Price will be 96.

Error Response

If the request cannot be authenticated or processed, the API returns an error response containing details about the failure.

Example Use Cases

  • Retrieve supported pricing macros before creating a reseller plan.