Saltar al contenido principal
PUT
Update plan
This reference describes API version 2026-05-12. Send Commet-Version: 2026-05-12 with your request.

Autorizaciones

x-api-key
string
header
requerido

Encabezados

Commet-Version
string
predeterminado:2026-05-12

API version used by this reference. Send this header to select this contract explicitly.

Parámetros de ruta

id
string
requerido

Cuerpo

application/json
name
string
Minimum string length: 1
description
string | null
metadata
object
isPublic
boolean
unusedPlanCredits
object

Credits plans only. What happens to unused plan credits at each reset. Existing subscriptions apply it from their next reset.

planCreditLimit
object | null

Credits plans only. The most plan credits a subscription spends per day or per week; null removes the limit. Raising or removing it applies to existing subscriptions at once; lowering it, adding it or changing its interval applies from their next period.

unusedPlanBalance
object

Balance plans only. What happens to unused plan balance at each reset. Existing subscriptions apply it from their next reset.

planBalanceLimit
object | null

Balance plans only. The most plan balance a subscription spends per day or per week, in USD cents; null removes the limit. Raising or removing it applies to existing subscriptions at once; lowering it, adding it or changing its interval applies from their next period.

blockOnExhaustion
boolean

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. Existing subscriptions apply it from their next reset.

isDefault
boolean

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.

Respuesta

Success

success
any
requerido
data
object
requerido