Payment reminder sequences

The Payment reminder sequence object represents payment reminder templates.

You can find out more about them in our Help documentation: Invoice Payment Reminders.

Following diagram shows Payment reminder sequences in our data hierarchy:

Payment Reminder SequencePayment ReminderPayment ReminderPayment Reminder

Attributes

created_at string
Response

Timestamp when this payment reminder sequence was created.
creator person
Response

The person who created this payment reminder sequence.
default_sequence boolean
Response Request Parameter `filter` Parameter `sort`

When true, this sequence is used as the default reminder sequence for new invoices.
name string
Response Request

The name of this payment reminder sequence.
organization organization
Response

The organization this payment reminder sequence belongs to.
payment_reminders array of payment reminder
Response

Array of individual payment reminder steps in this sequence, each defining timing and message content.
updated_at string
Response

Timestamp when this payment reminder sequence was last updated.
updater person
Response

The person who last updated this payment reminder sequence.

Operations

GET /api/v2/payment_reminder_sequences
Get payment reminder sequences
POST /api/v2/payment_reminder_sequences
Create a payment reminder sequence
DELETE /api/v2/payment_reminder_sequences/{id}
Deletes a payment reminder sequence
GET /api/v2/payment_reminder_sequences/{id}
Gets a payment reminder sequence
PATCH /api/v2/payment_reminder_sequences/{id}
Update a payment reminder sequence