RevKeenDocs
StatusSupport
API Reference
📋 Billing & SubscriptionsBilling Utilities

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.

GET/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.

Related endpoints

  • POST /billing/preview — Generate billing schedule preview
  • GET /billing/intervals — Get billing intervals
  • GET /billing/anchor-rules — Get billing anchor rules

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 a WWW-Authenticate: Bearer challenge.

Authorization

x-api-key<token>

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

Response Body

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
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": 0,      "totals": [        {          "currency": "string",          "count": 0,          "amount_due_minor": 0        }      ],      "items": [        {          "property1": null,          "property2": null        }      ]    },    "dunning": {      "count": 0,      "items": [        {          "property1": null,          "property2": null        }      ]    },    "usage": {      "count": 0,      "items": [        {          "property1": null,          "property2": null        }      ]    }  }}