Skip to main content
GET
/
tools
/
api
/
list-payment-reminders
cURL
curl --request GET \
  --url https://www.pierre.finance/tools/api/list-payment-reminders \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "pr_123456789",
      "title": "Conta de luz",
      "amount": 150.00,
      "dueDate": "2024-12-15",
      "reminderTime": "2024-12-14T09:00:00Z",
      "status": "active",
      "isRecurring": false,
      "recurrencePattern": null,
      "createdAt": "2024-11-20T10:00:00Z",
      "updatedAt": "2024-11-20T10:00:00Z"
    },
    {
      "id": "pr_987654321",
      "title": "Aluguel",
      "amount": 1500.00,
      "dueDate": "2024-12-05",
      "reminderTime": "2024-12-04T09:00:00Z",
      "status": "active",
      "isRecurring": true,
      "recurrencePattern": "monthly",
      "createdAt": "2024-10-05T15:30:00Z",
      "updatedAt": "2024-11-05T09:00:00Z"
    }
  ],
  "count": 2,
  "filter": "Active reminders",
  "quota": {
    "subscriptionType": "pro",
    "currentCount": 2,
    "limit": 10,
    "canCreate": true,
    "remaining": 8
  },
  "timestamp": "2024-11-27T15:30:00Z"
}
Este endpoint retorna todos os lembretes de pagamento do usuário autenticado, com informações sobre quota disponível.

​
Descrição

O endpoint GET /tools/api/list-payment-reminders retorna a lista de lembretes de pagamento com opções de filtro por status e proximidade do vencimento.

​
Autenticação

Este endpoint requer autenticação via Bearer token.
​
Authorization
string
required
Bearer token com a API key do usuário. Formato: Bearer sk-your-api-key-here

​
Parâmetros de Query

​
filter
string
required
Filtro de lembretes: active (padrão), all, upcoming, ou overdue
​
days
integer
required
Número de dias para filtrar lembretes próximos (usado com filter=upcoming). Padrão: 7 dias.
​
s
string
required
Parâmetro interno para indicar requisições via MCP. Use s=s para requisições MCP.

​
Resposta

​
Sucesso (200)

{
  "success": true,
  "data": [
    {
      "id": "pr_123456789",
      "title": "Conta de luz",
      "amount": 150.00,
      "dueDate": "2024-12-15",
      "reminderTime": "2024-12-14T09:00:00Z",
      "status": "active",
      "isRecurring": false,
      "recurrencePattern": null,
      "createdAt": "2024-11-20T10:00:00Z",
      "updatedAt": "2024-11-20T10:00:00Z"
    },
    {
      "id": "pr_987654321",
      "title": "Aluguel",
      "amount": 1500.00,
      "dueDate": "2024-12-05",
      "reminderTime": "2024-12-04T09:00:00Z",
      "status": "active",
      "isRecurring": true,
      "recurrencePattern": "monthly",
      "createdAt": "2024-10-05T15:30:00Z",
      "updatedAt": "2024-11-05T09:00:00Z"
    }
  ],
  "count": 2,
  "filter": "Active reminders",
  "quota": {
    "subscriptionType": "pro",
    "currentCount": 2,
    "limit": 10,
    "canCreate": true,
    "remaining": 8
  },
  "timestamp": "2024-11-27T15:30:00Z"
}

​
Erro de Autenticação (401)

{
  "error": "Invalid or inactive API key",
  "message": "Please check your API key and try again",
  "type": "invalid_api_key"
}

​
Campos da Resposta

​
success
boolean
required
Indica se a requisição foi bem-sucedida
​
data
array
required
Array com os lembretes de pagamento
​
count
number
required
Número total de lembretes retornados
​
filter
string
required
Descrição do filtro aplicado
​
quota
object
required
Informações sobre a quota de lembretes do plano do usuário
​
timestamp
string
required
Timestamp da requisição em formato ISO 8601

​
Exemplos de Uso

​
cURL

