Get a payment reminder configuration by ID

curl https://api.sandbox.monite.com/v1/payment_reminders/payment_reminder_id \
     -H "x-monite-version: 2024-05-25" \
     -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
     -H "Authorization: Bearer <token>"

{
  "id": "id",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "entity_id": "entity_id",
  "name": "name",
  "status": "active",
  "recipients": {
    "bcc": [
      "bcc"
    ],
    "cc": [
      "cc"
    ],
    "to": [
      "to"
    ]
  },
  "term_1_reminder": {
    "body": "body",
    "days_before": 1,
    "subject": "subject"
  },
  "term_2_reminder": {
    "body": "body",
    "days_before": 1,
    "subject": "subject"
  },
  "term_final_reminder": {
    "body": "body",
    "days_before": 1,
    "subject": "subject"
  }
}

Authentication

AuthorizationBearer

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

Path parameters

payment_reminder_idstringRequired

Response

Successful Response

idstringformat: "uuid"

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_idstringformat: "uuid"

namestring

statusenum

Allowed values:

recipientsobject

term_1_reminderobject

Reminder to send for first payment term

term_2_reminderobject

Reminder to send for second payment term

term_final_reminderobject

Reminder to send for final payment term

Errors

401

Get Payment Reminders ID Request Unauthorized Error

403

Get Payment Reminders ID Request Forbidden Error

404

Get Payment Reminders ID Request Not Found Error

422

Get Payment Reminders ID Request Unprocessable Entity Error

429

Get Payment Reminders ID Request Too Many Requests Error

Authentication

Path parameters

Headers

Response

Errors