sending

Read sending allowance

Returns the account's sending allowance: how many recipients all its inboxes together can send to in a rolling 24 hours.

Every To, Cc and Bcc entry uses one unit, repeats included. Accepted and unknown sends count; rejected ones don't. Bounces and deleting mail or inboxes don't give units back. Units return 24 hours after the send that used them; next_capacity_at and next_capacity_amount say when the next ones return and how many.

A send that needs more than remaining returns 429 outbound_limit_reached, and nothing is sent or charged. Its reason says what to do:

  • temporary_exhaustion: wait until sufficient_capacity_at, which Retry-After also gives.
  • message_exceeds_allowance: the message has more recipients than the whole allowance, so waiting won't help. Send to fewer recipients, or request a larger allowance.
get/v1/outbound/quota

Request

  • Base URL: https://cherami.to
  • URL: https://cherami.to/v1/outbound/quota
  • Auth: HTTP bearer

Response

Success.

allowanceinteger required

Recipients the account can send to in any 24 hours.

usedinteger required

Recipients charged in the last 24 hours.

remaininginteger required

Recipients you can send to now.

next_capacity_atstring date-time nullable required

UTC timestamp with milliseconds.

next_capacity_amountinteger required

Recipients that become available at next_capacity_at.

window_hoursunknown required
unit'recipient_deliveries' required

One unit per To, Cc or Bcc recipient.

increase_requeststring required

How to ask for a larger allowance.

policy_urlstring required

Changes

No recorded changes to this operation across all 1 revision of this API.