Skip to content
RemindCash

Usage

Read your company's current email allowance and prepaid SMS and WhatsApp credit balances.

Public API status

The v1 API described here is implemented and tested, but api.remindcash.com is not yet open to the public. It opens after final acceptance testing; until then requests return 503. Examples use placeholders — never paste a real key into shared code.

GET /v1/usage returns usage that RemindCash can evidence right now. It requires the usage:read scope.

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
        },
        "prepaid_credits": []
    },
    "request_id": "07e3c763-6ae6-4544-a864-ea96fccf953f"
}

Email allowance

Field Description
status active when an email allowance period applies, otherwise unavailable.
source Where the current allowance comes from, or null.
period_starts_at, period_ends_at The current allowance period in UTC, or null.
limit Emails allowed in the period.
reserved Emails reserved for sends in progress.
consumed Emails already used.
remaining limit − reserved − consumed, never below zero.

When status is unavailable, no email reminders can be sent until an allowance applies.

Prepaid credits

prepaid_credits lists one entry per channel and currency, each with channel, currency, available_minor and reserved_minor. Credits are reserved before a message is submitted and settled or released afterwards; balances never go negative. An empty list means no credit account exists yet.

Subscription and API-request usage are not reported here yet.