> ## Documentation Index > Fetch the complete documentation index at: https://docs.neo.projectdiscovery.io/llms.txt > Use this file to discover all available pages before exploring further. # Get credit balance > Returns the current credit balance, usage, and expiry for the authenticated user or their team. ## OpenAPI ````yaml /openapi/neo.public.openapi.json get /api/v1/billing/credits openapi: 3.1.0 info: contact: name: ProjectDiscovery url: https://neo.projectdiscovery.io description: Neo API Server - Security agent orchestration platform license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 title: Neo API version: 1.0.0 servers: - description: Production url: https://neo.api.projectdiscovery.io - description: Development url: https://neo.api.dev.projectdiscovery.io - description: Local development url: http://localhost:8080 security: [] tags: - description: Task execution and management name: Tasks - description: Agent listing and management name: Agents - description: Public agent directory name: Agent Directory - description: User file storage management name: Files - description: User working memory management name: Memory - description: Scheduled and recurring task management name: Schedules - description: Knowledge base and semantic search name: Knowledge - description: Encrypted user credentials and API keys name: Secrets - description: Neo API key management for programmatic access name: API Keys - description: User profile and account information name: User - description: Task and LLM usage tracking name: Usage - description: Bring Your Own Key provider management name: BYOK - description: Connect personal AI provider accounts and select them as a model source name: AI Connections - description: Model discovery and capabilities name: Models - description: Third-party integrations name: Integrations - description: Skill knowledge documents for agent prompts name: Skills - description: User-authored tools and toolkit management name: Dynamic Tools - description: Team management and member invitations name: Teams - description: Prompt library management and discovery name: Prompts - description: Slack bot integration for workspace installation and OAuth name: Slack - description: GitHub integration for PR reviews and repository management name: GitHub - description: Vulnerability issue tracking and management name: Issues - description: Subscription billing and plans name: Billing - description: Project management and member assignments name: Projects - description: SSH key pair generation and management for remote server access name: SSH Keys - description: Codebase structural analysis and mapping name: Codemaps - description: AI-generated codebase documentation and security analysis name: CodeWiki - description: Captured HTTP traffic query and replay name: Network Events - description: User and team API activity metadata name: Audit Logs - description: Vulnerability triage for HackerOne, GitHub, and Security Inbox name: Triage paths: /api/v1/billing/credits: get: tags: - Billing summary: Get credit balance description: | Returns the current credit balance, usage, and expiry for the authenticated user or their team. operationId: get-v1-billing-credits responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingCreditsResponse' description: Credit balance '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Forbidden - team admin role required '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Internal server error security: - BearerAuth: [] - ApiKeyAuth: [] components: schemas: BillingCreditsResponse: properties: available_credits: format: double type: number expires_at: format: date-time type: string grand_total_issued_credits: description: > Grand total credits ever issued to this resource. For subscription customers, the sum of every monthly subscription grant (subscription_grant/renew/proration) plus all top-up purchases and positive admin amount grants. For non-subscription customers, top-up purchases and admin amount grants only. Not reduced by usage, expiry, or cancellation. format: double type: number grand_total_used_credits: description: > Total task spend counted from the most recent admin usage reset (reset_usage event); all-time when no admin reset exists. Independent of subscription renewal/settlement window moves. format: double type: number has_payment_method: type: boolean has_purchased: description: Whether user has ever purchased credits via Stripe type: boolean is_expired: type: boolean issued_credits: format: double type: number last_purchase_at: description: Date of the most recent credit purchase format: date-time type: string last_purchase_credits: description: Credits from the most recent purchase format: double type: number payment_methods: items: $ref: '#/components/schemas/BillingPaymentMethod' type: array resource_type: enum: - user - team type: string used_credits: format: double type: number required: - issued_credits - used_credits - available_credits type: object ErrorResponse: properties: code: description: > Stable machine-readable error code — branch on this rather than matching the human `error`/`message` strings. `access_restricted` (HTTP 403) denies hosted Neo access under the access policy. On team invitations, param=email identifies a restricted recipient rather than the caller; show the error without redirecting the caller. Domain codes include `user_spending_cap_reached`, `project_spending_cap_reached`, and `insufficient_neo_credits`; Free/usage codes include `free_grant_challenge_required`, `free_usage_exhausted`, `free_task_budget_exhausted`, `model_not_available_on_free`, `sandbox_not_available_on_free` (cloud sandbox surfaces are not available on the Free plan; task files remain available from the task), `free_cannot_continue_managed_task` (a task that ran on the standard cloud sandbox cannot be continued on the Free plan; start a new task), `free_origin_not_supported` (integration-originated tasks are not available on the Free plan), `weekly_usage_limit_reached`, `billing_period_usage_limit_reached`, `topup_required`, `subscription_required`, and `isolated_workspace_purged`. Otherwise it mirrors the error kind (e.g. `forbidden`, `invalid_request`, `not_exists`, `already_exists`). example: user_spending_cap_reached type: string error: example: Bad request type: string error_id: description: Correlation id for a specific error instance, when present. type: string kind: description: Coarse error category (e.g. "forbidden request", "invalid request"). example: forbidden request type: string message: description: | Human-readable detail (the kind prefixed to the error). For display, not for branching. type: string param: description: >- Field rejected by the policy; email for a restricted invite recipient. type: string turnstile_site_key: description: | Public Cloudflare Turnstile site key returned only with `free_grant_challenge_required`, so the client can complete the invisible verification before retrying the request. type: string required: - error type: object BillingPaymentMethod: properties: brand: description: Card brand (visa, mastercard, amex, etc.) type: string email: description: Account email for Link/PayPal payment methods type: string exp_month: description: Card expiration month (1-12) type: integer exp_year: description: Card expiration year type: integer id: description: Stripe Payment Method ID type: string is_default: description: Whether this is the default payment method type: boolean last4: description: Last 4 digits of the card type: string type: description: >- Payment method type (card, link, us_bank_account, sepa_debit, paypal, etc.) type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT authentication token scheme: bearer type: http ApiKeyAuth: description: Neo API key (neo_sk_* prefix) in: header name: X-Api-Key type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.