Skip to content

The offer

Returns the offer the key belongs to.

Terminal window
curl -s https://suly.gg/api/partner/v1/program \
-H "Authorization: Bearer $SULY_KEY"
{
"offerId": "…",
"title": "Partner program for creators",
"status": "live",
"share": { "percent": 30, "base": "of referral deposits" },
"budget": { "funded": "1500.000000", "remaining": "1220.000000" },
"feePercent": 10
}
Field Meaning
status live: the offer is running. ended: the offer is closed; reading still works, codes and accruals are refused
share The percent and what it is counted from, as you promised creators in the offer. For display only: suly.gg does not calculate with it
budget.funded Everything you have put into the offer
budget.remaining What is left for accruals and the fee
feePercent The current suly.gg fee, charged on top of each accrual

Compare budget.remaining with the sum of amount × (1 + feePercent / 100) for the accruals you are about to send. If it is not enough, add budget on the offer page in the business cabinet first; accruals beyond the budget fail with 409 INSUFFICIENT_BUDGET.