> ## 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 subscription billing overview

> Returns the current subscription, both credit bucket breakdowns
(monthly subscription credits + top-up credits), per-user usage for the
current period, payment methods, next charge, and any scheduled change.


## OpenAPI

````yaml https://neo.api.projectdiscovery.io/api/openapi.json get /api/v1/billing/subscription
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: 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: Model discovery and capabilities
    name: Models
  - description: Third-party integrations
    name: Integrations
  - description: Skill knowledge documents for agent prompts
    name: Skills
  - 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
paths:
  /api/v1/billing/subscription:
    get:
      tags:
        - Billing
      summary: Get subscription billing overview
      description: |
        Returns the current subscription, both credit bucket breakdowns
        (monthly subscription credits + top-up credits), per-user usage for the
        current period, payment methods, next charge, and any scheduled change.
      operationId: get-v1-billing-subscription
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingSubscriptionOverviewResponse'
          description: Subscription overview
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal server error
      security:
        - BearerAuth: []
        - ApiKeyAuth: []
components:
  schemas:
    BillingSubscriptionOverviewResponse:
      properties:
        available_credits:
          format: double
          type: number
        cancel_at_period_end:
          type: boolean
        discount_credits:
          description: >-
            Bonus subscription credits currently granted from the first-month
            discount (per-seat allotment above the billed tier). 0 once the
            first credit-month has settled or when no discount applies.
          format: double
          type: number
        has_subscription:
          type: boolean
        next_charge_cents:
          type: integer
        next_charge_display:
          type: string
        payment_methods:
          items:
            $ref: '#/components/schemas/BillingPaymentMethod'
          type: array
        pending_change:
          $ref: '#/components/schemas/BillingPendingChange'
        per_seat_usage:
          items:
            $ref: '#/components/schemas/BillingUserUsage'
          type: array
        plan:
          $ref: '#/components/schemas/BillingSubscriptionPlan'
        renews_at:
          format: date-time
          type: string
        reset_at:
          description: When the monthly subscription credits next reset
          format: date-time
          type: string
        status:
          description: active, past_due, canceled, incomplete
          type: string
        subscription_credits:
          description: Monthly subscription grant total (seats x credits_per_user)
          format: double
          type: number
        subscription_remaining:
          format: double
          type: number
        subscription_used:
          format: double
          type: number
        topup_credits:
          description: Current top-up bucket total (issued_credits)
          format: double
          type: number
        topup_expires_at:
          format: date-time
          type: string
        topup_purchased:
          description: Lifetime total top-up credits purchased for this resource.
          format: double
          type: number
        topup_remaining:
          format: double
          type: number
        topup_used:
          description: Lifetime top-up credits consumed (purchased - current balance).
          format: double
          type: number
        used_credits:
          format: double
          type: number
      required:
        - has_subscription
      type: object
    ErrorResponse:
      properties:
        code:
          description: >
            Stable machine-readable error code — branch on this rather than

            matching the human `error`/`message` strings. Domain codes include

            `user_spending_cap_reached`, `project_spending_cap_reached`, and

            `insufficient_neo_credits`; 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
      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
    BillingPendingChange:
      properties:
        credits_per_user:
          type: integer
        demote_member_emails:
          description: >-
            Members that will be demoted to non-premium when this scheduled
            change takes effect.
          items:
            type: string
          type: array
        effective_at:
          format: date-time
          type: string
        interval:
          type: string
        seats:
          type: integer
      type: object
    BillingUserUsage:
      properties:
        allotment:
          description: >-
            This seat's monthly per-seat credit allotment (0 for non-premium
            members).
          format: double
          type: number
        discount:
          description: >-
            First-month bonus (discount) credits included in this seat's
            allotment (allotment above the billed tier; 0 once the first
            credit-month settles or when the seat carries no bonus).
          format: double
          type: number
        email:
          type: string
        remaining:
          description: >-
            Remaining seat credits for this member (allotment - used, floored at
            0).
          format: double
          type: number
        seat_status:
          description: >-
            Seat state for this member - active, held, open, or none
            (non-premium, no seat).
          type: string
        used:
          format: double
          type: number
      type: object
    BillingSubscriptionPlan:
      properties:
        collection_method:
          type: string
        credits_per_user:
          type: integer
        discount_credits_per_user:
          description: >-
            First-month bonus credits granted per discounted seat
            (credits_per_user x (multiplier - 1)). 0 once the first-month
            discount window has closed or when no promo applies.
          type: integer
        interval:
          type: string
        seats:
          type: integer
      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

````