Sign in

v2

latestOpenAPI 3.0.3Creative Commons Attribution 4.0 International2026-08-01171171.3 KB

Get current subscription status

Available on Core, Pro, and High RPM subscriptions. Returns details of the current subscription represented by the supplied hibp-api-key, including plan capabilities such as stealer-log access, breached-account k-anonymity access, bulk domain add features, and monitored-domain limits.

get/subscription/status

Headers

user-agentstring required

User agent string identifying the consuming application. Required on all documented requests, including unauthenticated endpoints; missing user agents may receive HTTP 403 responses.

Response

Current subscription capabilities and limits for the supplied API key.

SubscriptionNamestring required

The name representing the current plan and level, for example "Core 1", "Pro 2", or "High RPM 12000".

Descriptionstring required

A human-readable sentence explaining the scope of the subscription.

SubscribedUntilstring date-time required

The date and time the current subscription ends in ISO 8601 format.

Rpminteger required

The rate limit in requests per minute. This applies to the rate the breach search by email address API can be requested.

DomainSearchMaxBreachedAccountsinteger nullable required

The size of the largest domain the subscription can search. This is expressed in the total number of breached email addresses on the domain, excluding those that appear solely in spam lists.

MaxBreachedDomainsinteger nullable required

The number of domains the subscription can add, regardless of their size. A null value indicates there is no max domain limit.

IncludesStealerLogsboolean required

Indicates if the subscription includes access to the stealer logs APIs.

IncludesBulkDomainAddboolean required

Indicates if the subscription includes access to the APIs that add domains via DNS or email verification.

IncludesAutoSubdomainVerificationboolean required

Indicates if the subscription allows subdomains to be automatically added after the apex domain has already been verified.

IncludesCustomerDomainsboolean required

Indicates if the subscription allows the domains of customers to be added.

IncludesKAnonboolean required

Indicates if the subscription includes access to the breached-account k-anonymity API.