---
title: "Preview a payment reminder email"
method: POST
path: "/companies/{company}/invoices/{invoice}/reminder-preview"
tags: ["Invoices"]
---

# Preview a payment reminder email

`POST /companies/{company}/invoices/{invoice}/reminder-preview`

## Request

- Base URL: `https://api.factuarea.com/v1`
- URL: `https://api.factuarea.com/v1/companies/{company}/invoices/{invoice}/reminder-preview`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Renders the HTML, subject, and resolved recipients of the reminder email without sending it. Same override fields as send-reminder.

## Path parameters

- `company` string, uuid, required
- `invoice` string, uuid, required

## Headers

- `Factuarea-Version` string, date

## Request body

- SendInvoiceReminderV1Request: Fields of the payment reminder, shared by `POST /v1/companies/{company}/invoices/{invoice}/send-reminder` and `POST /v1/companies/{company}/invoices/{invoice}/reminder-preview`. Every field is optional: without overrides the standard payment reminder template is used.
  - `email` string, email, nullable: Recipient other than the client email.
  - `subject` string, nullable: Custom subject for the reminder.
  - `message` string, nullable: Additional message for the reminder body.
  - `cc` string[], nullable: Carbon copy addresses.
  - `bcc` string[], nullable: Blind carbon copy addresses.
  - `attach_pdf` boolean, nullable: Per-send override for "attach the invoice PDF". If omitted (or `null`), the company default (`email_settings`) is used.
  - `stripe_payment_button` boolean, nullable: Per-send override for the "Stripe payment button". If omitted (or `null`), the company default is used.

## Response `200`

- object
  - `data` InvoiceReminderPreview, required: Preview of the payment reminder email (subject + HTML + resolved recipients) without sending it. Useful to show exactly what would be sent before triggering `POST .../send-reminder`.
    - `subject` string, required: Subject of the reminder email.
    - `html` string, required: Rendered HTML body of the email.
    - `from` string, email, required: Sender address.
    - `from_name` string, required: Human-readable sender name.
    - `to` string, email, required: Resolved main recipient.
    - `cc` string[], required: Carbon copy addresses. Empty `[]` when there are none.
    - `bcc` string[], required: Blind carbon copy addresses. Empty `[]` when there are none.
    - `status` string, required: Current status of the invoice (e.g. `issued`, `overdue`). Before API version `2026-10-01` the issued status is published as `sent`.
    - `invoice_number` string, required: Invoice number.
    - `total` string, required: Total amount of the invoice (EUR), as a 2-decimal string.
    - `due_date` string, date, nullable, required: Due date (YYYY-MM-DD), or `null` if not applicable.
    - `public_url` string, uri, nullable, required: Public link to the invoice, or `null` if the link is not active.
    - `public_link_active` boolean, required: Indicates whether the public link is active.
    - `public_link_expires_at` string, date-time, nullable, required: When the public link expires (ISO 8601), or `null`.
    - `reminders_sent` integer, required: Number of reminders already sent for this invoice.
    - `last_reminder_sent_at` string, date-time, nullable, required: When the last reminder was sent (ISO 8601), or `null` if none has been sent.
    - `cooldown_active` boolean, required: Indicates whether there is an active cooldown period that prevents sending another reminder yet.

## Other responses

- `400`: `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company.
- `422`: Validation failed, or the invoice cannot undergo the requested state transition (e.g. marking an already-paid invoice as paid, or editing an issued invoice — use a corrective instead). The `error.param` field identifies which input is invalid, if any. Issuing or annulling an invoice can also be rejected with `verifactu_not_eligible`: either a field of the invoice does not fit its billing record, or — only when the company has VeriFactu enabled in NO VERI*FACTU mode — it has no usable signing certificate (`error.subcode: signing_certificate_unavailable`; `error.param` is `certificate`, `representation` or `system_certificate`, depending on what is missing); in both cases the invoice stays exactly as it was.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)