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

# Customer API

> REST reference for OrbitFlare Customer API v1 and v2: licenses, API keys, wallet auth, profile, invoices, balance top-up, and RPC plan purchases with request and response patterns.

The Customer API allows authenticated users to manage their OrbitFlare resources programmatically. It supports two versions: **v1** (API key authentication only) and **v2** (Bearer token or API key with extended features including auth flows, profile management, and invoice operations).

## Authentication

OrbitFlare supports two authentication methods depending on the API version you are using.

**API Key (v1 & v2):** Pass your API key via the `X-ORBIT-KEY` request header. This method works with both v1 and v2 endpoints.

**Bearer Token (v2 only):** Obtained through the device authorization flow or wallet signature authentication. Pass the token in the standard `Authorization: Bearer <token>` header.

<Tip>
  API keys work across both versions. If you only need basic license management, an API key is the simplest way to authenticate.
</Tip>

```bash theme={null}
curl -X GET https://api.orbitflare.com/v2/licenses \
  -H "X-ORBIT-KEY: your-api-key-here"
```

## API v2 Endpoints

<CardGroup cols={3}>
  <Card title="Auth" icon="key" href="/api-documentation/customer-endpoints/auth/device-code">
    Device flow, wallet auth, session management
  </Card>

  <Card title="Licenses" icon="id-card" href="/api-documentation/customer-endpoints/licenses/list">
    List, manage, and configure licenses
  </Card>

  <Card title="API Keys" icon="lock" href="/api-documentation/customer-endpoints/api-keys/list">
    Create, update, and manage API keys
  </Card>

  <Card title="Profile" icon="user" href="/api-documentation/customer-endpoints/profile/get">
    View and update user profile
  </Card>

  <Card title="Invoices" icon="file-invoice" href="/api-documentation/customer-endpoints/invoices/list">
    View invoices and pay with balance
  </Card>
</CardGroup>

## Legacy API v1

<Warning>
  API v1 is deprecated and will be removed in a future release. Migrate to v2 for access to the full set of endpoints and improved authentication options.
</Warning>

<CardGroup cols={2}>
  <Card title="v1 Customer Endpoints" icon="clock-rotate-left" href="/api-documentation/customer-endpoints/get-licenses">
    Legacy license management endpoints
  </Card>

  <Card title="Migration Guide" icon="arrow-right" href="/api-documentation/migration">
    Step-by-step guide to upgrading from v1 to v2
  </Card>
</CardGroup>