Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 1.3 KB

invoice-payment-reminder.md

File metadata and controls

31 lines (22 loc) · 1.3 KB

Invoice Payment Reminder

Describes a payment request reminder (automatic notification) that Square sends to the customer. You configure a reminder relative to the payment request due_date.

Structure

InvoicePaymentReminder

Fields

Name Type Tags Description
uid string | undefined Optional A Square-assigned ID that uniquely identifies the reminder within the
InvoicePaymentRequest.
relativeScheduledDays number | undefined Optional The number of days before (a negative number) or after (a positive number)
the payment request due_date when the reminder is sent. For example, -3 indicates that
the reminder should be sent 3 days before the payment request due_date.
Constraints: >= -32767, <= 32767
message string | undefined Optional The reminder message.
Constraints: Minimum Length: 1, Maximum Length: 1000
status string | undefined Optional The status of a payment request reminder.
sentAt string | undefined Optional If sent, the timestamp when the reminder was sent, in RFC 3339 format.

Example (as JSON)

{
  "relative_scheduled_days": null,
  "message": null,
  "status": null
}