Get merchant billing overview
Return overdue invoices, subscriptions in dunning, and high-signal usage invoices for the authenticated merchant. Use this instead of chaining invoices_list + subscriptions_list_in_dunning.
/billing/overviewReturn overdue invoices, subscriptions in dunning, and high-signal usage invoices for the authenticated merchant. Use this instead of chaining invoices_list + subscriptions_list_in_dunning.
Common errors
401 authentication_error— missing, invalid, expired, or revoked credential. Codes:authentication_failed,invalid_api_key,expired_api_key,api_key_revoked,session_invalid,merchant_required. Carries aWWW-Authenticate: Bearerchallenge.
Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.
In: header
Scope: invoices:read
Response Body
application/json
application/json
application/json
curl -X GET "https://api.revkeen.com/v2/billing/overview" \
-H "x-api-key: $REVKEEN_API_KEY"Synthetic documentation data, validated against the response schema; not a live API result.
{ "data": { "overdue_invoices": { "count": 1, "totals": [ { "currency": "GBP", "count": 1, "amount_due_minor": 5880 } ], "items": [ { "id": "5e6f7a8b-9c0d-46b8-afc6-3b4c5d6e7f89", "customer_id": "4d5e6f7a-8b9c-46a7-9eb5-2a3b4c5d6e78", "status": "overdue", "amount_due_minor": 5880, "currency": "GBP", "due_date": "2026-04-30T00:00:00.000Z" } ] }, "dunning": { "count": 1, "items": [ { "id": "6f7a8b9c-0d1e-46c9-80d7-4c5d6e7f8a90", "customer_id": "4d5e6f7a-8b9c-46a7-9eb5-2a3b4c5d6e78", "status": "past_due", "amount_minor": 4900, "currency": "GBP" } ] }, "usage": { "count": 0, "items": [] } }}