> ## 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, or metadata. Update a plan's name, description, visibility, or metadata. ## OpenAPI ````yaml /openapi/es/rest/2026-08-27.json patch /plans/{id} 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: /plans/{id}: patch: tags: - Plans summary: Update plan description: Update a plan's name, description, visibility, or metadata. operationId: update-plan 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: name: type: string minLength: 1 description: anyOf: - type: string - type: 'null' metadata: type: object propertyNames: type: string additionalProperties: {} isPublic: type: boolean 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/Plan' example: id: plan_1a2b3c4d name: Pro code: pro description: For growing API products consumptionModel: metered isPublic: true isDefault: false isFree: false blockOnExhaustion: true sortOrder: 0 planGroupId: group_1a2b3c4d metadata: {} createdAt: '2026-09-07T12:00:00.000Z' updatedAt: '2026-09-07T12:00:00.000Z' features: - code: api_calls name: API Calls type: usage unitName: calls enabled: true includedAmount: 1000 unlimited: false overage: enabled: false model: null unitPrice: null regionalPrices: [] prices: - id: price_1a2b3c4d billingInterval: monthly price: 2000 isDefault: true trialDays: 0 includedBalance: null includedCredits: null offerId: null inheritsFromPriceId: null metadata: {} marketPrices: [] regionalPrices: [] exchangeRates: [] object: plan 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 x-codeSamples: - lang: typescript label: TypeScript source: |- import { Commet } from "@commet/node"; const commet = new Commet({ apiKey: "ck_xxx" }); const plan = await commet.plans.update({ id: "pln_xxx" }); - lang: python label: Python source: |- from commet import Commet commet = Commet("ck_xxx") plan = commet.plans.update("pln_xxx") - lang: go label: Go source: "client, err := commet.New(\"ck_xxx\")\nif err != nil {\n\tlog.Fatal(err)\n}\nctx := context.Background()\n\nplan, err := client.Plans.Update(ctx, \"pln_xxx\", nil)\nif err != nil {\n\tlog.Fatal(err)\n}" - lang: java label: Java source: >- import co.commet.Commet; import co.commet.params.UpdatePlanParams; var commet = Commet.builder().apiKey("ck_xxx").build(); var plan = commet.plans().update("pln_xxx", UpdatePlanParams.builder().build()); - lang: php label: PHP source: |- use Commet\Commet; $commet = new Commet('ck_xxx'); $plan = $commet->plans->update(id: 'pln_xxx'); components: headers: RequestId: description: >- Server-generated identifier that correlates this response with Platform logs. schema: type: string format: uuid schemas: Plan: type: object properties: id: type: string name: type: string code: type: string description: anyOf: - type: string - type: 'null' consumptionModel: anyOf: - $ref: '#/components/schemas/ConsumptionModel' - type: 'null' isPublic: type: boolean isDefault: type: boolean isFree: type: boolean blockOnExhaustion: anyOf: - type: boolean - type: 'null' sortOrder: type: integer minimum: -9007199254740991 maximum: 9007199254740991 planGroupId: anyOf: - type: string - type: 'null' metadata: anyOf: - type: object propertyNames: type: string additionalProperties: {} - type: 'null' createdAt: type: string format: date-time updatedAt: type: string format: date-time features: type: array items: type: object properties: code: type: string name: type: string type: $ref: '#/components/schemas/FeatureType' unitName: anyOf: - type: string - type: 'null' enabled: type: boolean includedAmount: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' unlimited: type: boolean overage: anyOf: - type: object properties: enabled: type: boolean model: anyOf: - type: string enum: - per_unit - type: 'null' unitPrice: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' required: - enabled - model - unitPrice additionalProperties: false - type: 'null' regionalPrices: type: array items: type: object properties: currency: type: string overageUnitPrice: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' autoSynced: type: boolean required: - currency - overageUnitPrice - autoSynced additionalProperties: false required: - code - name - type - unitName - enabled - includedAmount - unlimited - overage - regionalPrices additionalProperties: false prices: type: array items: type: object properties: id: type: string description: Public plan price ID. billingInterval: $ref: '#/components/schemas/BillingInterval' price: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Price in the currency's minor unit (for example, cents for USD). isDefault: type: boolean trialDays: type: integer minimum: -9007199254740991 maximum: 9007199254740991 includedBalance: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' includedCredits: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' offerId: anyOf: - type: string - type: 'null' description: >- Automatic introductory offer for this price. Pass a Promotional Offer ID when creating a subscription to override it. inheritsFromPriceId: anyOf: - type: string - type: 'null' description: >- Public base price ID for a market price variant, or null for a base price. metadata: type: object propertyNames: type: string additionalProperties: {} description: >- Application metadata. Variant display names may use metadata.name. marketPrices: type: array items: type: object properties: marketGroupId: type: string description: Public pricing market group ID. currency: type: string description: Presentment currency for this market. price: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Market price in the currency's minor unit. required: - marketGroupId - currency - price additionalProperties: false description: >- Country-market overrides. An empty array means currency pricing and then the global USD price remain the fallback. regionalPrices: type: array items: type: object properties: currency: type: string price: type: integer minimum: -9007199254740991 maximum: 9007199254740991 includedBalance: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' autoSynced: type: boolean required: - currency - price - includedBalance - autoSynced additionalProperties: false required: - id - billingInterval - price - isDefault - trialDays - includedBalance - includedCredits - offerId - inheritsFromPriceId - metadata - marketPrices - regionalPrices additionalProperties: false exchangeRates: type: array items: type: object properties: currency: type: string exchangeRate: type: number required: - currency - exchangeRate additionalProperties: false object: type: string const: plan livemode: type: boolean required: - id - name - code - description - consumptionModel - isPublic - isDefault - isFree - blockOnExhaustion - sortOrder - planGroupId - metadata - createdAt - updatedAt - features - prices - exchangeRates - 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 ConsumptionModel: type: string enum: - metered - credits - balance FeatureType: type: string enum: - boolean - usage - seats - quota BillingInterval: type: string enum: - weekly - monthly - quarterly - yearly - one_time securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key ```` ## Related topics - [Update plan feature](/docs/es/api-reference/plans/update-plan-feature.md) - [Update plan group](/docs/es/api-reference/plan-groups/update-plan-group.md) - [Update plan price](/docs/es/api-reference/plans/update-plan-price.md) - [Update offer](/docs/es/api-reference/offers/update-offer.md) - [Update promo code](/docs/es/api-reference/promo-codes/update-promo-code.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.