RevKeenDocs
StatusSupport
API Reference
📋 Billing & SubscriptionsCredit Notes

List credit notes

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

GET/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/{id}/lines — List line items on 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.

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

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)

Range1 <= value <= 100
Default20
offset?|

Number of results to skip

Range0 <= value
Default0

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?status=draft&invoice_id=11111111-1111-4111-8111-111111111111" \
  -H "x-api-key: $REVKEEN_API_KEY"

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

{  "data": [    {      "id": "550e8400-e29b-41d4-a716-446655440000",      "credit_note_number": "CN-00042",      "invoice_id": "660e8400-e29b-41d4-a716-446655440000",      "customer_id": "770e8400-e29b-41d4-a716-446655440000",      "amount_minor": 5000,      "tax_amount_minor": 500,      "currency": "USD",      "credit_method": "refund_to_payment_method",      "reason": "Service not provided as agreed",      "reason_code": "customer_request",      "status": "issued",      "refund_id": null,      "subscription_id": null,      "subscription_canceled": false,      "is_prorated": false,      "pdf_url": null,      "issued_at": "2024-01-15T10:30:00Z",      "created_at": "2024-01-14T08:00:00Z",      "updated_at": "2024-01-15T10:30:00Z"    }  ],  "requestId": "00000000-0000-4000-8000-000000000001",  "meta": {    "total": 100,    "limit": 20,    "offset": 0,    "has_more": true  }}

Put this endpoint to work

Manage invoices and orders