Get the account's claim status
BillionSend extension. Whether the account behind the key is still unclaimed, when it deletes itself, and what it may do meanwhile. Any key may ask; an account a person has claimed answers claimed with no limits.
GET
/agent/statusAuthorization
AuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
Responses
200
The account's status
objectstringrequiredAllowed:
agent_accountstatusstringrequiredAllowed:
unclaimedclaimedclaimobject | nullrequiredSet while the account is unclaimed
Show propertiesHide properties
expires_atstringrequiredmails_leftintegerrequiredHow many more times the claim link can be sent again
limitsobject | nullrequiredSet while the account is unclaimed
Show propertiesHide properties
receive_onlybooleanrequiredinboxesintegerrequiredemails_per_dayintegerrequiredreceived_per_dayintegerrequiredEmails the account may receive per UTC day; past it the sender is told to retry
received_per_inbox_per_hourintegerrequiredEmails the inbox may receive per rolling hour; past it the sender is told to retry
401
Missing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequired429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired