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

# Update plan

> Update a plan's name, description, visibility, default status, metadata, overage behavior, what happens to its unused plan credits or plan balance, or its plan credit or plan balance limit.

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


## OpenAPI

````yaml /openapi/es/rest/2026-05-25.json put /plans/{id}/manage
openapi: 3.1.0
info:
  title: Commet API
  version: '2026-05-25'
  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}/manage:
    put:
      tags:
        - Plans
      summary: Update plan
      description: >-
        Update a plan's name, description, visibility, default status, metadata,
        overage behavior, what happens to its unused plan credits or plan
        balance, or its plan credit or plan balance limit.
      operationId: update-plan
      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-05-25'
          example: '2026-05-25'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                description:
                  type:
                    - string
                    - 'null'
                metadata:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties: {}
                isPublic:
                  type: boolean
                unusedPlanCredits:
                  description: >-
                    Credits plans only. What happens to unused plan credits at
                    each reset. Changing it publishes a new version of the plan;
                    each subscription stays on its version until moved.
                  oneOf:
                    - type: object
                      properties:
                        type:
                          type: string
                          const: expire
                      required:
                        - type
                      additionalProperties: false
                      description: >-
                        Each reset replaces unused plan credits with the price's
                        included credits.
                    - type: object
                      properties:
                        type:
                          type: string
                          const: roll_over
                        maxPlanCredits:
                          anyOf:
                            - type: integer
                              exclusiveMinimum: 0
                              maximum: 2147483647
                            - type: 'null'
                          description: >-
                            The most plan credits a subscription holds after a
                            reset, including the credits that reset grants;
                            credits above it expire. At least the included
                            credits of every price. null means no limit other
                            than the largest storable balance, 2,147,483,647
                            plan credits.
                      required:
                        - type
                        - maxPlanCredits
                      additionalProperties: false
                      description: >-
                        Unused plan credits roll over: each reset adds the
                        price's included credits to them.
                planCreditLimit:
                  description: >-
                    Credits plans only. The most plan credits a subscription
                    spends per day or per week; null removes the limit. Changing
                    it publishes a new version of the plan; each subscription
                    stays on its version until moved.
                  anyOf:
                    - type: object
                      properties:
                        credits:
                          type: integer
                          exclusiveMinimum: 0
                          maximum: 2147483647
                          description: >-
                            The most plan credits a subscription spends in one
                            window.
                        interval:
                          type: string
                          enum:
                            - day
                            - week
                          description: >-
                            The window length: `day` is 24 hours and `week` is 7
                            days, starting at the time of day of the
                            subscription's billing anchor.
                      required:
                        - credits
                        - interval
                      additionalProperties: false
                      description: >-
                        Caps how many plan credits a subscription spends per
                        window. Purchased credits are never limited: usage past
                        the limit draws from them. Changing it publishes a new
                        version of the plan; each subscription stays on its
                        version until moved.
                    - type: 'null'
                unusedPlanBalance:
                  description: >-
                    Balance plans only. What happens to unused plan balance at
                    each reset. Changing it publishes a new version of the plan;
                    each subscription stays on its version until moved.
                  oneOf:
                    - type: object
                      properties:
                        type:
                          type: string
                          const: expire
                      required:
                        - type
                      additionalProperties: false
                      description: >-
                        Each reset replaces unused plan balance with the price's
                        included balance.
                    - type: object
                      properties:
                        type:
                          type: string
                          const: roll_over
                        maxPlanBalance:
                          anyOf:
                            - type: integer
                              exclusiveMinimum: 0
                              maximum: 2147483647
                            - type: 'null'
                          description: >-
                            The most plan balance a subscription holds after a
                            reset, in USD cents, including the balance that
                            reset grants; balance above it expires. At least the
                            included balance of every price. Other currencies
                            convert it with the plan's exchange rate unless the
                            dashboard sets a custom amount for that currency.
                            null means no limit other than the largest storable
                            amount, 2,147,483,647 cents.
                      required:
                        - type
                        - maxPlanBalance
                      additionalProperties: false
                      description: >-
                        Unused plan balance rolls over: each reset adds the
                        price's included balance to it.
                planBalanceLimit:
                  description: >-
                    Balance plans only. The most plan balance a subscription
                    spends per day or per week, in USD cents; null removes the
                    limit. Changing it publishes a new version of the plan; each
                    subscription stays on its version until moved.
                  anyOf:
                    - type: object
                      properties:
                        amount:
                          type: integer
                          exclusiveMinimum: 0
                          maximum: 2147483647
                          description: >-
                            The most plan balance a subscription spends in one
                            window, in USD cents. Other currencies convert it
                            with the plan's exchange rate unless the dashboard
                            sets a custom amount for that currency.
                        interval:
                          type: string
                          enum:
                            - day
                            - week
                          description: >-
                            The window length: `day` is 24 hours and `week` is 7
                            days, starting at the time of day of the
                            subscription's billing anchor.
                      required:
                        - amount
                        - interval
                      additionalProperties: false
                      description: >-
                        Caps how much plan balance a subscription spends per
                        window. Purchased balance is never limited: usage past
                        the limit draws from it. Changing it publishes a new
                        version of the plan; each subscription stays on its
                        version until moved.
                    - type: 'null'
                blockOnExhaustion:
                  description: >-
                    Credits and balance plans only. false lets usage continue
                    past the plan and purchased amounts and bills the missing
                    amount as overage at the next renewal; a credits plan bills
                    it at the price per credit and needs one. Trials and free
                    plans always stop, so free plans accept only true. Changing
                    it publishes a new version of the plan; each subscription
                    stays on its version until moved.
                  type: boolean
                isDefault:
                  description: >-
                    Make this plan the default plan of its plan group: customers
                    created with that planGroupId start on it, and a paid plan
                    of the group that ends from the customer portal, a revoked
                    payment authorization or exhausted dunning moves to it
                    instead of canceling. Requires a free plan in a plan group;
                    replaces the group's previous default plan. false unmarks
                    it.
                  type: boolean
              additionalProperties: false
      responses:
        '200':
          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/PlanSummary'
                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'
        '409':
          description: Conflict
          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:
    PlanSummary:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        code:
          type: string
        description:
          type:
            - string
            - 'null'
        consumptionModel:
          anyOf:
            - type: string
              enum:
                - metered
                - credits
                - balance
            - type: 'null'
        isPublic:
          type: boolean
        isDefault:
          type: boolean
        isFree:
          type: boolean
        blockOnExhaustion:
          description: >-
            Credits and balance plans: true stops usage when the plan and
            purchased amounts run out; false lets usage continue and bills the
            missing amount as overage at the next renewal (credits at the price
            per credit). Trials and free plans always stop.
          type:
            - boolean
            - 'null'
        unusedPlanCredits:
          anyOf:
            - oneOf:
                - type: object
                  properties:
                    type:
                      type: string
                      const: expire
                  required:
                    - type
                  additionalProperties: false
                  description: >-
                    Each reset replaces unused plan credits with the price's
                    included credits.
                - type: object
                  properties:
                    type:
                      type: string
                      const: roll_over
                    maxPlanCredits:
                      anyOf:
                        - type: integer
                          exclusiveMinimum: 0
                          maximum: 2147483647
                        - type: 'null'
                      description: >-
                        The most plan credits a subscription holds after a
                        reset, including the credits that reset grants; credits
                        above it expire. At least the included credits of every
                        price. null means no limit other than the largest
                        storable balance, 2,147,483,647 plan credits.
                  required:
                    - type
                    - maxPlanCredits
                  additionalProperties: false
                  description: >-
                    Unused plan credits roll over: each reset adds the price's
                    included credits to them.
              description: >-
                What happens to unused plan credits at each reset, including the
                reset of a subscription that changes to this plan. Purchased
                credits never expire and never count toward maxPlanCredits.
                Changing it publishes a new version of the plan; each
                subscription stays on its version until moved.
            - type: 'null'
          description: >-
            Credits plans only; null for other consumption models. What happens
            to unused plan credits at each reset. Purchased credits never expire
            and never count toward maxPlanCredits.
        planCreditLimit:
          anyOf:
            - type: object
              properties:
                credits:
                  type: integer
                  exclusiveMinimum: 0
                  maximum: 2147483647
                  description: The most plan credits a subscription spends in one window.
                interval:
                  type: string
                  enum:
                    - day
                    - week
                  description: >-
                    The window length: `day` is 24 hours and `week` is 7 days,
                    starting at the time of day of the subscription's billing
                    anchor.
              required:
                - credits
                - interval
              additionalProperties: false
              description: >-
                Caps how many plan credits a subscription spends per window.
                Purchased credits are never limited: usage past the limit draws
                from them. Changing it publishes a new version of the plan; each
                subscription stays on its version until moved.
            - type: 'null'
          description: >-
            Credits plans only. The most plan credits a subscription spends per
            day or per week; null means no limit.
        unusedPlanBalance:
          anyOf:
            - oneOf:
                - type: object
                  properties:
                    type:
                      type: string
                      const: expire
                  required:
                    - type
                  additionalProperties: false
                  description: >-
                    Each reset replaces unused plan balance with the price's
                    included balance.
                - type: object
                  properties:
                    type:
                      type: string
                      const: roll_over
                    maxPlanBalance:
                      anyOf:
                        - type: integer
                          exclusiveMinimum: 0
                          maximum: 2147483647
                        - type: 'null'
                      description: >-
                        The most plan balance a subscription holds after a
                        reset, in USD cents, including the balance that reset
                        grants; balance above it expires. At least the included
                        balance of every price. Other currencies convert it with
                        the plan's exchange rate unless the dashboard sets a
                        custom amount for that currency. null means no limit
                        other than the largest storable amount, 2,147,483,647
                        cents.
                  required:
                    - type
                    - maxPlanBalance
                  additionalProperties: false
                  description: >-
                    Unused plan balance rolls over: each reset adds the price's
                    included balance to it.
              description: >-
                What happens to unused plan balance at each reset, including the
                reset of a subscription that changes to this plan. Purchased
                balance never expires and never counts toward maxPlanBalance.
                Changing it publishes a new version of the plan; each
                subscription stays on its version until moved.
            - type: 'null'
          description: >-
            Balance plans only; null for other consumption models. What happens
            to unused plan balance at each reset. Purchased balance never
            expires and never counts toward maxPlanBalance.
        planBalanceLimit:
          anyOf:
            - type: object
              properties:
                amount:
                  type: integer
                  exclusiveMinimum: 0
                  maximum: 2147483647
                  description: >-
                    The most plan balance a subscription spends in one window,
                    in USD cents. Other currencies convert it with the plan's
                    exchange rate unless the dashboard sets a custom amount for
                    that currency.
                interval:
                  type: string
                  enum:
                    - day
                    - week
                  description: >-
                    The window length: `day` is 24 hours and `week` is 7 days,
                    starting at the time of day of the subscription's billing
                    anchor.
              required:
                - amount
                - interval
              additionalProperties: false
              description: >-
                Caps how much plan balance a subscription spends per window.
                Purchased balance is never limited: usage past the limit draws
                from it. Changing it publishes a new version of the plan; each
                subscription stays on its version until moved.
            - type: 'null'
          description: >-
            Balance plans only. The most plan balance a subscription spends per
            day or per week, in USD cents; null means no limit.
        sortOrder:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        planGroupId:
          type:
            - string
            - 'null'
        metadata:
          anyOf:
            - type: object
              propertyNames:
                type: string
              additionalProperties: {}
            - type: 'null'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        object:
          type: string
          const: plan
        livemode:
          type: boolean
      required:
        - id
        - name
        - code
        - description
        - consumptionModel
        - isPublic
        - isDefault
        - isFree
        - blockOnExhaustion
        - unusedPlanCredits
        - planCreditLimit
        - unusedPlanBalance
        - planBalanceLimit
        - sortOrder
        - planGroupId
        - metadata
        - createdAt
        - updatedAt
        - 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.