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

# Change plan

> Upgrade, downgrade, or change billing interval. An immediate change can apply the Offer of a promoCode; scheduled changes do not accept it.

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


## OpenAPI

````yaml /openapi/en/rest/2026-07-11.json post /subscriptions/{id}/change-plan
openapi: 3.1.0
info:
  title: Commet API
  version: '2026-07-11'
  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:
  /subscriptions/{id}/change-plan:
    post:
      tags:
        - Subscriptions
      summary: Change plan
      description: >-
        Upgrade, downgrade, or change billing interval. An immediate change can
        apply the Offer of a promoCode; scheduled changes do not accept it.
      operationId: change-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-07-11'
          example: '2026-07-11'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                newPlanId:
                  type: string
                  minLength: 1
                newBillingInterval:
                  type: string
                  enum:
                    - weekly
                    - monthly
                    - quarterly
                    - semiannual
                    - yearly
                successUrl:
                  type: string
                  format: uri
                promoCode:
                  type: string
                  minLength: 1
                  description: >-
                    Promo code whose Offer prices the change, validated with the
                    checkout's rules: a code the checkout would refuse returns
                    400 validation_error with the checkout's reason in
                    details.reason. Cannot be combined with offerId.
              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/PlanChange'
                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'
        '402':
          description: Payment required
          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:
    PlanChange:
      type: object
      properties:
        requiresCheckout:
          type: boolean
        checkoutUrl:
          type: string
        id:
          type: string
        scheduled:
          type: boolean
        scheduledFor:
          type: string
          format: date-time
        changeType:
          type: string
          enum:
            - subscription.plan_downgrade
            - subscription.interval_change
            - subscription.cancel
        customerId:
          type: string
        newPlanId:
          type: string
        newPlanName:
          type: string
        newBillingInterval:
          type: string
        previousPlan:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
          required:
            - id
            - name
          additionalProperties: false
        currentPlan:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            price:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
          required:
            - id
            - name
            - price
          additionalProperties: false
        billingInterval:
          type: string
        billing:
          type: object
          properties:
            credit:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            creditsApplied:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            charge:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            taxAmount:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            netAmount:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            totalCharged:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            remainingCreditBalance:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
          required:
            - credit
            - creditsApplied
            - charge
            - taxAmount
            - netAmount
            - totalCharged
            - remainingCreditBalance
          additionalProperties: false
        invoiceId:
          type: string
        seatLimitWarning:
          type: object
          properties:
            featureCode:
              type: string
            featureName:
              type: string
            currentSeats:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            included:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            newPlanName:
              type: string
            effectiveDate:
              type: string
              format: date-time
          required:
            - featureCode
            - featureName
            - currentSeats
            - included
            - newPlanName
            - effectiveDate
          additionalProperties: false
        object:
          type: string
          const: subscription
        livemode:
          type: boolean
      required:
        - 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.