Payment Reminders

Payment Reminders

Manual payment reminder emails for overdue customer invoices.

Endpoints

IntroductionPOST/payment-reminders/send

Send payment reminder

POST/payment-reminders/send

Send one manual payment reminder email for all overdue unpaid invoices belonging to the selected customer in the active entity.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Body parameters

customer_idstringrequired

Customer id to send one payment reminder for. All overdue unpaid invoices for the customer are included.

Other parametersExpand all

recipient_emailstring<email>optionalnullable

subjectstringoptionalnullable

body_textstringoptionalnullable

payment_instructionsstringoptionalnullable

localestringoptionalnullable

languageoptional

sandbox_skip_deliverybooleanoptional

cURLNode.js SDKFetchPythonGoRubyPHP

Copy

curl -X POST "https://eu.spaceinvoices.com/payment-reminders/send" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_id": "cust_123",
    "language": "en-US"
  }'

Example:

DefaultEditedContent

Response

Returns

message_idstring

statusstring

tostring<email>

subjectstring

overdue_invoice_countinteger

invoice_idsarray of strings

sandbox_skip_deliveryboolean

json

Copy

{
  "message_id": "msg_123",
  "status": "sent",
  "to": "customer@example.com",
  "subject": "Reminder for 2 overdue invoices",
  "overdue_invoice_count": 2,
  "invoice_ids": [
    "inv_123",
    "inv_456"
  ]
}

---