RevKeen Docs
Api reference

List invoices

List invoices with pagination and filtering.

Related endpoints

  • PUT /invoices/external/batch — Batch upsert invoices by external ID
  • POST /invoices — Create invoice
  • GET /invoices/{id} — Get invoice
  • PATCH /invoices/{id} — Update invoice
  • DELETE /invoices/{id} — Delete invoice
  • POST /invoices/{id}/refund — Refund invoice
  • POST /invoices/{id}/reject — Reject invoice
  • GET /invoices/{id}/comments — List invoice comments

Pagination

Offset-based with limit (default 25, max 100) and offset. The response pagination block includes total and hasMore. See the pagination guide for SDK auto-paging helpers.

GET
/invoices

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

status?string

Filter by invoice status

customerId?string

Filter by customer ID

limit?integer

Maximum number of results (1-100)

Default20
Range1 <= value <= 100
offset?|

Number of results to skip

Default0
Range0 <= value

Response Body

application/json

curl "https://api.revkeen.com/v2/invoices" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "customer_uuid": "e7eefd45-cb13-4c62-b229-e5bbc1362123",
      "invoice_number": "string",
      "total_minor": 0,
      "currency": "string",
      "allowed_methods": [
        "string"
      ],
      "status": "string",
      "due_date": "string",
      "custom_fields": {},
      "external_source": "practicehub",
      "external_type": "appointment",
      "external_id": "INV-12345",
      "subscription_terms": {
        "collection_method": "charge_automatically",
        "start_mode": "when_paid",
        "start_date": "string",
        "duration_type": "until_cancelled",
        "duration_count": 12,
        "end_date": "string",
        "first_payment_behavior": "charge_first_cycle_now"
      },
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "requestId": "string"
}
Edit on GitHub