> ## 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 auto top-up

> Turn automatic top-ups on or off and set the threshold, the size of each top-up and the maximum top-ups per period. Send only the fields that change. On a credits plan each top-up buys `quantity` credits; on a balance plan it adds `amount` in minor units of the subscription currency, plus tax, and `threshold` is in the same minor units. Enabling requires a plan that sells credits or has balance top-ups on. The size must be at least the plan's minimum when auto top-up is enabled or when the size changes, so turning it off keeps working after the minimum rises. Saving it enabled resumes a paused auto top-up.

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


## OpenAPI

````yaml /openapi/en/rest/2026-08-27.json patch /subscriptions/{id}/auto-top-up
openapi: 3.1.0
info:
  title: Commet API
  version: '2026-08-27'
  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: Markets
    description: >-
      Reusable country groups for market-specific prices and selectable price
      variants.
  - name: Offers
  - 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}/auto-top-up:
    patch:
      tags:
        - Subscriptions
      summary: Update auto top-up
      description: >-
        Turn automatic top-ups on or off and set the threshold, the size of each
        top-up and the maximum top-ups per period. Send only the fields that
        change. On a credits plan each top-up buys `quantity` credits; on a
        balance plan it adds `amount` in minor units of the subscription
        currency, plus tax, and `threshold` is in the same minor units. Enabling
        requires a plan that sells credits or has balance top-ups on. The size
        must be at least the plan's minimum when auto top-up is enabled or when
        the size changes, so turning it off keeps working after the minimum
        rises. Saving it enabled resumes a paused auto top-up.
      operationId: update-subscription-auto-top-up
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            Unique key used to safely retry this write for 24 hours without
            applying it twice.
          schema:
            type: string
            minLength: 1
            maxLength: 200
        - 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-08-27'
          example: '2026-08-27'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
                threshold:
                  type: integer
                  minimum: 0
                  maximum: 2147483647
                quantity:
                  description: Credits each top-up buys. Credits plans only.
                  type: integer
                  minimum: 1
                  maximum: 2147483647
                amount:
                  description: >-
                    Minor units of the subscription currency each top-up adds.
                    Balance plans only.
                  type: integer
                  minimum: 1
                  maximum: 2147483647
                maxPerPeriod:
                  type: integer
                  minimum: 1
                  maximum: 100
              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:
                $ref: '#/components/schemas/SubscriptionAutoTopUp'
              example:
                enabled: true
                threshold: 5
                quantity: 50
                maxPerPeriod: 10
                status: active
                topUpsThisPeriod: 1
                periodResetsAt: '2026-10-07T12:00:00.000Z'
                lastFailure: null
                object: subscription_auto_top_up
                livemode: false
        '400':
          description: Bad request
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  type: validation_error
                  code: validation_error
                  message: The request contains an invalid parameter.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/validation_error.md
        '401':
          description: Unauthorized
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  type: authentication_error
                  code: unauthorized
                  message: A valid API key is required.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/unauthorized.md
        '403':
          description: Forbidden
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  type: authentication_error
                  code: forbidden
                  message: You do not have permission to perform this operation.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/forbidden.md
        '404':
          description: Not found
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  type: not_found_error
                  code: not_found
                  message: The requested resource was not found.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/not_found.md
        '409':
          description: Conflict
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  type: conflict_error
                  code: idempotency_in_progress
                  message: >-
                    A request with this idempotency key is still being
                    processed.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_in_progress.md
        '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'
              example:
                error:
                  type: rate_limit_error
                  code: rate_limited
                  message: >-
                    Too many requests. Retry after the interval specified in the
                    Retry-After header.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/rate_limited.md
        '500':
          description: Internal server error
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  type: internal_error
                  code: internal_error
                  message: An unexpected error occurred while processing the request.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/internal_error.md
        '503':
          description: Service unavailable
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  type: internal_error
                  code: idempotency_unavailable
                  message: >-
                    Idempotency storage is temporarily unavailable. Retry with
                    the same idempotency key.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_unavailable.md
components:
  headers:
    RequestId:
      description: >-
        Server-generated identifier that correlates this response with Platform
        logs.
      schema:
        type: string
        format: uuid
  schemas:
    SubscriptionAutoTopUp:
      type: object
      properties:
        enabled:
          type: boolean
          description: >-
            Whether top-ups run automatically: credits bought on a credits plan,
            balance added on a balance plan. Always false when the plan does not
            sell credits or has balance top-ups turned off.
        threshold:
          anyOf:
            - type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            - type: 'null'
          description: >-
            The available amount at or below which a top-up runs, or null when
            never configured: credits (plan plus purchased) on a credits plan,
            minor units of the subscription currency (plan plus purchased
            balance) on a balance plan.
        quantity:
          anyOf:
            - type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            - type: 'null'
          description: >-
            Credits each top-up buys on a credits plan, or null when never
            configured or on a balance plan.
        amount:
          anyOf:
            - type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            - type: 'null'
          description: >-
            Minor units of the subscription currency each top-up adds on a
            balance plan, charged plus tax, or null when never configured or on
            a credits plan.
        maxPerPeriod:
          anyOf:
            - type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            - type: 'null'
          description: Maximum top-ups per renewal period, or null when never configured.
        status:
          type: string
          enum:
            - active
            - paused
            - 'off'
          description: >-
            active tops up when the available amount reaches the threshold;
            paused stops after three consecutive failed top-ups, or after one
            whose charge could not be refunded, until the payment method
            changes, a credit purchase or balance top-up succeeds or it is saved
            enabled again; off tops up nothing.
        topUpsThisPeriod:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Top-ups made in the current renewal period.
        periodResetsAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: >-
            When the top-up count of the period resets, or null before the
            subscription starts its first period.
        lastFailure:
          anyOf:
            - type: object
              properties:
                reason:
                  type: string
                  enum:
                    - payment_declined
                    - no_payment_method
                    - quantity_below_minimum
                    - amount_below_minimum
                    - purchase_failed
                at:
                  type: string
                  format: date-time
              required:
                - reason
                - at
              additionalProperties: false
            - type: 'null'
          description: The last top-up that failed, or null when none has failed.
        object:
          type: string
          const: subscription_auto_top_up
        livemode:
          type: boolean
      required:
        - enabled
        - threshold
        - quantity
        - amount
        - maxPerPeriod
        - status
        - topUpsThisPeriod
        - periodResetsAt
        - lastFailure
        - object
        - livemode
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        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:
        - 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.