> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.monite.com/v2024-01-31/api/payment-reminders/post-payment-reminders/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.monite.com/_mcp/server.

# Create a payment reminder configuration

POST https://api.sandbox.monite.com/v1/payment_reminders
Content-Type: application/json

Reference: https://docs.monite.com/api/payment-reminders/post-payment-reminders

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api.sandbox.monite.com/v1` (sandbox, default)
- `https://api.monite.com/v1` (eu_production)
- `https://us.api.monite.com/v1` (na_production)

## Request

### Headers

- `x-monite-version` (string, required)
- `x-monite-entity-id` (string, required) — The ID of the entity that owns the requested resource.

### Body (application/json)

This endpoint expects an object.

- `name` (string, required)
- `recipients` (Recipients, optional)
- `term_1_reminder` (Reminder, optional) — Reminder to send for first payment term
- `term_2_reminder` (Reminder, optional) — Reminder to send for second payment term
- `term_final_reminder` (Reminder, optional) — Reminder to send for final payment term

## Response

### 201

Successful Response

- `id` (string, required)
- `created_at` (datetime, required) — Time at which the PaymentReminder was created. Timestamps follow the ISO 8601 standard.
- `updated_at` (datetime, required) — Time at which the PaymentReminder was last updated. Timestamps follow the ISO 8601 standard.
- `entity_id` (string, required)
- `name` (string, required)
- `status` (enum, required)
  - Allowed values: `active`, `deleted`
- `recipients` (Recipients, optional)
- `term_1_reminder` (Reminder, optional) — Reminder to send for first payment term
- `term_2_reminder` (Reminder, optional) — Reminder to send for second payment term
- `term_final_reminder` (Reminder, optional) — Reminder to send for final payment term

## Errors

### 400 Post Payment Reminders Request Bad Request Error

Bad Request

- `error` (ErrorSchema, required)

### 401 Post Payment Reminders Request Unauthorized Error

Unauthorized

- `error` (ErrorSchema, required)

### 403 Post Payment Reminders Request Forbidden Error

Forbidden

- `error` (ErrorSchema, required)

### 422 Post Payment Reminders Request Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional)

### 500 Post Payment Reminders Request Internal Server Error

Internal Server Error

- `error` (ErrorSchema, required)

## Types

### Recipients

- `bcc` (list of string, optional)
- `cc` (list of string, optional)
- `to` (list of string, optional)

### Reminder

- `body` (string, required)
- `days_before` (integer, required)
- `subject` (string, required)

### ErrorSchema

- `message` (string, required)

### ValidationError

- `loc` (list of ValidationErrorLocItem, required)
- `msg` (string, required)
- `type` (string, required)

### ValidationErrorLocItem

## Examples

**Request**

```json
{
  "name": "name"
}
```

**Response**

```json
{
  "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"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.sandbox.monite.com/v1/payment_reminders"

payload = { "name": "name" }
headers = {
    "x-monite-version": "2024-01-31",
    "x-monite-entity-id": "9d2b4c8f-2087-4738-ba91-7359683c49a4",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.sandbox.monite.com/v1/payment_reminders';
const options = {
  method: 'POST',
  headers: {
    'x-monite-version': '2024-01-31',
    'x-monite-entity-id': '9d2b4c8f-2087-4738-ba91-7359683c49a4',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"name":"name"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.monite.com/v1/payment_reminders"

	payload := strings.NewReader("{\n  \"name\": \"name\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-monite-version", "2024-01-31")
	req.Header.Add("x-monite-entity-id", "9d2b4c8f-2087-4738-ba91-7359683c49a4")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.monite.com/v1/payment_reminders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-monite-version"] = '2024-01-31'
request["x-monite-entity-id"] = '9d2b4c8f-2087-4738-ba91-7359683c49a4'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"name\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.sandbox.monite.com/v1/payment_reminders")
  .header("x-monite-version", "2024-01-31")
  .header("x-monite-entity-id", "9d2b4c8f-2087-4738-ba91-7359683c49a4")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"name\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.sandbox.monite.com/v1/payment_reminders', [
  'body' => '{
  "name": "name"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'x-monite-entity-id' => '9d2b4c8f-2087-4738-ba91-7359683c49a4',
    'x-monite-version' => '2024-01-31',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.sandbox.monite.com/v1/payment_reminders");
var request = new RestRequest(Method.POST);
request.AddHeader("x-monite-version", "2024-01-31");
request.AddHeader("x-monite-entity-id", "9d2b4c8f-2087-4738-ba91-7359683c49a4");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"name\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-monite-version": "2024-01-31",
  "x-monite-entity-id": "9d2b4c8f-2087-4738-ba91-7359683c49a4",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["name": "name"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.sandbox.monite.com/v1/payment_reminders")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```