Create a payment reminder configuration

POST
/payment_reminders

Headers

Auth
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.
namestringRequired
recipientsobjectOptional
term_1_reminderobjectOptional
Reminder to send for first payment term
term_2_reminderobjectOptional
Reminder to send for second payment term
term_final_reminderobjectOptional
Reminder to send for final payment term

Response

This endpoint returns an object.
idstring
created_atdatetime
Time at which the PaymentReminder was created. Timestamps follow the ISO 8601 standard.
updated_atdatetime
Time at which the PaymentReminder was last updated. Timestamps follow the ISO 8601 standard.
entity_idstring
namestring
status"active" or "deleted"
Allowed values: activedeleted
recipientsobjectOptional
term_1_reminderobjectOptional
Reminder to send for first payment term
term_2_reminderobjectOptional
Reminder to send for second payment term
term_final_reminderobjectOptional
Reminder to send for final payment term

Errors