• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
InvoicePaymentReminder BETA

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

You configure a reminder relative to the payment request due_date.

Properties

Name Description
uid
string

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

relative_scheduled_days
integer

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
message
string

The reminder message.

Max Length 1000 Min Length 1
status
string

Read only The status of the reminder.

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

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?