square_api_client/models/
invoice_payment_reminder.rs

1//! Model struct for InvoicePaymentReminder type.
2
3use serde::{Deserialize, Serialize};
4
5use super::{enums::InvoicePaymentReminderStatus, DateTime};
6
7/// Describes a payment request reminder (automatic notification) that Square sends to the customer.
8///
9/// You configure a reminder relative to the payment request `due_date`.
10#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
11pub struct InvoicePaymentReminder {
12    /// The reminder message.
13    ///
14    /// Min Length: 1, Max Length: 1000
15    pub message: Option<String>,
16    /// The number of days before (a negative number) or after (a positive number) the payment
17    /// request `due_date` when the reminder is sent. For example, -3 indicates that the reminder
18    /// should be sent 3 days before the payment request `due_date`.
19    ///
20    /// Min: -32767, Max: 32767
21    pub relative_scheduled_days: Option<i32>,
22    /// **Read only** If sent, the timestamp when the reminder was sent, in RFC 3339 format.
23    pub sent_at: Option<DateTime>,
24    /// **Read only** The status of the reminder.
25    pub status: Option<InvoicePaymentReminderStatus>,
26    /// **Read only** A Square-assigned ID that uniquely identifies the reminder within the
27    /// `InvoicePaymentRequest`.
28    pub uid: Option<String>,
29}