RevKeen Docs
Api reference

List credit notes

Retrieve a paginated list of credit notes with optional filters. Results are ordered by creation date (newest first).

Related endpoints

  • POST /credit_notes — Create a credit note
  • GET /credit_notes/{id} — Get credit note by ID
  • POST /credit_notes/{id}/void — Void a credit note
  • GET /credit_notes/invoice/{invoice_id}/eligibility — Check credit note eligibility for an invoice
  • GET /credit_notes/transaction/{transaction_id}/reversal-eligibility — Check reversal eligibility for a transaction
  • GET /credit_notes/{id}/lines — List line items on a credit note
  • POST /credit_notes/preview — Preview a credit note without creating it

Common errors

  • 401 unauthenticated — missing, malformed, or revoked API key.

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
/credit_notes

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 credit note status

Value in"draft" | "pending" | "issued" | "applied" | "voided"
invoice_id?string

Filter by invoice ID

Formatuuid
customer_id?string

Filter by customer ID

Formatuuid
credit_method?string

Filter by credit method

Value in"refund_to_payment_method" | "customer_balance" | "external"
created_after?string

ISO 8601 date - only credit notes created after this date

created_before?string

ISO 8601 date - only credit notes created before this date

limit?number

Number of results to return (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/credit_notes" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "credit_note_number": "string",
      "invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32",
      "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
      "amount_minor": 0,
      "tax_amount_minor": 0,
      "currency": "string",
      "status": "string",
      "reason": "string",
      "reason_code": "string",
      "credit_method": "string",
      "pdf_url": "string",
      "issued_at": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "requestId": "string"
}
Empty
Empty
Edit on GitHub