# Listar lembretes ativos
curl -X GET 'https://www.pierre.finance/tools/api/list-payment-reminders' \
  -H 'Authorization: Bearer sk-your-api-key-here'

# Listar lembretes próximos (próximos 7 dias)
curl -X GET 'https://www.pierre.finance/tools/api/list-payment-reminders?filter=upcoming&days=7' \
  -H 'Authorization: Bearer sk-your-api-key-here'

# Listar todos os lembretes
curl -X GET 'https://www.pierre.finance/tools/api/list-payment-reminders?filter=all' \
  -H 'Authorization: Bearer sk-your-api-key-here'

# Listar lembretes vencidos
curl -X GET 'https://www.pierre.finance/tools/api/list-payment-reminders?filter=overdue' \
  -H 'Authorization: Bearer sk-your-api-key-here'

​
JavaScript

const API_KEY = 'sk-your-api-key-here';
const BASE_URL = 'https://www.pierre.finance/tools/api';

async function listPaymentReminders(filter = 'active', days = 7) {
  const params = new URLSearchParams({ filter });
  if (filter === 'upcoming') {
    params.append('days', days);
  }
  
  const response = await fetch(`${BASE_URL}/list-payment-reminders?${params}`, {
    headers: {
      'Authorization': `Bearer ${API_KEY}`,
      'Content-Type': 'application/json'
    }
  });
  
  return await response.json();
}

// Exemplos de uso
listPaymentReminders(); // Lembretes ativos
listPaymentReminders('upcoming', 7); // Próximos 7 dias
listPaymentReminders('all'); // Todos
listPaymentReminders('overdue'); // Vencidos

​
Python

import requests

API_KEY = 'sk-your-api-key-here'
BASE_URL = 'https://www.pierre.finance/tools/api'

headers = {
    'Authorization': f'Bearer {API_KEY}',
    'Content-Type': 'application/json'
}

def list_payment_reminders(filter='active', days=7):
    params = {'filter': filter}
    if filter == 'upcoming':
        params['days'] = days
    
    response = requests.get(f'{BASE_URL}/list-payment-reminders', 
                          headers=headers, params=params)
    return response.json()

# Exemplos de uso
reminders = list_payment_reminders()  # Ativos
upcoming = list_payment_reminders('upcoming', 7)  # Próximos 7 dias
all_reminders = list_payment_reminders('all')  # Todos
overdue = list_payment_reminders('overdue')  # Vencidos

​
Códigos de Status

  • 200: Sucesso - Lembretes retornados
  • 401: Erro de autenticação ou assinatura
  • 500: Erro interno do servidor

​
Filtros Disponíveis

  • active: Retorna apenas lembretes ativos (padrão)
  • all: Retorna todos os lembretes (ativos, completados e inativos)
  • upcoming: Retorna lembretes com vencimento nos próximos X dias
  • overdue: Retorna lembretes vencidos e não pagos

​
Limites por Plano

  • BASIC: 5 lembretes ativos
  • PRO: 10 lembretes ativos
  • PREMIUM: 30 lembretes ativos
Os lembretes recorrentes são renovados automaticamente após a data de vencimento. Lembretes completados não contam para o limite de quota.
Use filter=upcoming&days=3 para ver os lembretes que vencem nos próximos 3 dias e se planejar melhor.

Authorizations

​
Authorization
string
header
required

API key in Bearer token format. Example: Bearer sk-your-api-key-here

Query Parameters

​
filter
enum<string>
default:active

Filtro de lembretes: active (padrão), all, upcoming, overdue

Available options:
active,
all,
upcoming,
overdue
​
days
integer
default:7

Número de dias para filtrar lembretes próximos (usado com filter=upcoming)

Response

Lista de lembretes de pagamento

​
success
boolean
Example:

true

​
data
object[]
​
count
number
Example:

3

​
filter
string
Example:

"Active reminders"

​
quota
object
​
timestamp
string<date-time>