Saltar para o conteúdo
RemindCash

Utilização

Leia as quotas atuais de e-mail e de API da sua empresa e os saldos de créditos pré-pagos de SMS e WhatsApp.

Estado da API pública

A API v1 usa chaves bearer da empresa e exige um período de plano ativo. Os endpoints de rascunhos e de comunicação de pagamentos não enviam mensagens a clientes. Os exemplos usam marcadores — nunca cole uma chave real em código partilhado.

GET /v1/usage devolve a utilização que o RemindCash consegue comprovar neste momento. Exige a permissão 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"
}

Quota de e-mail

Campo Descrição
status active quando se aplica um período de quota de e-mail; caso contrário, unavailable.
source A origem da quota atual, ou null.
period_starts_at, period_ends_at O período de quota atual em UTC, ou null.
limit E-mails permitidos no período.
reserved E-mails reservados para envios em curso.
consumed E-mails já usados.
remaining limit − reserved − consumed, nunca abaixo de zero.

Quando status é unavailable, não pode ser enviado nenhum lembrete por e-mail até se aplicar uma quota.

Pedidos de API

api_requests mostra o período de plano atual apenas quando os limites de API do plano estão ativos e o direito de e-mail associado é válido. Nesse caso, status é active; caso contrário, é unavailable, com valores a zero. limit é o número máximo de pedidos de API contabilizáveis no período, used é a contagem persistente e remaining é max(0, limit − used). As horas estão em UTC. O próprio GET /v1/usage não consome a quota do plano, por isso pode consultar um plano esgotado. O limite de pedidos separado por token pode, ainda assim, devolver 429.

Créditos pré-pagos

prepaid_credits lista uma entrada por canal e moeda, cada uma com channel, currency, available_minor e reserved_minor. Os créditos são reservados antes de uma mensagem ser submetida e liquidados ou libertados depois; os saldos nunca ficam negativos. Uma lista vazia significa que ainda não existe nenhuma conta de créditos.

O estado da subscrição e a faturação ainda não são indicados aqui.