RevKeenDocs
StatusSupport
API Reference
Customer Portal

Retrieve an invoice

Returns an invoice owned by the authenticated customer.

GET/customer-portal/invoices/{id}

Returns an invoice owned by the authenticated customer.

Related endpoints

  • POST /customer-portal/sessions — Create a customer-portal session
  • GET /customer-portal/customer — Retrieve the authenticated customer
  • GET /customer-portal/subscriptions — List the authenticated customer's subscriptions
  • GET /customer-portal/subscriptions/{id} — Retrieve a subscription
  • POST /customer-portal/subscriptions/{id}/cancel — Cancel a subscription
  • GET /customer-portal/invoices — List the authenticated customer's invoices
  • GET /customer-portal/mandates — List the authenticated customer's Direct Debit mandates
  • POST /customer-portal/mandates/{id}/re-authorize — Re-authorise a Direct Debit mandate with new bank details

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.
  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.

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

Path Parameters

id*string

Invoice ID.

Formatuuid

Response Body

application/json

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/customer-portal/invoices/11111111-1111-4111-8111-111111111111" \
  -H "Authorization: Bearer $REVKEEN_PORTAL_TOKEN"

Synthetic documentation data, validated against the response schema; not a live API result.

{  "data": {    "id": "f1a2b3c4-d5e6-4270-8a9b-0c1d2e3f4a21",    "object": "invoice",    "invoice_number": "INV-0042",    "status": "paid",    "currency": "GBP",    "subtotal": 4900,    "tax_amount": 980,    "discount_amount": 0,    "total": 5880,    "amount_paid": 5880,    "amount_due": 0,    "invoice_date": "2026-04-16T10:00:00.000Z",    "due_date": "2026-04-16T10:00:00.000Z",    "paid_at": "2026-04-16T10:02:00.000Z",    "created_at": "2026-04-16T10:00:00.000Z"  }}

Put this endpoint to work

Manage customers