Skip to content

mail_usage_get

Current free-tier usage for the product: emails sent this day and month with used/limit/remaining, the hard cap, a blocked flag, and the point-in-time contacts count

Tool

mail_usage_get

Current free-tier usage for the product: emails sent this day and month with used/limit/remaining, the hard cap, a blocked flag, and the point-in-time contacts count

Current free-tier usage for the product: emails sent this day and month with used/limit/remaining, the hard cap, a blocked flag, and the point-in-time contacts count

Behavior

HTTP
GET /mail/usage

Arguments

No arguments.

Response

Field
Type
Always
Description
emails
object
•
Email sending usage against the free-tier limits
period
object
•
The two windows the counters below are scoped to
contacts
object
•
Point-in-time contact storage — a stock, not a per-period flow

Try it

Current free-tier usage for the product: emails sent this day and month with used/limit/remaining, the hard cap, a blocked flag, and the point-in-time contacts count.

When to use

Current free-tier usage for the product: emails sent this day and month with used/limit/remaining, the hard cap, a blocked flag, and the point-in-time contacts count

Example

Ask your agent something like this:

Current free-tier usage for the product: emails sent this day and month with used/limit/remaining, the hard cap, a blocked flag, and the point-in-time contacts count.

The agent will invoke mail_usage_get with these arguments:

{}

Esc

Start typing to search the docs.

↑↓navigate↵select