Skip to main content
POST
cURL
Create a new plan with optional consumption model, visibility, and plan group assignment.

Autorizaciones

x-api-key
string
header
requerido

Encabezados

Idempotency-Key
string

Unique key used to safely retry this write for 24 hours without applying it twice.

Required string length: 1 - 200
Commet-Version
string
predeterminado:2026-08-27

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

Cuerpo

application/json
name
string
requerido
Minimum string length: 1
code
string
requerido
Minimum string length: 1
Pattern: ^[a-z0-9_]+$
description
string
consumptionModel
enum<string>
Opciones disponibles:
metered,
credits,
balance
isPublic
boolean
isFree
boolean
blockOnExhaustion
boolean
planGroupId
string
metadata
object

Respuesta

Success

id
string
requerido
name
string
requerido
code
string
requerido
description
string | null
requerido
consumptionModel
enum<string> | null
requerido
Opciones disponibles:
metered,
credits,
balance
isPublic
boolean
requerido
isDefault
boolean
requerido
isFree
boolean
requerido
blockOnExhaustion
boolean | null
requerido
sortOrder
integer
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
planGroupId
string | null
requerido
metadata
object | null
requerido
createdAt
string<date-time>
requerido
updatedAt
string<date-time>
requerido
features
object[]
requerido
prices
object[]
requerido
exchangeRates
object[]
requerido
object
string
requerido
Allowed value: "plan"
livemode
boolean
requerido