Email

Transactional email quota and usage: recipients today (UTC), this billing period and in the rolling hour. Any member with email:read

get/email/usage

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/email/usage
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Query parameters

orgIdstring

Organization id (required when you belong to several)

Response

Quota and usage

organizationIdstring uuid required
sendingStatus'not_requested' | 'requested' | 'enabled' | 'suspended' required
planIdstring nullable required

the plan the quota comes from (free, pro, business); null for a team without plan limits

source'plan' | 'override' | 'unlimited' required

override: a platform operator set this team's daily and/or monthly amount

smtpCountedboolean required

true: SMTP relay is counted too, as the mail server reported it at smtpCountedAt (read about once a minute); false: the mail server cannot report it on this server yet, so only POST /emails is counted (and SMTP passwords are only issued to teams without a quota)

smtpCountedAtstring nullable required

when the SMTP counts were last read from the mail server; null = never

upgradeAvailableboolean required

a bigger plan with a higher quota can be bought on this server (Settings → Billing)

Changes

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