---
title: "Get organization credit balance"
method: GET
path: "/v3/accounts/organizations/{organization_id}/credits"
tags: ["Account Management"]
---

# Get organization credit balance

`GET /v3/accounts/organizations/{organization_id}/credits`

## Request

- Base URL: `https://api.platform.censys.io`
- URL: `https://api.platform.censys.io/v3/accounts/organizations/{organization_id}/credits`
- Auth: HTTP bearer

Retrieve credit balance and expiration information for an organization. <br><br>Credits expire 12 months after they are acquired.<br><br>This endpoint does not cost any credits to execute.

## Path parameters

- `organization_id` string, uuid, required: The ID of a Censys organization. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information.

## Response `200`

OK

- ResponseEnvelopeOrganizationCredits
  - `result` OrganizationCredits
    - `auto_replenish_config` AutoReplenishConfig, required
      - `amount` integer: The amount of credits to replenish when auto-replenish is triggered.
      - `enabled` boolean, required: Whether the organization has auto-replenish enabled.
      - `threshold` integer: The threshold at which the organization's credit balance will be auto-replenished.
    - `balance` integer, required: The current credit balance for the organization.
    - `credit_expirations` CreditExpiration[], nullable, required: The credit expirations for the organization.
      - `balance` integer, required: The current balance of the credit expiration.
      - `created_at` string, date-time: The date and time the credit expiration was created.
      - `expires_at` string, date-time: The date and time the credit expiration will expire.
      - `initial_balance` integer, required: The initial balance of the credit expiration (i.e. how much was purchased).
    - `uid` string, uuid, required: The ID of a Censys organization.

## Other responses

- `401`: Request does not contain a valid Authorization token
- `403`: User does not have permission to access this data
- `404`: Organization not found
- `422`: Invalid organization ID
- `500`: Internal server error

---

[API](https://skmtc.dev/censys/apis/censys-platform-api.md) - [All operations](https://skmtc.dev/censys/apis/censys-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/censys/apis/censys-platform-api/revisions/ec1686b0a36a?raw)