Retrieves all active reseller plans available in the C3 instance. Reseller plans define the product catalog, pricing strategy, markup rules, and market-specific offers that can be made available to reseller organizations. The API returns plan metadata, pricing configurations, market information, and plan identifiers required for reseller plan management.
Endpoint
{{apiUrl}}/api/resellerplan/downloadDetails
Endpoint Parameters
| Parameter | Required | Description |
|---|
{{apiUrl}} | Yes | C3 Portal API URL. |
Request Headers
| Header | Value |
|---|
| Authorization | Bearer <access_token> |
| Content-Type | application/json |
Request Body
No request body is required for this endpoint.
Successful Response
A successful request returns all active reseller plans configured in the C3 instance, including plan details, pricing macros, currency settings, and market information.
Sample Response
{
"OperationType": null,
"Status": "Success",
"RequestCorrelationID": "c76d5caf-226d-4784-b5ab-7ffd42dc68e0",
"ErrorMessage": null,
"ErrorDetail": null,
"Data": [
{
"Name": "CSP Offers for Resellers",
"Description": "No margin on Microsoft list price, cost to cost",
"InternalPlanId": "CC6615BC-78DD-4015-A007-22780F23CD9A",
"CurrencyCode": "USD",
"PlanStatus": "Success",
"MacroDetails": "Copy Partner Price",
"MacroValue": 0.0000,
"Attributes": "{\"CanPriceLead\":false,\"CanPriceLag\":false}",
"MarketCode": "US"
}
]
}
Response Properties
| Property | Description |
|---|
| OperationType | Reserved for internal use. Can be ignored. |
| Status | Indicates the result of the request. Possible values: Success or Error. |
| RequestCorrelationID | Unique identifier generated by C3 for request tracking and troubleshooting. |
| ErrorMessage | Error message returned if request processing fails. |
| ErrorDetail | Additional error information. |
| Data | Collection of reseller plan records. |
Reseller Plan Attributes
| Attribute | Description |
|---|
| Name | Name of the reseller plan defined in C3. |
| Description | Description of the reseller plan and its pricing strategy. |
| InternalPlanId | Unique identifier generated by C3 for the reseller plan. |
| CurrencyCode | Currency in which offers are displayed to resellers. |
| PlanStatus | Current status of the reseller plan. |
| MacroDetails | Pricing macro applied to the reseller plan. |
| MacroValue | Value associated with the pricing macro. |
| Attributes | Additional reseller plan settings stored as JSON attributes. |
| MarketCode | Market or country/region associated with the reseller plan. |
MacroDetails Values
| Macro | Description |
|---|
| Copy Partner Price | Uses the partner purchase price as the reseller price. |
| Copy Provider Selling Price | Uses the provider retail price as the reseller price. |
| Apply X% on Partner Price | Applies a configured percentage adjustment to the partner price. |
| Apply X% on Provider Selling Price | Applies a configured percentage adjustment to the provider retail price. |
| Apply X% on Margin | Applies pricing based on a configured margin percentage. |
Error Response
If the request cannot be authenticated or processed, the API returns an error response containing details about the failure.