Saltar al contenido principal
POST
/
subscriptions
/
{subscription_id}
/
change-plan
JavaScript
import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

await client.subscriptions.changePlan('subscription_id', {
  product_id: 'product_id',
  proration_billing_mode: 'prorated_immediately',
  quantity: 0,
});

​
Manejo de fallas de pago

Utiliza el parámetro on_payment_failure para controlar lo que ocurre cuando el pago del cambio de plan falla:
ValorComportamiento
prevent_changeMantener la suscripción en el plan actual hasta que el pago tenga éxito. El cambio de plan permanece pendiente.
apply_changeAplicar el cambio de plan de inmediato independientemente del resultado del pago. Esta es la opción predeterminada.
Si on_payment_failure no se especifica, el comportamiento predeterminado es la configuración a nivel de negocio que hayas configurado en el panel.
Utiliza prevent_change para actualizaciones críticas donde quieras asegurarte de que el pago se confirme antes de otorgar acceso a funciones premium.

Autorizaciones

​
Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de ruta

​
subscription_id
string
requerido

Subscription Id

Cuerpo

application/json
​
product_id
string
requerido

Unique identifier of the product to subscribe to

​
proration_billing_mode
enum<string>
requerido

Proration Billing Mode

Opciones disponibles:
prorated_immediately,
full_immediately,
difference_immediately
​
quantity
integer<int32>
requerido

Number of units to subscribe for. Must be at least 1.

Rango requerido: x >= 0
​
addons
Attach Addon Request · object[] | null

Addons for the new plan. Note : Leaving this empty would remove any existing addons

​
discount_code
string | null

Optional discount code to apply to the new plan. If provided, validates and applies the discount to the plan change. If not provided and the subscription has an existing discount with preserve_on_plan_change=true, the existing discount will be preserved (if applicable to the new product).

​
metadata
object

Metadata for the payment. If not passed, the metadata of the subscription will be taken

​
on_payment_failure
null | enum<string>

Controls behavior when the plan change payment fails.

  • prevent_change: Keep subscription on current plan until payment succeeds
  • apply_change (default): Apply plan change immediately regardless of payment outcome

If not specified, uses the business-level default setting.

Opciones disponibles:
prevent_change,
apply_change

Respuesta

Subscription plan changed. If on_payment_failure=prevent_change, the plan change is pending until payment succeeds.