---
title: "POST /tools/api/create-payment-reminder"
method: POST
path: "/tools/api/create-payment-reminder"
tags: ["Payment Reminders"]
---

# POST /tools/api/create-payment-reminder

`POST /tools/api/create-payment-reminder`

Cria um novo lembrete de pagamento. Permite criar lembretes únicos ou recorrentes com notificações via WhatsApp e Email. Requer API key para autenticação e assinatura ativa. O usuário deve ter cota disponível baseada no seu plano.

## Request body

- CreatePaymentReminderRequest
  - `title` string, required
  - `amount` number
  - `dueDate` string, date, required
  - `reminderTime` string, date-time
  - `isRecurring` boolean
  - `recurrencePattern` 'daily' | 'weekly' | 'monthly' | 'yearly'

## Response `200`

Lembrete de pagamento criado com sucesso

- object
  - `success` boolean
  - `data` PaymentReminder
    - `id` string
    - `title` string
    - `amount` number, nullable
    - `dueDate` string, date, nullable
    - `reminderTime` string, date-time, nullable
    - `status` 'active' | 'completed' | 'inactive'
    - `isRecurring` boolean
    - `recurrencePattern` string, nullable
    - `createdAt` string, date-time
  - `message` string
  - `timestamp` string, date-time

## Other responses

- `400` — Parâmetros inválidos
- `401` — Authentication or subscription error
- `403` — Cota de lembretes excedida
- `500` — Internal server error

---

[API](https://skmtc.net/pierre/apis/pierre-finance-api.md) · [All operations](https://skmtc.net/pierre/apis/pierre-finance-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pierre/pierre-finance-api/revisions/caa3b50e534e/schema)