# Create Billing Portal

> Stripe billing portal link

**Endpoint:** `POST /v1/billing/portal`  
**Access:** Account required (scope `billing:write`)

## cURL example

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

## Parameters

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

## Responses

### 200 OK

Portal URL.

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

### 401 (unauthenticated)

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

```json
{
  "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.

```json
{
  "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).

```json
{
  "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.

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