> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbitelshield.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Services and invoices

> List and retrieve services, invoices, and invoice details with the Orbitel Shield public API.

Use the services and invoices endpoints to view your Orbitel Shield account services, their status and billing details, and the invoices associated with them. All monetary values are returned in cents. Timestamps are ISO8601 UTC. IDs are 26-character strings.

> [!NOTE]
>
> **Base URL:** `https://portal.orbitelshield.com/api/v1/public`\
> **Authentication:** Bearer token in the `Authorization` header\
> **Rate limit:** 120 requests per minute, including at most 30 writes

## List services

Retrieve a list of services for your account, ordered newest first. Each entry includes the plan, limits, status, and next due date.

### Endpoint

```text theme={null}
GET /services
```

### Permissions

Requires the `services:read` scope.

### Query parameters

| Parameter | Type | Description |
| - | - | - |
| `page` | integer | Page number for paginated results |
| `perPage` | integer | Items per page (up to 100) |
| `status` | string | Filter by status: `pending`, `active`, `suspended`, `cancelled`, or `terminated` |
| `q` | string | Search query |

### Example request

```bash theme={null}
curl -H "Authorization: Bearer $ORBITEL_API_KEY" \
  "https://portal.orbitelshield.com/api/v1/public/services?page=1&perPage=20&status=active"
```

## Get a service

Retrieve a single service by ID, including the last 12 invoices.

### Endpoint

```text theme={null}
GET /services/{id}
```

### Permissions

Requires the `services:read` scope.

### Path parameters

| Parameter | Type | Description |
| - | - | - |
| `id` | string | Service ID (26-character string) |

### Example request

```bash theme={null}
curl -H "Authorization: Bearer $ORBITEL_API_KEY" \
  "https://portal.orbitelshield.com/api/v1/public/services/{id}"
```

## List invoices

Retrieve a list of invoices for your account, including totals in cents and an overdue flag.

### Endpoint

```text theme={null}
GET /invoices
```

### Permissions

Requires the `invoices:read` scope. This scope is read only. Paying invoices, applying credit, and changing billing details must be done from the panel.

### Query parameters

| Parameter | Type | Description |
| - | - | - |
| `page` | integer | Page number for paginated results |
| `perPage` | integer | Items per page; maximum not specified for invoices |
| `status` | string | Filter by status: `unpaid`, `paid`, `overdue`, `void`, or `refunded` |
| `q` | string | Search by invoice number |

### Example request

```bash theme={null}
curl -H "Authorization: Bearer $ORBITEL_API_KEY" \
  "https://portal.orbitelshield.com/api/v1/public/invoices?page=1&perPage=20&status=unpaid"
```

## Get an invoice

Retrieve a single invoice by ID, including its lines, tax breakdown, and payments.

### Endpoint

```text theme={null}
GET /invoices/{id}
```

### Permissions

Requires the `invoices:read` scope.

### Path parameters

| Parameter | Type | Description |
| - | - | - |
| `id` | string | Invoice ID (26-character string) |

### Example request

```bash theme={null}
curl -H "Authorization: Bearer $ORBITEL_API_KEY" \
  "https://portal.orbitelshield.com/api/v1/public/invoices/{id}"
```

## Related endpoints

> [card] [Protection](https://docs.orbitelshield.com/api-reference/protection.md)
>
> Read protected services, prefixes, tunnels, traffic, and attacks.

> [card] [Protection changes](https://docs.orbitelshield.com/api-reference/protection-changes.md)
>
> Change prefixes and tunnels or push the current network configuration.

> [card] [Tickets](https://docs.orbitelshield.com/api-reference/tickets.md)
>
> Create and manage support tickets.

> [card] [Webhook signatures](https://docs.orbitelshield.com/api-reference/webhooks.md)
>
> Verify signed attack alert deliveries.

## Error handling

For common error responses, authentication issues, and rate-limiting behavior, see the [errors](https://docs.orbitelshield.com/api-reference/errors.md) page. For a general overview of the Orbitel Shield API, including authentication and request conventions, see the [API overview](https://docs.orbitelshield.com/api-reference/overview.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.