Get payment reminder configurations

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

{
  "data": [
    {
      "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.

Response

Successful Response

datalist of objects

Errors

401

Get Payment Reminders Request Unauthorized Error

403

Get Payment Reminders Request Forbidden Error

422

Get Payment Reminders Request Unprocessable Entity Error

429

Get Payment Reminders Request Too Many Requests Error

Authentication

Headers

Response

Errors