RevKeenDocs
StatusSupport
API Reference
📋 Billing & SubscriptionsCredit Notes

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).

GET/credit_notes/{id}/lines

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

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.
  • 403 authorization_error — the caller is identified but the action is denied. Codes include insufficient_permissions, ip_not_allowed, merchant_mismatch, and origin_not_allowed.
  • 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.

Authorization

apiKey
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

Credit note UUID

Formatuuid

Query Parameters

limit?integer

Maximum number of line items to return (1-100, default 100).

Range1 <= value <= 100
Default100

Response Body

application/json

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/credit_notes/11111111-1111-4111-8111-111111111111/lines?limit=100" \
  -H "x-api-key: $REVKEEN_API_KEY"

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

{  "object": "list",  "data": [    {      "id": "abcd1234-e29b-41d4-a716-446655440000",      "object": "credit_note_line",      "credit_note_id": "00000000-0000-4000-8000-000000000001",      "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": "2026-09-01T12:00:00Z"    }  ],  "has_more": true,  "url": "https://example.com/webhooks/revkeen"}

Put this endpoint to work

Manage invoices and orders