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

# Get the current organization's Agent simulation plan

> The organization's current plan subscription, or null when it has none (never started, canceled or expired). status is Stripe's subscription status: active and trialing are paid up; past_due and unpaid mean a renewal is failing. trialAvailable is true when starting now would begin with a free first month: an organization's first plan gets one, and staff can offer one to an organization that has had a plan before. trialEnd is when billing would start if the plan were started now, null when there is no free month. access says what the plan allows: active (trialing, active or past_due) runs studies and buys credits; none buys nothing, and runs a study only on credits added earlier, which outlive the plan (a year from purchase) while its plan credits expire with it.



## OpenAPI

````yaml https://api.zeroclick.io/openapi.json get /v1/organizations/current/plan
openapi: 3.0.0
info:
  title: ZeroClick API
  description: >-
    REST API for managing ZeroClick sellers, services, pricing, usage, and
    analytics. Authenticate with an API key from the ZeroClick dashboard.
  version: 1.0.0
servers:
  - url: https://api.zeroclick.io
security:
  - bearerAuth: []
tags:
  - name: API keys
  - name: Sellers
  - name: Services
  - name: Meters
  - name: Plans
  - name: Plan meter prices
  - name: Usage
  - name: Analytics
  - name: Agentify
  - name: Stripe Connect
  - name: Sandbox
  - name: Organizations
  - name: Users
paths:
  /v1/organizations/current/plan:
    get:
      tags:
        - Organizations
      summary: Get the current organization's Agent simulation plan
      description: >-
        The organization's current plan subscription, or null when it has none
        (never started, canceled or expired). status is Stripe's subscription
        status: active and trialing are paid up; past_due and unpaid mean a
        renewal is failing. trialAvailable is true when starting now would begin
        with a free first month: an organization's first plan gets one, and
        staff can offer one to an organization that has had a plan before.
        trialEnd is when billing would start if the plan were started now, null
        when there is no free month. access says what the plan allows: active
        (trialing, active or past_due) runs studies and buys credits; none buys
        nothing, and runs a study only on credits added earlier, which outlive
        the plan (a year from purchase) while its plan credits expire with it.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  plan:
                    nullable: true
                    type: object
                    properties:
                      id:
                        type: string
                      status:
                        type: string
                      currentPeriodStart:
                        nullable: true
                        type: string
                      currentPeriodEnd:
                        nullable: true
                        type: string
                      cancelAtPeriodEnd:
                        type: boolean
                      trialEnd:
                        nullable: true
                        type: string
                    required:
                      - id
                      - status
                      - currentPeriodStart
                      - currentPeriodEnd
                      - cancelAtPeriodEnd
                      - trialEnd
                    additionalProperties: false
                  trialAvailable:
                    type: boolean
                  trialEnd:
                    nullable: true
                    type: string
                    format: date-time
                    pattern: >-
                      ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                  access:
                    type: object
                    properties:
                      state:
                        type: string
                        enum:
                          - active
                          - none
                    required:
                      - state
                    additionalProperties: false
                required:
                  - plan
                  - trialAvailable
                  - trialEnd
                  - access
                additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key created in the ZeroClick dashboard under Settings → API keys.
        Keys start with `zc_`. Send them as `Authorization: Bearer zc_...`.

````

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