Credits

Get credits

GET/v1/workspaces/{workspaceId}/credits

The workspace's credits for metered checks (texting a code to confirm a phone number, checking an email address, checking a Telegram account, and AI autocomplete suggestions), in dollars, with each check's price. Any member or API key can read it. When too little is left for a check's price, the form skips the check. The response comes in marked not verified for a phone, or with emailCheck or telegramCheck set to "skipped", and an AI autocomplete question shows a plain text box with no suggestions. A plan without the check's feature skips it the same way, whatever the credits. Phone, email and Telegram checks need verification, and AI autocomplete needs aiFields (see Paid checks).

curl "$AYEFORM_API/v1/workspaces/$WORKSPACE_ID/credits" \
  -H "Authorization: Bearer $AYEFORM_KEY"

200 Response

{
  "month": "…",
  "includedUsd": 1,
  "allowanceLeftUsd": 1,
  "balanceUsd": 1,
  "availableUsd": 1,
  "prices": {
    "phoneVerification": {
      "usUsd": 1,
      "byCountry": {
        "crust": 1
      }
    },
    "emailValidation": {
      "eachUsd": 1
    },
    "telegramCheck": {
      "eachUsd": 1
    },
    "aiAutocomplete": {
      "eachUsd": 1
    }
  },
  "canTopUp": false,
  "metered": false,
  "keySources": {
    "phone": "ayeform",
    "email": "ayeform",
    "telegramFree": false
  },
  "keyProblems": {
    "phoneVerification": "missing",
    "emailValidation": "missing"
  }
}

Path parameters

workspaceIdstringrequired
The workspace's id. An API key can only use its own workspace.

Response

monthstringrequired
The month, in UTC, such as "2026-10".
includedUsdnumberrequired
Free credits each month. They reset on the 1st and don't carry over.
allowanceLeftUsdnumberrequired
Free credits left this month.
balanceUsdnumberrequired
Topped-up credits. They never expire and are spent after the month's free credits. A check is charged in full even when it costs more than what's left, so this can go negative. What's owed is repaid from the next top-up or next month's free credits.
availableUsdnumberrequired
Free credits left plus the balance. It can be 0 or less.
pricesobjectrequired
Show 4 fieldsHide 4 fields
- phoneVerificationobjectrequired
  Charged only when the visitor's code is approved. A country not listed costs as much as the most expensive listed one.
  Show 2 fieldsHide 2 fields
  usUsdnumberrequired
  byCountryobjectrequired
  The price per country code, such as { "US": 0.2 }.
- emailValidationobjectrequired
  The same in every country. Charged once for each address a visitor's session checks.
  Show 1 fieldHide 1 field
  eachUsdnumberrequired
- telegramCheckobjectrequired
  Charged once per username a visitor's session checks, when Telegram answered.
  Show 1 fieldHide 1 field
  eachUsdnumberrequired
- aiAutocompleteobjectrequired
  Charged once for each visitor session that is shown suggestions.
  Show 1 fieldHide 1 field
  eachUsdnumberrequired
canTopUpbooleanrequired
True when the caller is the owner and billing and top-ups are set up on this deployment. Always false for a free workspace.
meteredbooleanrequired
False when staff made the workspace free with metering off. Its checks are then never charged and never skipped, whatever the credits.
keySourcesobjectrequired
Show 3 fieldsHide 3 fields
- phoneenumrequired
  Whose provider keys the check runs on. ayeform uses Ayeform's keys and is charged in credits. own uses the workspace's own keys and house uses keys Ayeform set up for it, and neither is ever charged.
  One of "ayeform", "own", "house"
- emailenumrequired
  Whose provider keys the check runs on. ayeform uses Ayeform's keys and is charged in credits. own uses the workspace's own keys and house uses keys Ayeform set up for it, and neither is ever charged.
  One of "ayeform", "own", "house"
- telegramFreebooleanrequired
  Telegram checks are never charged.
keyProblemsobjectrequired
Show 2 fieldsHide 2 fields
- phoneVerificationenum
  Set only for a check that runs on the workspace's own keys, and left out when all is well. missing means no key is saved, and rejected means the provider refused the saved key. In both cases the check is skipped until the owner saves a working key with PUT /v1/workspaces/{workspaceId}/provider-keys/{provider}. error means the provider's last answer was another error about the key's account or service, and checks are skipped while it lasts. The provider keys' failure says what went wrong.
  One of "missing", "rejected", "error"
- emailValidationenum
  Set only for a check that runs on the workspace's own keys, and left out when all is well. missing means no key is saved, and rejected means the provider refused the saved key. In both cases the check is skipped until the owner saves a working key with PUT /v1/workspaces/{workspaceId}/provider-keys/{provider}. error means the provider's last answer was another error about the key's account or service, and checks are skipped while it lasts. The provider keys' failure says what went wrong.
  One of "missing", "rejected", "error"

Errors answer with a status and the error shape.