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

# Create plan experiment

> Start an experiment from the plan's current version with the changes given. It is sold only through its code (planCode `<plan code>:<code>`); new buyers of the plan keep getting the current version.

> [!NOTE]
>
> This reference describes API version `2026-06-10`. Send `Commet-Version: 2026-06-10` with your request.


## OpenAPI

````yaml /openapi/en/rest/2026-06-10.json post /plans/{id}/experiments
openapi: 3.1.0
info:
  title: Commet API
  version: '2026-06-10'
  description: Billing and payments API for SaaS and AI products.
servers:
  - url: https://commet.co/api/v1
security:
  - ApiKeyAuth: []
tags:
  - name: Test Clock
    description: >-
      Simulate the passage of time in sandbox to test billing flows. Mirrors
      Stripe test clocks: forward-only and sandbox-only.
  - name: Customers
  - name: Subscriptions
  - name: Plans
  - name: Promo Codes
  - name: Features
  - name: Usage
  - name: Seats
  - name: Quota
  - name: Add-ons
  - name: Portal
  - name: Credit Packs
  - name: Plan Groups
  - name: Invoices
  - name: Payments
    description: >-
      One-time payments with no subscription or plan. Charge a customer's saved
      payment method off-session, or create a payment link the customer opens to
      pay. Tax, invoice, and receipt are handled automatically.
  - name: Transactions
  - name: Webhooks
  - name: API Keys
  - name: Payouts
    description: >-
      Withdraw available balance to your bank and manage the payout account
      (verification + destination bank accounts).
  - name: Provisioning
    description: >-
      Take ownership of an organization an agent provisioned headlessly. The
      agent holds the API keys from the start; a human claims the account
      through a claim link.
paths:
  /plans/{id}/experiments:
    post:
      tags:
        - Plans
      summary: Create plan experiment
      description: >-
        Start an experiment from the plan's current version with the changes
        given. It is sold only through its code (planCode `<plan code>:<code>`);
        new buyers of the plan keep getting the current version.
      operationId: create-plan-experiment
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: Commet-Version
          in: header
          required: false
          description: >-
            API version used by this reference. Send this header to select this
            contract explicitly.
          schema:
            type: string
            default: '2026-06-10'
          example: '2026-06-10'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                prices:
                  default: []
                  type: array
                  items:
                    type: object
                    properties:
                      billingInterval:
                        type: string
                        enum:
                          - weekly
                          - monthly
                          - quarterly
                          - semiannual
                          - yearly
                          - one_time
                        description: >-
                          An interval the plan already sells. Prices not listed
                          are copied unchanged from the current version.
                      price:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        description: USD price in the currency's minor unit (cents).
                      includedCredits:
                        anyOf:
                          - type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          - type: 'null'
                      includedBalance:
                        anyOf:
                          - type: integer
                            minimum: 0
                            maximum: 9007199254740991
                          - type: 'null'
                      regionalPrices:
                        description: >-
                          Per-currency amounts. A currency the current version
                          does not sell also needs its exchangeRate in
                          currencies; its amounts not listed here are derived
                          from the USD price.
                        type: array
                        items:
                          type: object
                          properties:
                            currency:
                              type: string
                            price:
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            includedBalance:
                              anyOf:
                                - type: integer
                                  minimum: 0
                                  maximum: 9007199254740991
                                - type: 'null'
                          required:
                            - currency
                            - price
                          additionalProperties: false
                    required:
                      - billingInterval
                      - price
                    additionalProperties: false
                currencies:
                  default: []
                  description: >-
                    Currencies the current version does not sell, with the
                    exchange rate (local units per USD) used for the amounts not
                    listed, credit purchases, add-ons and overage.
                  type: array
                  items:
                    type: object
                    properties:
                      currency:
                        type: string
                      exchangeRate:
                        type: number
                        exclusiveMinimum: 0
                    required:
                      - currency
                      - exchangeRate
                    additionalProperties: false
                maxPlanCredits:
                  description: >-
                    Credits plans that roll over unused credits: the most plan
                    credits a subscription can hold. Null removes the cap.
                  anyOf:
                    - type: integer
                      minimum: 1
                      maximum: 2147483647
                    - type: 'null'
                maxPlanBalance:
                  description: >-
                    Balance plans that roll over unused balance: the most plan
                    balance a subscription can hold, in USD cents. Other
                    currencies convert it with the plan's exchange rate unless
                    the dashboard sets a custom amount for that currency. Null
                    removes the cap.
                  anyOf:
                    - type: integer
                      minimum: 1
                      maximum: 2147483647
                    - type: 'null'
                code:
                  type: string
                  description: >-
                    The experiment's own code: lowercase letters, numbers,
                    hyphens and underscores. It is sold as planCode `<plan
                    code>:<code>` and is never reused in the plan.
              required:
                - prices
                - currencies
                - code
              additionalProperties: false
      responses:
        '201':
          description: Success
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            RateLimit-Limit:
              description: Maximum number of requests allowed in the current window.
              schema:
                type: string
            RateLimit-Remaining:
              description: Requests remaining in the current window.
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    const: true
                  data:
                    $ref: '#/components/schemas/PlanExperiment'
                required:
                  - success
                  - data
        '400':
          description: Bad request
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too many requests
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            RateLimit-Limit:
              description: Maximum number of requests allowed in the current window.
              schema:
                type: string
            RateLimit-Remaining:
              description: Requests remaining in the current window.
              schema:
                type: string
            RateLimit-Reset:
              description: Seconds until the rate limit window resets.
              schema:
                type: string
            Retry-After:
              description: Seconds to wait before retrying the request.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  headers:
    RequestId:
      description: >-
        Server-generated identifier that correlates this response with Platform
        logs.
      schema:
        type: string
        format: uuid
  schemas:
    PlanExperiment:
      type: object
      properties:
        id:
          type: string
          description: Public plan experiment ID.
        code:
          type: string
          description: >-
            The code to sell it with as planCode, such as pro:price-test. It
            always sells the experiment's latest version while running, and the
            plan's current version once closed.
        status:
          type: string
          enum:
            - running
            - won
            - archived
          description: >-
            running sells its latest version; won became the plan's current
            version; archived stopped selling.
        startedFromVersionId:
          type: string
          description: The plan's version that was current when it started.
        latestVersionId:
          type: string
          description: Its latest version.
        sellsVersionId:
          type: string
          description: The version its code sells to new buyers today.
        subscriptionCount:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Active, trialing, past due and paused subscriptions on its versions.
        createdAt:
          type: string
          format: date-time
        closedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        object:
          type: string
          const: plan
        livemode:
          type: boolean
      required:
        - id
        - code
        - status
        - startedFromVersionId
        - latestVersionId
        - sellsVersionId
        - subscriptionCount
        - createdAt
        - closedAt
        - object
        - livemode
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          const: false
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
            param:
              type: string
            details: {}
            doc_url:
              type: string
          required:
            - type
            - code
            - message
            - doc_url
          additionalProperties: false
      required:
        - success
        - error
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

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