SetPartnerCatalogPricing
Activate, reprice or deactivate one Pricing Group item for the authenticated Partner.
Endpoint: https://sive.host/modules/addons/shapi/sh-api.php
Method: POST using application/x-www-form-urlencoded.
Consequential action: may purchase, delete, replace credentials, or remove data. Access is limited to directly owned records or explicitly assigned Partner-managed client services after both relationships are verified.
Important behavior
- Only items, currencies and billing cycles enabled by the assigned Pricing Group are accepted.
- Every Partner retail price is checked against the administrator minimum and maximum.
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
action | string | Yes | Exact SHAPI action name shown in this article. |
api_key | string | Yes | Client API key generated in the Sive.Host SHAPI page. |
api_secret | string | Yes | Secret paired with the API key. Send it only in the POST body. |
type | product|addon|domainregister|domaintransfer|domainrenew | Yes | Catalogue item type. |
relid | positive integer | Yes | WHMCS catalogue item ID. |
active | boolean | Yes | True to activate/reprice; false to deactivate. |
currency_id | positive integer | No | Required for activation; when deactivating, omit to deactivate every currency. |
pricing | JSON object | No | Required for activation. Keys are enabled billing cycles and values are Partner retail prices. |
confirm_change | boolean | Yes | Must be true after the Partner confirms the exact pricing or deactivation. |
Example request
Set the four environment variables from the authenticated SHAPI page. Do not put credentials in source control or URLs.
curl --request POST 'https://sive.host/modules/addons/shapi/sh-api.php' \
--user "${SHAPI_HTTP_USER}:${SHAPI_HTTP_PASSWORD}" \
--header 'Accept: application/json' \
--data-urlencode "action=SetPartnerCatalogPricing" \
--data-urlencode "api_key=${SHAPI_API_KEY}" \
--data-urlencode "api_secret=${SHAPI_API_SECRET}" \
--data-urlencode "type=product" \
--data-urlencode "relid=141" \
--data-urlencode "active=true" \
--data-urlencode "currency_id=1" \
--data-urlencode "pricing={\"monthly\":75,\"annually\":750}" \
--data-urlencode "confirm_change=true"Response
SHAPI always returns JSON. Check result; panel responses can vary by the server module and DirectAdmin version.
{
"result": "success",
"message": {
"action": "SetPartnerCatalogPricing",
"data": "Panel- or action-specific response"
}
}Common errors
Unauthorized access!: source IP or HTTP Basic authentication failed.Invalid API Key or secret.: the customer key is wrong, disabled, or deleted.Unable to retrieve an active service owned by this client.: the service is inactive or belongs to another client.Missing required parameters.: one or more required fields were omitted.
SHAPI documentation version 2.0 — generated from the current endpoint contract.
