RevKeen Docs
Api reference

List line items on a credit note

Returns the line items attached to a credit note. Each line describes a portion of the invoice that the credit applies to — either a whole invoice line or a prorated slice. Use this to reconstruct the credit's effect per invoice line (for example, when displaying the credit breakdown in your own UI).


Related endpoints

  • GET /credit_notes — List credit notes
  • 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
  • POST /credit_notes/preview — Preview a credit note without creating it

Common errors

  • 401 unauthenticated — missing, malformed, or revoked API key.
  • 404 resource_missing — the referenced resource does not exist or is not visible to your 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/{id}/lines
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

Path Parameters

id*string

Credit note UUID

Formatuuid

Query Parameters

limit?integer
Default100
Range1 <= value <= 100

Response Body

application/json

curl "https://api.revkeen.com/v2/credit_notes/00000000-0000-0000-0000-000000000000/lines" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "object": "list",
  "data": [
    {
      "id": "abcd1234-e29b-41d4-a716-446655440000",
      "object": "credit_note_line",
      "credit_note_id": "9828bde5-a449-4e07-bec6-fe632bf7f0f3",
      "invoice_line_item_id": "31d3bb6c-3ad5-4317-93f6-7349092767e9",
      "description": "Pro Plan subscription — prorated for unused 12 days",
      "quantity": 1,
      "unit_amount_minor": 5000,
      "total_amount_minor": 5000,
      "metadata": {
        "property1": null,
        "property2": null
      },
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "has_more": true,
  "url": "string"
}
Empty
Empty