QuotePartnerClientCreditChange

Quote a ResellersCenter invoice-credit adjustment for one client assigned to the authenticated Partner.

Endpoint: https://sive.host/modules/addons/shapi/sh-api.php

Method: POST using application/x-www-form-urlencoded.

Read-only action. Access is limited to directly owned records or explicitly assigned Partner-managed client services after both relationships are verified.

Important behavior

ResellersCenter invoice mode must be enabled. Remove requires enough client credit; assign can record money the client paid directly to the Partner.
The response contains the client before/after balance and the exact confirmation required by ChangePartnerClientCredit.

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.
`partner_clientid`	positive integer	Yes	Active client ID returned by ListPartnerClients.
`operation`	assign\|remove	Yes	Assign mirrors a paid RC Add Funds invoice; remove deducts RC client credit. Neither changes the Partner Sive.Host credit balance.
`amount`	decimal	Yes	RC invoice-credit adjustment in the client account currency.
`reason`	string 3-500 characters	Yes	Auditable reason for the credit transfer.
`reference`	unique string 8-64 characters	Yes	Caller-generated idempotency reference.

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=QuotePartnerClientCreditChange" \
  --data-urlencode "api_key=${SHAPI_API_KEY}" \
  --data-urlencode "api_secret=${SHAPI_API_SECRET}" \
  --data-urlencode "partner_clientid=1606" \
  --data-urlencode "operation=assign" \
  --data-urlencode "amount=100.00" \
  --data-urlencode "reason=Customer service goodwill credit" \
  --data-urlencode "reference=partner-credit-20260817-001"

Response

SHAPI always returns JSON. Check result; panel responses can vary by the server module and DirectAdmin version.

{
    "result": "success",
    "message": {
        "action": "QuotePartnerClientCreditChange",
        "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.

Base de Conhecimento