Sign in
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 customer gross attributable to legacy revenue-share paid-funded hours. Omitted for fixed-only providers; mixed providers exclude fixed-contract customer economics.

billableHoursnumber

Legacy revenue-share hours in customers' paid-funding band. Omitted for fixed-only providers.

commissionPercentinteger required

Default legacy provider revenue-share percentage. Relevant to legacy records in revenue_share_legacy and mixed responses; fixed records use their locked hourly rate.

compensationMode'revenue_share_legacy' | 'fixed_hourly' | 'mixed'

How provider earnings in this response were calculated. Optional for backward compatibility; absent means revenue_share_legacy. mixed indicates the selected history contains both fixed-hourly and legacy records.

currentMonthEarningsCentsinteger required
currentMonthHoursnumber required
earningHoursnumber

Hours owed to the provider. Fixed-hourly contracts accrue across eligible hosted utilization; legacy revenue share accrues only across paid-funded hours.

freeCreditHoursnumber

Legacy revenue-share hours funded by customer free credits. Omitted for fixed-only providers and excludes fixed-contract hours in mixed responses.

grossEarningsCentsinteger

Total customer sell gross for legacy revenue-share records. Omitted for fixed-only providers; mixed providers exclude fixed-contract customer economics.

pendingEarningsCentsinteger required
totalEarningsCentsinteger required
totalHoursnumber required

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

totalPaidOutCentsinteger required
unpaidHoursnumber

Legacy revenue-share hours beyond customer free credit and paid balance. Omitted for fixed-only providers and excludes fixed-contract hours in mixed responses.

Changes

Changed in 2 of the 20 revisions of this API.6

  • 5dd7f6dfe3655See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 5e47584c75011See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added