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

# Start the Agent Simulations plan on the saved card

> Subscribes the organization to the monthly Agent Simulations plan on its saved card, adding 1,000 credits once the first invoice is paid. When trialAvailable, the first month is free: a $0 invoice still adds the credits and the card is first charged at trialEnd. Starting a plan that is set to cancel at period end resumes it instead. A requires_action result carries a client secret for Stripe.js to finish card authentication, after which POST /current/plan/confirm activates the plan. A new plan starts under the current Agent Simulation Terms: while the organization has not accepted them (GET /current/plan says, in terms), the start carries terms (version, sha256 and the consent sentence shown), recorded as the caller's acceptance, else 409 terms_required (409 terms_stale when the page showed an older version); and it carries renewal, the renewal disclosure shown above the button, recorded as the caller's consent before the plan starts (409 disclosure_required without it). Staff working in an organization through the switcher are never asked and nothing is recorded for them. Organization admins only.



## OpenAPI

````yaml https://api.zeroclick.io/openapi.json post /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:
    post:
      tags:
        - Organizations
      summary: Start the Agent Simulations plan on the saved card
      description: >-
        Subscribes the organization to the monthly Agent Simulations plan on its
        saved card, adding 1,000 credits once the first invoice is paid. When
        trialAvailable, the first month is free: a $0 invoice still adds the
        credits and the card is first charged at trialEnd. Starting a plan that
        is set to cancel at period end resumes it instead. A requires_action
        result carries a client secret for Stripe.js to finish card
        authentication, after which POST /current/plan/confirm activates the
        plan. A new plan starts under the current Agent Simulation Terms: while
        the organization has not accepted them (GET /current/plan says, in
        terms), the start carries terms (version, sha256 and the consent
        sentence shown), recorded as the caller's acceptance, else 409
        terms_required (409 terms_stale when the page showed an older version);
        and it carries renewal, the renewal disclosure shown above the button,
        recorded as the caller's consent before the plan starts (409
        disclosure_required without it). Staff working in an organization
        through the switcher are never asked and nothing is recorded for them.
        Organization admins only.
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 200
          in: header
          name: idempotency-key
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              nullable: true
              type: object
              properties:
                clientIp:
                  anyOf:
                    - type: string
                      format: ipv4
                      pattern: >-
                        ^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$
                    - type: string
                      format: ipv6
                      pattern: >-
                        ^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$
                clientUserAgent:
                  type: string
                  minLength: 1
                  maxLength: 512
                clientCountry:
                  type: string
                  minLength: 2
                  maxLength: 2
                renewal:
                  type: object
                  properties:
                    disclosure:
                      type: string
                      minLength: 1
                      maxLength: 4000
                  required:
                    - disclosure
                terms:
                  type: object
                  properties:
                    version:
                      type: string
                      minLength: 1
                      maxLength: 80
                    sha256:
                      type: string
                      pattern: ^[0-9a-f]{64}$
                    consentText:
                      type: string
                      minLength: 1
                      maxLength: 1000
                  required:
                    - version
                    - sha256
                    - consentText
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - active
                      - requires_action
                      - processing
                  clientSecret:
                    nullable: true
                    type: string
                  publishableKey:
                    nullable: true
                    type: string
                  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:
                    nullable: true
                    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:
                    nullable: true
                    type: object
                    properties:
                      state:
                        type: string
                        enum:
                          - active
                          - none
                    required:
                      - state
                    additionalProperties: false
                  terms:
                    nullable: true
                    type: object
                    properties:
                      version:
                        type: string
                      sha256:
                        type: string
                      legalUrl:
                        type: string
                    required:
                      - version
                      - sha256
                      - legalUrl
                    additionalProperties: false
                required:
                  - status
                  - clientSecret
                  - publishableKey
                  - plan
                  - trialAvailable
                  - trialEnd
                  - access
                  - terms
                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.