POST
/api/v2/referrals/programs/{programId}/simulatePOST /api/v2/referrals/programs/{programId}/simulate
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| programId (path) | string (uuid) | Yes |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| LevelCode | string | Yes | |
| Draft | object | No | |
| CreditedAmount | unknown | No | |
| SettledFee | unknown | No | |
| ProviderCost | unknown | No | |
| EligibleVolumeRemaining | unknown | No | |
| PaidCardFee | unknown | No | |
| CompletesQualification | boolean | No | |
| Team | boolean | No |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| CalculationVersion | string | Yes | |
| Currency | string | Yes | |
| Basis | string | Yes | |
| EligibleAmount | unknown | Yes | |
| InviterReward | unknown | Yes | |
| CustomerRecurringReward | unknown | Yes | |
| SubpartnerReward | unknown | Yes | |
| CompanyRetained | unknown | Yes | |
| QualificationReward | unknown | Yes | |
| WelcomeReward | unknown | Yes | |
| Status | string | Yes | |
| Warnings | array of string | Yes |
Example request
curl -X POST "https://{base_url}/api/v2/referrals/programs/{programId}/simulate" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"LevelCode":"…"}'This page is generated from the live OpenAPI specification and always matches the current API.