Skip to main content
POST
cURL
Temporarily expand an active subscription’s feature access using a higher plan in the same plan group. Billing, prices, periods, invoices, and the base subscription remain unchanged.

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.

Parámetros de ruta

id
string
requerido

Cuerpo

application/json
subscriptionId
string
requerido
Minimum string length: 1
planId
string
requerido
Minimum string length: 1
reason
string
requerido
Required string length: 1 - 500
duration
string
requerido
Allowed value: "cycles"
durationCycles
integer
requerido
Rango requerido: x <= 9007199254740991

Respuesta

Success

id
string
requerido
customerId
string
requerido
subscriptionId
string
requerido
basePlanId
string
requerido
planId
string
requerido
planReleaseId
string
requerido
status
enum<string>
requerido
Opciones disponibles:
active,
expired,
revoked
duration
enum<string>
requerido
Opciones disponibles:
cycles,
until_date,
until_revoked
durationCycles
integer | null
requerido
Rango requerido: 0 < x <= 9007199254740991
startsAt
string<date-time>
requerido
expiresAt
string<date-time> | null
requerido
reason
string
requerido
source
enum<string>
requerido
Opciones disponibles:
dashboard,
api
revokedAt
string<date-time> | null
requerido
createdAt
string<date-time>
requerido
updatedAt
string<date-time>
requerido
events
object[]
requerido
object
string
requerido
Allowed value: "plan_grant"
livemode
boolean
requerido