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

# Get a package

> Returns one package you own, with its proxy credentials and live usage.

Returns one package you own, including its proxy `username` and `password` and its live bandwidth usage. Use a numeric `package_id` or the `internal_id` in the path.

<Warning>
  The response contains the package's proxy password. Treat it as a secret, and don't log full responses.
</Warning>

<ParamField path="id" type="string" required>
  The package's numeric `package_id` or its `internal_id`.
</ParamField>

<RequestExample>
  ```bash cURL theme={null}
  curl https://flameproxies.com/api/customer/packages/PACKAGE_ID \
    -H "Authorization: Bearer fp_live_xxx"
  ```

  ```python Python theme={null}
  import requests

  package_id = 123
  resp = requests.get(
      f"https://flameproxies.com/api/customer/packages/{package_id}",
      headers={"Authorization": "Bearer fp_live_xxx"},
  )
  pkg = resp.json()["package"]
  print(pkg["username"], pkg["usage"]["gb_remaining"])
  ```

  ```javascript Node.js theme={null}
  const packageId = 123;
  const resp = await fetch(`https://flameproxies.com/api/customer/packages/${packageId}`, {
    headers: { Authorization: "Bearer fp_live_xxx" },
  });
  const { package: pkg } = await resp.json();
  console.log(pkg.username, pkg.usage.gb_remaining);
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "package": {
      "id": 123,
      "package_id": 123,
      "internal_id": "70437286-78a1-427c-b9fd-c299baadf3a9",
      "subuser_id": "56789",
      "plan": "premium_residential",
      "username": "fp-user",
      "password": "proxy-password",
      "usage": {
        "bytes_used": 1200000000,
        "max_bytes": 5000000000,
        "remaining_bytes": 3800000000,
        "gb_used": 1.2,
        "gb_total": 5,
        "gb_remaining": 3.8,
        "percent_used": 24
      },
      "created_at": "2026-05-13T12:00:00.000Z",
      "end_date": null,
      "is_primary": true,
      "api_created": true
    }
  }
  ```
</ResponseExample>

## Response

<ResponseField name="package" type="object">
  The package.

  <Expandable title="properties">
    <ResponseField name="id" type="number">
      Package ID.
    </ResponseField>

    <ResponseField name="package_id" type="number">
      Numeric package ID.
    </ResponseField>

    <ResponseField name="internal_id" type="string">
      The package's UUID.
    </ResponseField>

    <ResponseField name="subuser_id" type="string">
      ID of the [sub-user](/dashboard/sub-users) behind this package.
    </ResponseField>

    <ResponseField name="plan" type="string">
      Product: `residential` or `premium_residential`.
    </ResponseField>

    <ResponseField name="username" type="string">
      Proxy username. Add [parameters](/proxies/residential#full-parameter-reference) after it to build a proxy line.
    </ResponseField>

    <ResponseField name="password" type="string">
      Proxy password.
    </ResponseField>

    <ResponseField name="usage" type="object">
      Live bandwidth usage.

      <Expandable title="usage">
        <ResponseField name="bytes_used" type="number">
          Bytes used so far.
        </ResponseField>

        <ResponseField name="max_bytes" type="number">
          Total bytes available on the package.
        </ResponseField>

        <ResponseField name="remaining_bytes" type="number">
          Bytes left.
        </ResponseField>

        <ResponseField name="gb_used" type="number">
          GB used so far.
        </ResponseField>

        <ResponseField name="gb_total" type="number">
          Total GB available on the package.
        </ResponseField>

        <ResponseField name="gb_remaining" type="number">
          GB left.
        </ResponseField>

        <ResponseField name="percent_used" type="number">
          Percentage of the package's bandwidth used.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="created_at" type="string">
      When the package was created, as an ISO 8601 timestamp.
    </ResponseField>

    <ResponseField name="end_date" type="string | null">
      End date of the package, or `null` if it has none.
    </ResponseField>

    <ResponseField name="is_primary" type="boolean">
      `true` for your main package.
    </ResponseField>

    <ResponseField name="api_created" type="boolean">
      `true` if the package was created through the Customer API.
    </ResponseField>
  </Expandable>
</ResponseField>