API Documentation
Payment reminder sequences ¶
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:
Supported filter params
- default_sequence
Supported sort params
- default_sequence
GET /api/v2/payment_reminder_sequences
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "1",
"type": "payment_reminder_sequences",
"attributes": {
"name": "Reminder sequence",
"created_at": "2025-08-02T06:06:45.350+02:00",
"updated_at": "2025-08-02T06:06:45.350+02:00",
"default_sequence": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "812"
}
},
"creator": {
"meta": {
"included": false
}
},
"updater": {
"meta": {
"included": false
}
},
"payment_reminders": {
"meta": {
"included": false
}
}
}
}
],
"links": {
"first": "http://api-test.productive.io/api/v2/payment_reminder_sequences?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://api-test.productive.io/api/v2/payment_reminder_sequences?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200
}
}
Get payment reminder sequencesGET/api/v2/payment_reminder_sequences
GET /api/v2/payment_reminder_sequences/2
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "2",
"type": "payment_reminder_sequences",
"attributes": {
"name": "Reminder sequence",
"created_at": "2025-08-02T06:06:45.404+02:00",
"updated_at": "2025-08-02T06:06:45.404+02:00",
"default_sequence": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "813"
}
},
"creator": {
"meta": {
"included": false
}
},
"updater": {
"meta": {
"included": false
}
},
"payment_reminders": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Gets a payment reminder sequenceGET/api/v2/payment_reminder_sequences/{id}
- id
number
(required) Example: 1payment reminder sequence id
POST /api/v2/payment_reminder_sequences
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "payment_reminder_sequences",
"attributes": {
"name": "test name"
},
"relationships": {}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "4",
"type": "payment_reminder_sequences",
"attributes": {
"name": "test name",
"created_at": "2025-08-02T06:06:45.462+02:00",
"updated_at": "2025-08-02T06:06:45.462+02:00",
"default_sequence": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "814"
}
},
"creator": {
"meta": {
"included": false
}
},
"updater": {
"meta": {
"included": false
}
},
"payment_reminders": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
POST /api/v2/payment_reminder_sequences
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "payment_reminder_sequences",
"attributes": {
"name": ""
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
}
]
}
POST /api/v2/payment_reminder_sequences
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "403",
"code": "payment_reminders_unavailable",
"title": "Access Denied",
"detail": "Feature payment reminders unavailable",
"source": {}
}
]
}
Create a payment reminder sequencePOST/api/v2/payment_reminder_sequences
- name
string
(required) Example: Namename
- default_sequence
boolean
(optional) Example: truedefines if sequence is default for its organization
PATCH /api/v2/payment_reminder_sequences/7
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "payment_reminder_sequences",
"attributes": {
"name": "New name"
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "7",
"type": "payment_reminder_sequences",
"attributes": {
"name": "New name",
"created_at": "2025-08-02T06:06:45.601+02:00",
"updated_at": "2025-08-02T06:06:45.611+02:00",
"default_sequence": false
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "817"
}
},
"creator": {
"meta": {
"included": false
}
},
"updater": {
"meta": {
"included": false
}
},
"payment_reminders": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
PATCH /api/v2/payment_reminder_sequences/8
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "payment_reminder_sequences",
"attributes": {
"name": ""
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/name"
}
}
]
}
PATCH /api/v2/payment_reminder_sequences/9
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "403",
"code": "payment_reminders_unavailable",
"title": "Access Denied",
"detail": "Feature payment reminders unavailable",
"source": {}
}
]
}
PATCH /api/v2/payment_reminder_sequences/10
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "payment_reminder_sequences",
"attributes": {
"name": "Reminder sequence",
"default_sequence": true
}
}
}
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "10",
"type": "payment_reminder_sequences",
"attributes": {
"name": "Reminder sequence",
"created_at": "2025-08-02T06:06:45.751+02:00",
"updated_at": "2025-08-02T06:06:45.761+02:00",
"default_sequence": true
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": "820"
}
},
"creator": {
"meta": {
"included": false
}
},
"updater": {
"meta": {
"included": false
}
},
"payment_reminders": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Update a payment reminder sequencePATCH/api/v2/payment_reminder_sequences/{id}
- id
number
(required) Example: 1payment reminder sequence id
DELETE /api/v2/payment_reminder_sequences/12
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
DELETE /api/v2/payment_reminder_sequences/13
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "403",
"code": "payment_reminders_unavailable",
"title": "Access Denied",
"detail": "Feature payment reminders unavailable",
"source": {}
}
]
}
Deletes a payment reminder sequenceDELETE/api/v2/payment_reminder_sequences/{id}
- id
number
(required) Example: 1payment reminder sequence id
Generated by aglio on 02 Aug 2025