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

> Update a customer's name, external ID, or metadata.

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


## OpenAPI

````yaml /openapi/en/rest/2026-05-01.json put /customers/{id}
openapi: 3.1.0
info:
  title: Commet API
  version: '2026-05-01'
  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:
  /customers/{id}:
    put:
      tags:
        - Customers
      summary: Update customer
      description: Update a customer's name, external ID, or metadata.
      operationId: update-customer
      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-01'
          example: '2026-05-01'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                fullName:
                  type: string
                  maxLength: 200
                taxDocument:
                  type: string
                  maxLength: 50
                businessTaxId:
                  description: >-
                    Business tax ID, such as an EU VAT number, a Peruvian RUC or
                    an Argentine CUIT, for the country of the customer's
                    address; its type comes from that country. Where Commet
                    collects tax and that ID exempts business buyers, a valid ID
                    replaces consumer tax with the business treatment; elsewhere
                    it is stored as sent and does not change any charge. Send
                    null to remove it.
                  anyOf:
                    - type: string
                      minLength: 1
                      maxLength: 30
                    - type: 'null'
                externalId:
                  type: string
                  maxLength: 200
                timezone:
                  default: UTC
                  type: string
                  enum:
                    - UTC
                    - America/New_York
                    - America/Chicago
                    - America/Denver
                    - America/Los_Angeles
                    - America/Sao_Paulo
                    - America/Mexico_City
                    - America/Buenos_Aires
                    - America/Santiago
                    - America/Bogota
                    - America/Lima
                    - America/Asuncion
                    - Europe/London
                    - Europe/Paris
                    - Europe/Berlin
                    - Europe/Madrid
                    - Asia/Tokyo
                    - Asia/Shanghai
                    - Asia/Singapore
                    - Asia/Dubai
                    - Australia/Sydney
                metadata:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties: {}
                address:
                  type: object
                  properties:
                    line1:
                      type: string
                      minLength: 1
                    line2:
                      type: string
                    city:
                      type: string
                      minLength: 1
                    state:
                      type: string
                    postalCode:
                      type: string
                      minLength: 1
                    country:
                      type: string
                      minLength: 2
                      maxLength: 2
                    region:
                      type: string
                  required:
                    - line1
                    - city
                    - postalCode
                    - country
                  additionalProperties: false
                billingEmail:
                  type: string
                  format: email
                  pattern: >-
                    ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
                isActive:
                  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/Customer'
                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:
    Customer:
      type: object
      properties:
        id:
          type: string
        externalId:
          type:
            - string
            - 'null'
        fullName:
          type:
            - string
            - 'null'
        taxDocument:
          type:
            - string
            - 'null'
        documentType:
          type:
            - string
            - 'null'
        businessTaxId:
          anyOf:
            - type: object
              properties:
                country:
                  type: string
                type:
                  type: string
                value:
                  type: string
              required:
                - country
                - type
                - value
              additionalProperties: false
            - type: 'null'
        timezone:
          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
        billingEmail:
          type: string
        isActive:
          type: boolean
      required:
        - id
        - externalId
        - fullName
        - billingEmail
        - taxDocument
        - documentType
        - businessTaxId
        - timezone
        - metadata
        - createdAt
        - updatedAt
        - isActive
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        success:
          const: false
        code:
          type: string
        message:
          type: string
        details: {}
      required:
        - success
        - code
        - message
  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.