Sube o baja de nivel una suscripción

Usa POST /subscription/{id}/change-plan para mover a un suscriptor a un plan diferente — ya sea subiendo a un nivel de mayor precio o bajando a uno menor. Tú controlas si el cambio surte efecto de inmediato (con el prorrateo cobrado o absorbido hoy) o se programa para el próximo ciclo de facturación.

El amount, el interval y el intervalCount de un plan son inmutables una vez que tiene suscriptores activos. Para cambiar el precio o la cadencia, crea un plan nuevo y usa este endpoint para migrar suscriptores a él.

planId (plan de destino) es obligatorio; applyAt (now | next_billing, por defecto next_billing) controla el momento — ver el panel de parámetros de arriba.

Respuesta

Devuelve 200 OK con el objeto de suscripción actualizado. Cuando applyAt es "next_billing", la respuesta incluye un objeto scheduledPlanChange con el planId y el timestamp effectiveAt.

Errores

Código	Significado
`400`	Plan de destino no encontrado, inactivo o no disponible en el país del suscriptor.
`402`	El cobro de prorrateo inmediato fue rechazado (solo cuando `applyAt: "now"`).
`404`	Suscripción no encontrada.
`422`	Error de validación.

curl -X POST https://api.therius.io/v1/subscription/sub_abc123def456/change-plan \
  -H "Authorization: Bearer prv_production_your_key_here" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantCode": "MERCHANT_001",
    "planId": 99,
    "applyAt": "now"
  }'

{}

Si quieres ofrecer un período introductorio con descuento en el nuevo plan, crea el nuevo plan con introAmount e introBillingCycles establecidos antes de ejecutar change-plan. El suscriptor recibirá el precio introductorio desde su primer ciclo en el nuevo plan.

Autorizaciones

Authorization

string

header

requerido

Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).

Parámetros de ruta

string

requerido

Cuerpo

application/json

merchantCode

string

requerido

Your merchant account identifier.

planId

integer

requerido

ID of the plan to switch to.

applyAt

enum<string>

When the change takes effect. next_billing (default) stores it as pending and applies it at the next cycle with no immediate charge. now applies immediately - an upgrade charges the prorated difference by MIT straight away; a downgrade switches immediately with no refund and the lower amount takes effect next cycle.

Opciones disponibles:

now,

next_billing

Respuesta

200 - application/json

Plan changed

A customer enrollment in a plan. plan is embedded on single-subscription responses. Invoice/event history is not included here - use the invoice endpoints.

string

Subscription UUID.

merchantId

integer

The merchant account that owns the subscription.

planId

integer

ID of the plan this subscription is enrolled in.

customerEmail

string

Subscriber email, used for billing and dunning notifications.

customerName

string

Subscriber name as it appears on invoices.

customerDocument

string

Subscriber national ID / tax document, where a market requires it (e.g. Brazil CPF/CNPJ).

cardBrand

string

Brand of the card on the mandate, e.g. visa.

status

enum<string>

pending - awaiting first charge; trialing - in a free trial; active - billing normally; past_due - a renewal failed and dunning is running; suspended - dunning exhausted, needs a new CIT (POST /subscription/{id}/payment-method in CIT mode) to recover; paused - billing stopped on request, resumable; cancelled - terminated; completed - reached maxBillingCycles.

Opciones disponibles:

pending,

trialing,

active,

past_due,

suspended,

paused,

cancelled,

completed

currentPeriodStart

string<date-time>

Start of the current billing period.

currentPeriodEnd

string<date-time>

End of the current billing period.

nextBillingDate

string<date-time>

When the next renewal charge is scheduled.

trialStart

string<date-time>

Trial start, when the plan has a trial.

trialEnd

string<date-time>

Trial end - the first real charge date.

dunningAttemptCount

integer

Failed-renewal retry attempts made in the current dunning sequence.

activatedAt

string<date-time>

When the subscription first became active.

cancelledAt

string<date-time>

pausedAt

string<date-time>

suspendedAt

string<date-time>

startAt

string<date-time>

Deferred start, when creation set a future startAt.

cyclesCompleted

integer

Number of billing cycles charged so far.

completedAt

string<date-time>

When the subscription reached maxBillingCycles.

parentSubscriptionId

string

Parent subscription UUID, for add-on hierarchies.

propagateLifecycle

boolean

Whether pause/cancel on the parent cascades to this subscription.

pendingPlanId

integer

Plan the subscription will switch to at the next cycle, set by a next_billing change-plan.

createdAt

string<date-time>

updatedAt

string<date-time>

plan

object

A reusable billing plan. amount is a flat integer in the currency minor units (with separate currency + exponent) - not an Amount object.

Show child attributes

Pagos

Tokenización

Suscripciones

Planes

Sesión del SDK

Sube o baja de nivel una suscripción

Respuesta

Errores

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta

​Respuesta

​Errores

Autorizaciones

Parámetros de ruta

Cuerpo

Respuesta

Respuesta

Errores