Platform Settings
Function-calling namespace: platformSettings
- Base URL:
https://api.aivida.in - Engine endpoint:
POST /api - Auth: Stack token middleware enabled in
optionalmode.
getCheckoutFee
Source: backend/endpoints/platform-settings/get-checkout-fee
Returns the global patient-facing checkout fee configuration used by the patient cart.
Input Fields
No input fields.
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-d '{
"namespace": "platformSettings",
"apiName": "getCheckoutFee",
"data": {}
}'Example Response
{
"status": "ok",
"data": {
"_id": "global",
"label": "Platform Fee",
"feeType": "flat",
"feeValue": 25,
"isActive": true,
"createdAt": 1773310000000,
"updatedAt": 1773310000000
}
}updateCheckoutFee
Source: backend/endpoints/platform-settings/update-checkout-fee
Updates the global patient-facing checkout fee configuration.
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
label | string | No | Defaults to Platform Fee |
feeType | string | Yes | flat or percent |
feeValue | number | No | Must be >= 0; percent is capped at 100 |
isActive | boolean | No | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-d '{
"namespace": "platformSettings",
"apiName": "updateCheckoutFee",
"data": {
"label": "Service Fee",
"feeType": "percent",
"feeValue": 5,
"isActive": true
}
}'Example Response
{
"status": "ok",
"data": {
"_id": "global",
"label": "Service Fee",
"feeType": "percent",
"feeValue": 5,
"isActive": true,
"createdAt": 1773310000000,
"updatedAt": 1773310500000
}
}