Skip to content
RemindCash

Usage

Lea el correo electrónico actual de su empresa y las asignaciones de API y los saldos de crédito prepagados de SMS y WhatsApp.

Situación de la API pública

La API v1 utiliza las teclas de portador con un sistema operativo y requiere un período de plan activo. Los puntos finales de facturación y borrado no envían mensajes de clientes. Ejemplos usan los marcadores de posición — nunca pegan una clave real en código compartido.

GET /v1/usage devuelve el uso que RemindCash puede evidenciar ahora mismo. Requiere el alcance usage:read.

BASH
curl https://api.remindcash.com/v1/usage \
  --header "Authorization: Bearer $REMINDCASH_API_KEY"
JSON
{
    "data": {
        "as_of_utc": "2026-10-11T12:58:05.561343Z",
        "email": {
            "status": "unavailable",
            "source": null,
            "period_starts_at": null,
            "period_ends_at": null,
            "limit": 0,
            "reserved": 0,
            "consumed": 0,
            "remaining": 0
        },
        "api_requests": {
            "status": "unavailable",
            "period_starts_at": null,
            "period_ends_at": null,
            "limit": 0,
            "used": 0,
            "remaining": 0
        },
        "prepaid_credits": []
    },
    "request_id": "07e3c763-6ae6-4544-a864-ea96fccf953f"
}

Prestación por correo electrónico

Campo Descripción
status active cuando se aplica un período de asignación de correo electrónico, de lo contrario unavailable.
source De donde proviene el subsidio actual, o null.
period_starts_at, period_ends_at El período de asignación actual en UTC, o null.
limit Correos electrónicos permitidos en el período.
reserved Correos electrónicos reservados para los envíos en progreso.
consumed Correos electrónicos ya utilizados.
remaining limit − reserved − consumed, nunca por debajo de cero.

Cuando status es unavailable, no se pueden enviar recordatorios de correo electrónico hasta que se aplique un subsidio.

Solicitudes de API

api_requests informa del periodo del plan actual solo cuando los límites del plan de API están activados y el derecho asociado al correo electrónico es válido. En ese caso, status es active; de lo contrario, es unavailable y los valores son cero. limit es el número máximo de solicitudes de API facturables durante el periodo, used es el recuento persistente y remaining es max(0, limit − used). Las horas se expresan en UTC. GET /v1/usage no consume la asignación del plan, por lo que puede consultar un plan agotado. El límite de solicitudes por token puede seguir devolviendo 429.

Créditos pagados anticipados

prepaid_credits enumera una entrada por canal y moneda, cada una con channel, currency, available_minor y reserved_minor. Los créditos se reservan antes de que un mensaje sea enviado y resuelto o liberado después; los saldos nunca van Una lista vacía significa que no existe una cuenta de crédito todavía.

El estado de suscripción y la facturación aún no se han presentado aquí.