v2

latestOpenAPI 3.1.02026-08-07139158192.4 KB
Provider

Provider earnings from usage records (+ payout history)

get/v1/orgs/{orgId}/provider/earnings

Path parameters

orgIdstring required

Response

OK

activeRentalsinteger

Currently-running rentals on this provider's nodes (open usage records).

availableForPayoutCentsinteger required
billableGrossCentsinteger

Total paid-band gross (Σ billableHours × rate) — exactly what commission applies to: totalEarningsCents ≈ billableGrossCents × commission%. Render the gross→net reconciliation from THIS, not grossEarningsCents.

billableHoursnumber

Hours that earned (fell in customers' paid band). Diverges from totalHours when you host free-credit-funded usage.

commissionPercentinteger required
currentMonthEarningsCentsinteger required
currentMonthHoursnumber required
freeCreditHoursnumber

Hours funded by customer free credits (not paid out, per the provider agreement).

grossEarningsCentsinteger

Total gross hosted value before commission and the free-credit waterfall (Σ hosted hours × rate). totalEarningsCents is the net actually earned; the gap is commission + free/unpaid-band usage.

pendingEarningsCentsinteger required
totalEarningsCentsinteger required
totalHoursnumber required

Total hours hosted across all of this provider's usage.

totalPaidOutCentsinteger required
unpaidHoursnumber

Hours the customer ran beyond their free credit + paid balance (uncollected debt, so not paid out).