RevKeenDocs
StatusSupport
API Reference
📋 Billing & SubscriptionsCredit Notes

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.

POST/credit_notes

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/{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 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.
  • 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.

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 for creating a credit note against an invoice, specifying the amount, reason, and whether to issue a refund.

Response Body

application/json

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

Put this endpoint to work

Manage invoices and orders