## GET /api/v2/billing/credit-line

**Get invoice credit line**

Returns the account's invoice credit line. With an available line, domain registrations and transfers are carried out before their invoice is paid. A Swedish organisation earns a line by paying several invoices by bank transfer from its own account. Card and Swish payments do not count. The limit is measured against all unpaid invoices on the account. An invoice more than seven days overdue freezes the line until it is paid. Accounts without a line return `status: "none"`. The line covers orders placed in the client area only. Orders placed with an API key always wait for payment.

### Related Endpoints

- `GET /api/v2/billing/cards`: List saved cards
- `POST /api/v2/billing/cards`: Save a payment card
- `GET /api/v2/billing/account`: Get billing account

### Headers

- `Authorization`: Bearer $HOSTUP_API_KEY
- Scope: `read:billing`

### Request Example

```bash
curl "https://cloud.hostup.se/api/v2/billing/credit-line" \
  -H "Authorization: Bearer $HOSTUP_API_KEY"
```

### Response Schema

- `available` (boolean, required): `true` when the line can carry out a domain registration or transfer ordered in the client area before its invoice is paid. The order's own invoice counts toward the limit.
- `reason` (string, required, nullable): Why the line is not available. `null` when `available` is `true`.
- `reasonCode` (string, required, nullable): `no_credit_line`, `overdue_invoice` (an invoice is more than seven days overdue) or `limit_exceeded` (unpaid invoices exceed the limit). `null` when available.
  Allowed values: no_credit_line, overdue_invoice, limit_exceeded
- `status` (string, required): `active`, `frozen` (an invoice is overdue), `exhausted` (unpaid invoices exceed the limit) or `none` (no credit line).
  Allowed values: active, frozen, exhausted, none
- `tier` (string, required, nullable): How the limit was set. `earned` and `established` come from invoices paid by bank transfer. `custom` is a limit agreed with Hostup. `null` without a line.
  Allowed values: earned, established, custom
- `limitAmount` (number, required, nullable): Credit limit in major units of `currencyCode`, VAT included. `null` without a line.
- `usedAmount` (number, required): Sum of the account's unpaid invoices. 0 without a line.
- `availableAmount` (number, required): `limitAmount` minus `usedAmount`, never below 0. 0 while the line is frozen.
- `currencyCode` (string, required): Always `SEK`.
  Allowed values: SEK
- `unpaidInvoiceCount` (integer, required): Number of unpaid invoices on the account. 0 without a line.
- `coveredOrderKinds` (array<string>, required): Order kinds carried out before payment. Empty without a line.
- `evaluatedAt` (string, required): When the line was evaluated.

### Responses

#### 200 - The account's invoice credit line.
```json
{
  "available": true,
  "reason": null,
  "reasonCode": null,
  "status": "active",
  "tier": "established",
  "limitAmount": 10000,
  "usedAmount": 2866.25,
  "availableAmount": 7133.75,
  "currencyCode": "SEK",
  "unpaidInvoiceCount": 11,
  "coveredOrderKinds": [
    "domain_registration",
    "domain_transfer"
  ],
  "evaluatedAt": "2026-09-18T10:00:00.000Z"
}
```

#### 400 - Invalid request. The response body is an RFC 7807 Problem Details document.
```json
{
  "type": "https://developer.hostup.se/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "detail": "The request is invalid.",
  "code": "invalid_request",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 401 - Unauthorized. Authentication is required.
```json
{
  "type": "https://developer.hostup.se/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication is required.",
  "code": "unauthorized",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 403 - Forbidden. The caller lacks a required scope or does not own the resource.
```json
{
  "type": "https://developer.hostup.se/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The caller lacks a required scope or does not own the resource.",
  "code": "forbidden",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 404 - Not found. The resource does not exist or is not owned by the caller.
```json
{
  "type": "https://developer.hostup.se/errors/not_found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource could not be found.",
  "code": "not_found",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 429 - Rate limited. Retry after the limit resets. 429 responses include `Retry-After` seconds plus `X-RateLimit-*` headers.
```json
{
  "type": "https://developer.hostup.se/errors/rate_limit_exceeded",
  "title": "Too many requests",
  "status": 429,
  "detail": "Rate limit exceeded. Please try again later.",
  "code": "rate_limit_exceeded",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 500 - Internal error. Retry later or contact support if the issue persists.
```json
{
  "type": "https://developer.hostup.se/errors/internal_error",
  "title": "Internal server error",
  "status": 500,
  "detail": "An unexpected error occurred. Retry later or contact support if the issue persists.",
  "code": "internal_error",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 503 - The credit line could not be read right now. Try again shortly.
```json
{
  "type": "https://developer.hostup.se/errors/upstream_unavailable",
  "title": "Credit line unavailable",
  "status": 503,
  "detail": "The credit line could not be read right now. Try again shortly.",
  "code": "upstream_unavailable",
  "instance": "/api/v2/billing/credit-line"
}
```
