Skip to main content

UserCheckResponse

Response from the credential verification endpoint (usercheck), reporting whether your account has balance to make API calls. Respectify has no subscriptions: accounts are billed per call against a dollar balance (see Billing). This call is free.

import type { UserCheckResponse } from "@respectify/client";

Fields​

active​

Whether the account can make API calls: true when the balance is above $0, false when it is $0 or less or the balance could not be read

result.active: boolean

status​

Account status: "active" when the balance is above $0, "no_credit" when it is $0 or less; null if the balance could not be read

result.status: string | null

expires​

Not used: always null. Balances do not expire.

result.expires: string | null

plan_name​

Your current balance as text, for display (e.g., "Credit Balance: $12.34"); null if the balance could not be read

result.plan_name: string | null

allowed_endpoints​

Not used: always null. Every endpoint is available on every account while the balance covers the call's price.

result.allowed_endpoints: string[] | null

error​

Error message if the balance could not be read (e.g., "Unable to determine account status"); null otherwise

result.error: string | null

Example Response​

{
  "active": true,
  "status": "active",
  "expires": null,
  "plan_name": "Credit Balance: $12.34",
  "allowed_endpoints": null,
  "error": null
}