NodeRings Docs

Get Provider Revenue

GET
/v1/provider/revenue
Authorization<token>

Bearer token

In: header

X-Organization-ID<token>

Tenant or organization identifier

In: header

Query Parameters

startDate?string

Start date for revenue calculation (inclusive)

Formatdate-time
endDate?string

End date for revenue calculation (inclusive)

Formatdate-time
planId?string

Filter by plan ID (optional)

clientOrganizationId?string

Filter by client organization ID (optional)

includePending?boolean

Include pending/processing payouts in calculations (default: true)

Response Body

application/json

curl -X GET "https://api.nrings.io/v1/provider/revenue?startDate&endDate&planId&clientOrganizationId&includePending" \  -H "Authorization: Bearer {your_token}" \  -H "X-Organization-ID: {your_org_id}"
{
  "totalRevenue": "string",
  "totalPlatformFees": "string",
  "totalNetPayouts": "string",
  "currency": "string",
  "completedPayoutCount": 0,
  "pendingPayoutCount": 0,
  "failedPayoutCount": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z"
}