Skip to main content
POST
cURL
Upgrade or change billing interval immediately, optionally applying an Offer. Scheduled changes do not accept offers.

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
newPlanId
string
Minimum string length: 1
newBillingInterval
enum<string>
Opciones disponibles:
weekly,
monthly,
quarterly,
yearly
successUrl
string<uri>
offerId
string
Minimum string length: 1

Respuesta

Success

outcome
string
requerido
Allowed value: "requires_checkout"
requiresCheckout
boolean
requerido
checkoutUrl
string
requerido
object
string
requerido
Allowed value: "plan_change"
livemode
boolean
requerido
offerApplication
object