Have I Been Pwned · JSON Structure

Hibp Subscription Status Structure

Structure of subscription status returned by /subscription/status.

Type: object Properties: 0
SecurityData BreachesPwned PasswordsIdentityThreat IntelligenceCredential Stuffing

SubscriptionStatus is a JSON Structure definition published by Have I Been Pwned. It conforms to the https://json-structure.org/schema meta-schema.

Meta-schema: https://json-structure.org/schema

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/schema",
  "$id": "https://haveibeenpwned.com/structures/subscription-status.json",
  "name": "SubscriptionStatus",
  "type": "object",
  "description": "Structure of subscription status returned by /subscription/status.",
  "fields": [
    { "name": "SubscriptionName", "type": "string" },
    { "name": "Description", "type": "string" },
    { "name": "SubscribedUntil", "type": "datetime" },
    { "name": "Rpm", "type": "integer" },
    { "name": "DomainSearchMaxBreachedAccounts", "type": "integer" },
    { "name": "MaxBreachedDomains", "type": "integer", "optional": true },
    { "name": "IncludesStealerLogs", "type": "boolean" },
    { "name": "IncludesBulkDomainAdd", "type": "boolean" },
    { "name": "IncludesAutoSubdomainVerification", "type": "boolean" },
    { "name": "IncludesCustomerDomains", "type": "boolean" },
    { "name": "IncludesKAnon", "type": "boolean" }
  ]
}