Create a credit note

Issue a credit note for a paid or partially paid invoice. The credit can be applied via refund to payment method, customer balance, or marked as external.

Related endpoints

• GET /credit_notes — List credit notes
• 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

• 400 invalid_request — malformed payload or failed validation.
• 401 unauthenticated — missing, malformed, or revoked API key.
• 409 conflict — Idempotency-Key collision with a different body, or a concurrent state-transition conflict.

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

curl -X POST "https://api.revkeen.com/v2/credit_notes" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "invoice_id": "660e8400-e29b-41d4-a716-446655440000",
    "amount_minor": 5000,
    "tax_amount_minor": 500,
    "credit_method": "refund_to_payment_method",
    "reason": "Service not provided as agreed",
    "reason_code": "customer_request",
    "cancel_subscription": false,
    "is_prorated": false,
    "proration_days_total": 30,
    "proration_days_unused": 12,
    "idempotency_key": "string",
    "metadata": {},
    "auto_route": false
  }'

{
  "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"
  }
}

{
  "error": "Bad request"
}

{
  "error": "Unauthorized"
}

{
  "error": "Conflict"
}

{
  "error": "Internal server error"
}