Send a reminder for an invoice

POST

/invoice-reminders

Re-sends the invoice email to its recipient as a payment reminder, including a freshly rendered PDF attachment. Only invoices currently in the sent status, and not yet fully paid or overpaid, are eligible. Each successful reminder updates the invoice's last_sent_at timestamp, which also enforces a cooldown window (configurable via INVOICE_SEND_COOLDOWN_MS, default 60 seconds) between consecutive sends or reminders on the same invoice. The invoice must belong to the authenticated entity — the entity_id from the bearer token is automatically applied as a scoping condition, so callers cannot remind invoices belonging to other entities.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

The reminder email was sent successfully. Returns the invoice's current, up-to-date state, including its refreshed last_sent_at timestamp.

Bodyapplication/json

🟠400

🟠401

🟠404

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location '/invoice-reminders' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "invoice_id": "01HQZR2BKPFQ8MXJVT3G7LWNE"
}'

Response Example

201 - Success

{
    "message": "Invoice reminded successfully",
    "status": "success",
    "data": {
        "id": "01HQZR2BKPFQ8MXJVT3G7LWNE",
        "entity_id": "01HQZR2BKPFQ8MXJVT3G7LWNA",
        "account_id": "01HQZR2BKPFQ8MXJVT3G7LWNC",
        "invoice_number": "INV-01HQZR2BKPFQ8MXJVT3G7LWND",
        "currency": "NGN",
        "description": "Consulting services for Q3 2026",
        "due_date": 1767225600000,
        "status": "sent",
        "issued_at": 1754524800000,
        "fully_paid_at": null,
        "payment_status": "unpaid",
        "payment_intent_id": null,
        "counterparty_id": "01HQZR2BKPFQ8MXJVT3G7LWNF",
        "recipient": {
            "name": "Ada Lovelace",
            "email": "ada@example.com",
            "mobile": "+2348012345678",
            "address": {
                "line_one": "12 Marina Road",
                "line_two": "Suite 4B",
                "city": "Lagos",
                "state": "Lagos State",
                "country": "Nigeria",
                "code": "101233",
                "code_type": "postal"
            }
        },
        "line_items": [
            {
                "id": "01HQZR2BKPFQ8MXJVT3G7LW01",
                "name": "Consulting hours",
                "description": "40 hours at senior rate",
                "unit_amount": 5000,
                "quantity": 40,
                "amount": 200000
            }
        ],
        "applicable_charges": [
            {
                "category": "tax",
                "charge_name": "VAT",
                "description": "7.5% VAT on services",
                "value": 7.5,
                "value_type": "percentage",
                "application_type": "additional",
                "resolved_amount": 15000,
                "basis": "subtotal",
                "sequence": 1
            }
        ],
        "tranches": [
            {
                "id": "01HQZR2BKPFQ8MXJVT3G7LW02",
                "name": "First installment",
                "description": "50% deposit",
                "value": 50,
                "value_type": "percentage",
                "due_date": 1760227200000,
                "resolved_amount": 107500,
                "status": "pending"
            }
        ],
        "client_meta": {
            "external_reference": "ord-2026-0912"
        },
        "customisation_meta": {
            "accent_color": "#1A73E8"
        },
        "total_amount": 215000,
        "total_deductible_charges": 0,
        "total_additional_charges": 15000,
        "viewed_at": null,
        "last_sent_at": 1759200000000,
        "created": 1754524800000,
        "updated": 1759200000000
    }
}

Modified at 2026-09-30 00:29:45

Retrieve a public invoice by invoice number

Send or resend an invoice