> ## 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.

# Start or estimate a subscription

> Creates the first per-seat subscription (collection_method=charge_automatically).
With no saved card, returns a Stripe Checkout redirect; with a saved card,
creates the subscription and charges the first invoice immediately. The
"estimate" action returns pricing only.




## OpenAPI

````yaml /openapi/neo.public.openapi.json post /api/v1/billing/subscription/checkout
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/subscription/checkout:
    post:
      tags:
        - Billing
      summary: Start or estimate a subscription
      description: >
        Creates the first per-seat subscription
        (collection_method=charge_automatically).

        With no saved card, returns a Stripe Checkout redirect; with a saved
        card,

        creates the subscription and charges the first invoice immediately. The

        "estimate" action returns pricing only.
      operationId: post-v1-billing-subscription-checkout
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BillingSubscriptionCheckoutRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingSubscriptionCheckoutResponse'
          description: Subscription estimate, redirect, or charged
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '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:
    BillingSubscriptionCheckoutRequest:
      properties:
        action:
          enum:
            - estimate
            - checkout
          type: string
        credits_per_user:
          deprecated: true
          description: Legacy compatibility for an existing credit subscription only.
          type: integer
        interval:
          enum:
            - month
            - year
          type: string
        plan_code:
          enum:
            - base
            - plus_2x
            - plus_5x
          type: string
        redirect_cancel_url:
          description: Optional cancel redirect for the hosted checkout.
          type: string
        redirect_return_url:
          description: Optional return redirect for the hosted checkout.
          type: string
        redirect_success_url:
          description: Optional success redirect for the hosted checkout.
          type: string
        seats:
          type: integer
        ui_mode:
          description: >-
            Checkout UI mode for action=checkout. "hosted" (default) returns a
            Stripe Checkout redirect url; "embedded" returns a client_secret for
            Stripe Embedded Checkout rendered inline; "elements" creates an
            incomplete subscription and returns the PaymentIntent client_secret
            for a Stripe Payment Element (Elements) rendered inline.
          enum:
            - hosted
            - embedded
            - elements
          type: string
          x-enum-varnames:
            - BillingSubscriptionCheckoutRequestUiModeHosted
            - BillingSubscriptionCheckoutRequestUiModeEmbedded
            - BillingSubscriptionCheckoutRequestUiModeElements
      required:
        - action
        - seats
        - interval
      type: object
    BillingSubscriptionCheckoutResponse:
      properties:
        action:
          enum:
            - estimate
            - redirect
            - embedded
            - elements
            - charged
          type: string
        amount_cents:
          type: integer
        amount_display:
          type: string
        client_secret:
          description: >-
            Client secret for inline payment UI. Embedded Checkout session
            secret (action=embedded) or the subscription PaymentIntent secret
            for the Payment Element (action=elements).
          type: string
        credits_per_user:
          type: integer
        has_payment_method:
          type: boolean
        interval:
          type: string
        invoice_id:
          description: Stripe Invoice ID (action=charged)
          type: string
        invoice_url:
          type: string
        payment_methods:
          items:
            $ref: '#/components/schemas/BillingPaymentMethod'
          type: array
        seats:
          type: integer
        session_id:
          type: string
        subscription_id:
          description: Stripe Subscription ID (action=elements)
          type: string
        unit_price:
          format: double
          type: number
        url:
          description: Stripe Checkout URL (action=redirect)
          type: string
      required:
        - action
      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.