Payment Reminders API Reference
This API reference provides information on available endpoints and how to interact with them. The Payment Reminders API is a RESTful API that allows you to create, read, update, and delete payment reminders.
Payment Reminders model
Payment Reminders are objects that represent a reminder to invoice is overdue or due soon. The model has the following attributes:
Properties
- Name
id
- Type
- string
- Field Type
- Description
The unique identifier for the payment reminder.
- Name
days
- Type
- number
- Field Type
- Description
The number of days the payment reminder should be sent before or after the due date.
- Name
type
- Type
- string
- Field Type
- Description
The type of the payment reminder. Possible values are
before_due_date
andafter_due_date
.
- Name
business_id
- Type
- string
- Field Type
- Description
The unique identifier for the business.
List all payment reminders
This endpoint returns a list payment reminders.
Query Parameters
- Name
limit
- Type
- integer
- Field Type
optional
- Description
A limit on the number of payment reminders to be returned. (default is 5)
- Name
page
- Type
- integer
- Field Type
optional
- Description
Page number for pagination. (default is 1)
- Name
days
- Type
- number
- Field Type
optional
- Description
Filter records by the number of days of the payment reminder.
- Name
type
- Type
- string
- Field Type
optional
- Description
Filter records by the type of the payment reminder. Possible values are
before_due_date
andafter_due_date
.
Request
curl --request GET \
--get "https://payments.your-domain.com/api/v1/payment-reminders" \
--header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Business: 995c98ce-cdd9-4ef6-b018-9c696cb07e9d" \
Response
{
"data": [
{
"id": "995c98ce-c58ad-4ef6-a67f-9c696cb0jab6",
"days": 0,
"type": "before_due_date",
"business_id": "995c98ce-cdd9-4ef6-b018-9c696cb07e9d",
}, {...}
]
}
Create a payment reminder
This endpoint allows you create a new payment reminder.
Parameters
- Name
days
- Type
- number
- Field Type
required
- Description
The number of days the payment reminder should be sent before or after the due date.
- Name
type
- Type
- string
- Field Type
required
- Description
The type of the payment reminder. Possible values are
before_due_date
andafter_due_date
.
Request
curl --request POST \
"https://payments.your-domain.com/api/v1/payment-reminders" \
--header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Business: 995c98ce-cdd9-4ef6-b018-9c696cb07e9d" \
--data "{
\"days\": \"5\",
\"type\": \"before_due_date\"
}"
Response
{
"data": {
"id": "995c98ce-a58ad-4ef6-c478-9ka86cb0j5a7",
"days": 5,
"type": "before_due_date",
"business_id": "995c98ce-cdd9-4ef6-b018-9c696cb07e9d",
}
}
Retrieve a payment reminder
This endpoint allows you to retrieve a payment reminder object.
Parameters
- Name
id
- Type
- string
- Field Type
required
- Description
ID of the payment reminder.
Request
curl --request GET \
--get "https://payments.your-domain.com/api/v1/payment-reminders/995c98ce-a58ad-4ef6-c478-9ka86cb0j5a7" \
--header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Business: 995c98ce-cdd9-4ef6-b018-9c696cb07e9d" \
Response
{
"data": {
"id": "995c98ce-a58ad-4ef6-c478-9ka86cb0j5a7",
"days": 5,
"type": "before_due_date",
"business_id": "995c98ce-cdd9-4ef6-b018-9c696cb07e9d",
}
}
Update a payment reminder
This endpoint allows you to perform an update on a payment reminder.
URL Parameters
- Name
id
- Type
- string
- Field Type
required
- Description
The ID of the payment reminder.
Parameters
- Name
days
- Type
- number
- Field Type
optional
- Description
The number of days the payment reminder should be sent before or after the due date.
- Name
type
- Type
- string
- Field Type
optional
- Description
The type of the payment reminder. Possible values are
before_due_date
andafter_due_date
.
Request
curl --request PUT \
"https://payments.your-domain.com/api/v1/payment-reminders/995c98ce-a58ad-4ef6-c478-9ka86cb0j5a7" \
--header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Business: 995c98ce-cdd9-4ef6-b018-9c696cb07e9d" \
--data "{
\"days\": \"10\",
\"type\": \"after_due_date\"
}"
Response
{
"data": {
"id": "995c98ce-a58ad-4ef6-c478-9ka86cb0j5a7",
"days": 10,
"type": "after_due_date",
"business_id": "995c98ce-cdd9-4ef6-b018-9c696cb07e9d",
}
}
Delete a payment reminder
This endpoint allows you to delete a payment reminder.
Parameters
- Name
id
- Type
- string
- Field Type
required
- Description
The ID of the payment reminder.
Request
curl --request DELETE \
--url "https://payments.your-domain.com/api/v1/payment-reminders/995c98ce-a58ad-4ef6-c478-9ka86cb0j5a7" \
--header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Business: 995c98ce-cdd9-4ef6-b018-9c696cb07e9d" \
Response
{
"id": "995c98ce-a58ad-4ef6-c478-9ka86cb0j5a7",
"object": "PaymentReminder",
"deleted": true
}