RevKeen Docs
Api reference

Get income report

Get income report for the authenticated merchant. Requires 'finance:read' scope.

Related endpoints

  • GET /finance/summary — Get finance summary

Common errors

  • 401 unauthenticated — missing, malformed, or revoked API key.
  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.
GET
/finance/income

Authorization

x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Query Parameters

start_date*string

Start date

end_date*string

End date

group_by?string

Group results by time period

Default"day"
Value in"day" | "week" | "month"
subscription_id?string

Filter by subscription UUID

Formatuuid
status?string

Filter by status

Response Body

application/json

application/json

application/json

application/json

curl "https://api.revkeen.com/v2/finance/income?start_date=2024-01-01&end_date=2024-12-31" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "summary": {
    "total_gross_cents": 0,
    "total_fees_cents": 0,
    "total_net_cents": 0,
    "total_tx_count": 0,
    "total_refund_count": 0
  },
  "rows": [
    {}
  ]
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}
Edit on GitHub