RevKeenDocs
StatusSupport
API Reference
📋 Billing & SubscriptionsCredit Notes

Preview a credit note without creating it

Compute what a credit note would look like against a specific invoice without persisting anything. Use this to validate amounts and show a "here's what will happen" UI before the merchant commits. No side effects — no DB writes, no events emitted, no refunds initiated. Mirrors Stripe's POST /v1/credit_notes/preview.

POST/credit_notes/preview

Compute what a credit note would look like against a specific invoice without persisting anything. Use this to validate amounts and show a "here's what will happen" UI before the merchant commits. No side effects — no DB writes, no events emitted, no refunds initiated. Mirrors Stripe's POST /v1/credit_notes/preview.

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/{id}/lines — List line items on a credit note

Common errors

  • 400 invalid_request — malformed payload or failed validation.
  • 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.

Idempotency

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Parameters to preview a credit note without persisting it. The response shows what the credit note would look like if created with these fields.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X POST "https://api.revkeen.com/v2/credit_notes/preview" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "invoice_id": "11111111-1111-4111-8111-111111111111",
    "amount_minor": 5000
  }'

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

{  "data": {    "object": "credit_note_preview",    "invoice_id": "00000000-0000-4000-8000-000000000001",    "proposed_amount_minor": 0,    "proposed_tax_amount_minor": 0,    "currency": "string",    "invoice": {      "id": "00000000-0000-4000-8000-000000000001",      "total_minor": 0,      "amount_paid_minor": 0,      "amount_due_minor": 0,      "previously_credited_minor": 0,      "max_creditable_minor": 0    },    "after_credit": {      "new_amount_due_minor": 0,      "new_amount_credited_minor": 0,      "would_leave_outstanding": true    },    "exceeds_max_creditable": true,    "credit_method": "string"  }}

Put this endpoint to work

Manage invoices and orders