<- Object

Object

InvoicePaymentReminder

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

You configure a reminder relative to the payment request due_date.

Link to section

Properties

Link to section

uid

string

Read only A Square-assigned ID that uniquely identifies the reminder within the InvoicePaymentRequest.

Link to section

relative_scheduled_days

integer(32-bit)

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.

Min
-32767
Max
32767
Link to section

message

string

The reminder message.

Min Length
1
Max Length
1000
Link to section

status

string

Read only The status of the reminder.

Link to section

sent_at

string

Read only If sent, the timestamp when the reminder was sent, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00