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

# Account

> Manage your qBraid credits, API keys, organizations, subscriptions, and more.

## Overview

To get started using qBraid Lab or other qBraid platform/cloud services, sign in or register at
[account.qbraid.com](https://account.qbraid.com/). Your account page serves as the central hub for managing
your qBraid subscription, credits, organizations, quantum jobs, Lab instances, and more.

<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
  <img src="https://storage.googleapis.com/qbraid-static-assets/qbraid-docs/account/account-dashboard.png" width="150%" />
</div>

## Promo Codes

Promotional codes can be redeemed for fixed rate or percentage discounts on [credits](/v2/home/pricing#credits) and subscriptions on the qBraid platform.

### Redeeming a Promo Code

Promo codes are applied during the checkout process on the payment page:

1. On the left side of your account page, click the **Account > Wallet** button to open the wallet page.
2. Select a credit amount and click on **Purchase** to proceed to the Stripe checkout page.
3. On the Stripe checkout page, click on **Add promotion code** and enter the access code you have.
4. Click **Apply** followed by **Complete Order** to redeem the code.
5. If there is no outstanding balance after applying the promo code, the credits will be added to your account immediately.

<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
  <img src="https://storage.googleapis.com/qbraid-static-assets/qbraid-docs/account/access-key-checkout.gif" alt="Redeeming access code on checkout" width="90%" />
</div>

## API Keys

Each qBraid user is assigned a unique API key, essential for accessing qBraid cloud services and managing resources remotely.
This key enables you to submit quantum jobs to over 20+ available QPUs and simulators through various
interfaces such as the [qBraid Runtime](/v2/sdk/user-guide/runtime), direct connections to our universal Quantum [API endpoints](/v2/api-reference/user-guide), or other applications
compatible with [qBraid Quantum Jobs](/v2/lab/user-guide/quantum-jobs).

### Managing Your API Keys

<Tabs>
  <Tab title="Viewing">
    You can find your API keys within the **Account > API Keys** section on the left side of your account page.

    <Tabs>
      <Tab title="Listing">
        All your existing API keys are listed here along with their details such as creation date, last used date, and status (active/inactive).

        <div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
          <img src="https://storage.googleapis.com/qbraid-static-assets/qbraid-docs/account/account-api-key-base.png" alt="View API Keys" width="100%" />
        </div>

        * **Rotate API Key**: Use the "Refresh" icon to generate a new API key with the same details. This will deactivate the old key immediately and prompt with a **Regenerate Key** tab.
      </Tab>

      <Tab title="Details">
        Click on an API key entry to view more detailed information about that specific key, including its permissions and usage statistics.

        <div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
          <img src="https://storage.googleapis.com/qbraid-static-assets/qbraid-docs/account/account-api-key-details.png" alt="View API Keys" width="65%" />
        </div>
      </Tab>
    </Tabs>
  </Tab>

  <Tab title="Creating">
    To create a new API key click on the **"Create API Key"** button. Enter the details for the new API key and confirm the creation.

    <Warning> You will see the newly created API key **only once upon creation**. Make sure to copy and securely store it immediately.</Warning>

    <div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
      <img src="https://storage.googleapis.com/qbraid-static-assets/qbraid-docs/account/account-api-key-new.png" alt="Create API Key" width="65%" />
    </div>
  </Tab>

  <Tab title="Revoking">
    Select the API key you wish to revoke, click on the **"Delete"** icon and confirm the revocation.
    <Warning>  Note that revoked keys cannot be recovered.</Warning>

    <div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
      <img src="https://storage.googleapis.com/qbraid-static-assets/qbraid-docs/account/account-api-key-revoke.png" alt="Delete API Key" width="65%" />
    </div>
  </Tab>
</Tabs>

### API Key Security

The security of your API key is paramount as it grants access to your qBraid credits and other sensitive resources.
Follow these best practices to safeguard your key:

* **Regular Rotation**: Periodically rotate your API key to minimize the risk of unauthorized access.
  To rotate your API key, click the "Refresh" icon adjacent to the "Copy" icon. Note that once a new API key is generated,
  the previous key is immediately invalidated.
* **Secure Storage**: Avoid storing your API key in your source code or online. Use environment variables or secure vault
  solutions to manage your keys safely. Only save your API key to disk if the device is trusted and secure.
* **Monitor Usage**: Keep track of API key usage and review associated logs regularly to detect any unauthorized or unusual activities.

For more detailed information on security practices and policies at qBraid, please review our [Security Policy](https://github.com/qBraid/community/security/policy).
If you discover a vulnerability, please help us by submitting a security advisory [here](https://github.com/qBraid/community/security/advisories). Your proactive
involvement helps keep our community safe and secure.

## Stopping Your Server

The qBraid platform enforces [usage limits](/v2/lab/user-guide/usage-limits) for [CPU hours](/v2/lab/user-guide/usage-limits#compute-hours), so it's important to stop your server when you're not using it. You can stop your Lab instance from your account page in two places: the **left sidebar** or the **main dashboard**. Lab also stops instances automatically after a period of inactivity; to make the most of your allocated CPU hours, stop your instance whenever you're done working. You can also stop your instance from within Lab using the [Compute Manager](/v2/lab/user-guide/compute-manager).

<div style={{ display: "flex", justifyContent: "center", alignItems: "center" }}>
  <img src="https://mintcdn.com/qbraidco/KyER-uz2SOjj-7QQ/v2/home/_static/stop-server.png?fit=max&auto=format&n=KyER-uz2SOjj-7QQ&q=85&s=c8c31836ce62fc1396b3c1e3e8adc880" alt="Stop server locations on account page" width="100%" data-path="v2/home/_static/stop-server.png" />
</div>
