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

> ## Agent Instructions
> Use Stable documentation by default. Honor an explicit Beta request or a URL under /docs/beta/. If the requested version conflicts with the installed CLI package or API origin, clarify the target before writing integration code.
> Pages under /docs/beta/ document Beta; other product pages document Stable. Keep the CLI package, commands, API origin, and credentials within the selected version. State the documentation version in your answer.
> For MCP search, always pass version: Stable or version: Beta. Unfiltered search mixes both versions. For filesystem reads, keep Beta queries under /beta/ and exclude /beta/ from Stable queries; discover paths before reading them.
> The public docs base is https://photon.codes/docs. Convert MCP page paths to public URLs under that base, preserving /beta/ when present. Read https://photon.codes/docs/skill.md for version selection and https://photon.codes/docs/llms.txt for the version indexes.

# Get project billing overview

> Get project billing overview: getBillingOverview in the TypeScript, Python and Rust clients.

`GET /v1/projects/{projectId}/billing`

Returns the selected project's plan information, entitlements and current billing-period usage. This operation reads project billing state; it does not change plans or the payer's payment method. Organization-level plans are available through the organization billing overview.

<Tabs>
  <Tab title="TypeScript">
    ```typescript TypeScript theme={null}
    photon.projects.billing.getOverview(input: GetBillingOverviewInput, options?: RequestOptions): Promise<GetBillingOverviewOutput>
    ```
  </Tab>

  <Tab title="Python">
    ```python Python theme={null}
    photon.projects.billing.get_overview(input: GetBillingOverviewInput) -> models.GetBillingOverviewResponse
    ```
  </Tab>

  <Tab title="Rust">
    ```rust Rust theme={null}
    client.get_billing_overview(project_id: String).await -> Result<ResponseValue<types::GetBillingOverviewResponse>, Error<GetBillingOverviewError>>
    ```
  </Tab>
</Tabs>

<RequestExample>
  ```typescript TypeScript theme={null}
  import { Photon } from "@photon-ai/api";

  const photon = new Photon({
    headers: { Authorization: `Bearer ${process.env.PHOTON_API_TOKEN}` },
  });
  const result = await photon.projects.billing.getOverview({
    path: {
      projectId: "projectId",
    },
  });
  ```

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

  from photon_api import Photon
  from photon_api.rpc_generated import GetBillingOverviewInput

  photon = Photon(headers={"Authorization": f"Bearer {os.environ['PHOTON_API_TOKEN']}"})
  result = photon.projects.billing.get_overview(
      GetBillingOverviewInput.model_validate({
          "path": {
              "projectId": "projectId",
          },
      })
  )
  ```

  ```rust Rust theme={null}
  use photon_ai_api::{Credential, PhotonClientBuilder, SecretString};

  let token = std::env::var("PHOTON_API_TOKEN")?;
  let client = PhotonClientBuilder::new()
      .credential("accountServiceKey", Credential::Bearer(SecretString::from(token)))
      .build()?;
  let result = client
      .get_billing_overview("projectId".to_owned())
      .await
      .map_err(|error| format!("{error:?}"))?
      .into_inner();
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "entitlementsVersion": 0,
    "subscriptions": [
      {
        "baseAmountCents": 0,
        "cancelsAt": null,
        "category": "string",
        "categoryDisplayName": null,
        "currency": "string",
        "currentPeriodEnd": null,
        "entitlements": [
          {
            "featureKey": "string",
            "value": "string"
          }
        ],
        "fixedCharges": [
          {
            "chargeModel": "graduated",
            "displayName": "string",
            "fixedChargeCode": "string",
            "payInAdvance": true,
            "pricing": {},
            "prorated": true,
            "quantity": 0
          }
        ],
        "minimumCommitment": null,
        "planCode": "string",
        "planName": "string",
        "status": "active",
        "tierDisplayName": null
      }
    ],
    "usage": [
      {
        "amountCents": -9007199254740991,
        "category": "string",
        "categoryDisplayName": null,
        "currency": "string",
        "displayName": "string",
        "metricCode": "string",
        "units": -9007199254740991
      }
    ]
  }
  ```
</ResponseExample>

## Parameters

<ParamField path="projectId" type={"string"} required>
  The project being billed.
</ParamField>

## Returns

**`200`** Plan, entitlements, and current-period usage. GetBillingOverviewResponse

<ResponseField name="entitlementsVersion" type={"integer"} required>
  Bumps on every entitlement change in any category.
</ResponseField>

<ResponseField name="subscriptions" type={"array of ProjectSubscription"} required>
  One entry per category that currently holds a subscription. Empty means none do — cancelled, or never opened.
</ResponseField>

<ResponseField name="usage" type={"array of MeteredUsage"} required>
  Current-period metered usage, priced.
</ResponseField>


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