API Reference · Account

Create Billing Portal

Stripe billing portal link

POST/v1/billing/portal

Account requiredScope:billing:write

cURL example

cURL request

curl -X POST "https://api.verifiedinbox.ai/v1/billing/portal" \
  -H "Authorization: Bearer vi_live_YOUR_API_KEY"

Parameters

Parameter	Type	Description
VI-Environmentheader	string	`live` (default) or `test`. Used for anonymous callers and OAuth access tokens; API keys and web sessions carry their own environment.

Response

200 OKPortal URL.

application/json

Field	Type	Description
urlrequired	string	—

Example 200 response (BillingPortal)

{
  "url": "https://verifiedinbox.ai/verify/0192a5e0-1234-7000-8000-000000000001/domain"
}

Other responses & possible errors

Expand a status code below to see the error code, description, and example error payload.

401 (unauthenticated)`unauthenticated` — sign in / send a valid credential. `next_action.kind = sign_in`.

`unauthenticated` — sign in / send a valid credential. `next_action.kind = sign_in`.

Example 401 error response

{
  "error": {
    "code": "unauthenticated",
    "message": "Sign in or provide an API key to continue.",
    "next_action": {
      "kind": "sign_in",
      "title": "Sign in or create an account",
      "url": "/login"
    }
  }
}

403 (insufficient_scope)`forbidden` / `insufficient_scope` — the credential lacks permission.

`forbidden` / `insufficient_scope` — the credential lacks permission.

Example 403 error response

{
  "error": {
    "code": "insufficient_scope",
    "message": "This API key does not have the required scope for this action."
  }
}

422 (unprocessable)`unprocessable` / `blocked_provider` — understood but can't be done (plain-English reason).

`unprocessable` / `blocked_provider` — understood but can't be done (plain-English reason).

Example 422 error response

{
  "error": {
    "code": "unprocessable",
    "message": "Shared mailbox providers like gmail.com cannot be verified."
  }
}

429 (rate_limited)`rate_limited` — retry after `Retry-After` seconds (`details.retry_after_seconds`). `limit_reached` — a quota is used up; `details.limit` names it and `next_action` offers support.

`rate_limited` — retry after `Retry-After` seconds (`details.retry_after_seconds`). `limit_reached` — a quota is used up; `details.limit` names it and `next_action` offers support.

Example 429 error response

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please wait a moment and try again."
  }
}

Was it helpful?