Passer au contenu 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,
});

​
Gestion des échecs de paiement

Utilisez le paramètre on_payment_failure pour contrôler ce qui se passe lorsque le paiement du changement de forfait échoue :
ValeurComportement
prevent_changeMaintient l’abonnement sur le forfait actuel jusqu’à ce que le paiement réussisse. Le changement de forfait reste en attente.
apply_changeApplique immédiatement le changement de forfait, indépendamment du résultat du paiement. C’est le comportement par défaut.
Si on_payment_failure n’est pas spécifié, le comportement revient au paramètre de niveau entreprise configuré sur le tableau de bord.
Utilisez prevent_change pour les améliorations critiques où vous souhaitez garantir le paiement avant d’accorder l’accès aux fonctionnalités premium.

Autorisations

​
Authorization
string
header
requis

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

Paramètres de chemin

​
subscription_id
string
requis

Subscription Id

Corps

application/json
​
product_id
string
requis

Unique identifier of the product to subscribe to

​
proration_billing_mode
enum<string>
requis

Proration Billing Mode

Options disponibles:
prorated_immediately,
full_immediately,
difference_immediately
​
quantity
integer<int32>
requis

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

Plage requise: 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.

Options disponibles:
prevent_change,
apply_change

Réponse

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