Skip to main content
POST
Create a payment reminder configuration

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-finops-version
string<date>
required
x-organization-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Body

application/json
name
string
required
Required string length: 1 - 255
recipients
object
term_1_reminder
object

Reminder to send for first payment term

term_2_reminder
object

Reminder to send for second payment term

term_final_reminder
object

Reminder to send for final payment term

Response

Successful Response

id
string<uuid>
required
created_at
string<date-time>
required

Time at which the PaymentReminder was created. Timestamps follow the ISO 8601 standard.

updated_at
string<date-time>
required

Time at which the PaymentReminder was last updated. Timestamps follow the ISO 8601 standard.

entity_id
string<uuid>
required
name
string
required
status
enum<string>
required
Available options:
active,
deleted
recipients
object
term_1_reminder
object

Reminder to send for first payment term

term_2_reminder
object

Reminder to send for second payment term

term_final_reminder
object

Reminder to send for final payment term