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

​
Modifications de plan programmées

Utilisez le paramètre effective_at pour contrôler quand le changement de plan prend effet :
ValeurComportement
immediatelyAppliquer le changement de plan immédiatement. C’est l’option par défaut.
next_billing_dateProgrammer le changement pour la prochaine date de facturation. Le client conserve l’accès à son plan actuel jusqu’à la fin de la période de facturation.
Les modifications de plan programmées sont idéales pour les déclassements — les clients conservent les avantages de leur plan actuel jusqu’à la fin de la période de facturation, puis passent automatiquement au nouveau plan.
Pour annuler une modification de plan programmée avant qu’elle ne prenne effet, utilisez le point de terminaison Annuler la modification de plan programmée.

​
Gestion des échecs de paiement

Utilisez le paramètre on_payment_failure pour contrôler ce qui se passe en cas d’échec du paiement du changement de plan :
ValeurComportement
prevent_changeConserver l’abonnement sur le plan actuel jusqu’à la réussite du paiement. Le changement de plan reste en attente.
apply_changeAppliquer le changement de plan immédiatement, quel que soit le résultat du paiement. C’est l’option par défaut.
Si on_payment_failure n’est pas spécifié, le comportement par défaut dépend du paramètre de niveau entreprise configuré dans le tableau de bord.

​
Codes de réduction

Vous pouvez appliquer un ou plusieurs codes de réduction cumulés lors de la modification des plans en passant le tableau discount_codes (maximum 20 entrées, appliqué dans l’ordre du tableau). Le champ singulier discount_code est obsolète mais fonctionne toujours pour les intégrations existantes ; il ne peut pas être combiné avec discount_codes dans la même requête.
Valeur de discount_codesComportement
Non fourni (null / omis)Les réductions existantes avec preserve_on_plan_change=true sont conservées si elles s’appliquent au nouveau produit.
[] (tableau vide)Toutes les réductions existantes sont supprimées de l’abonnement.
["CODE_A", "CODE_B", ...]Remplace toutes les réductions existantes par cet ensemble cumulé, validé et appliqué dans l’ordre du tableau.
Utilisez des codes de réduction lors des changements de plan pour offrir des tarifs promotionnels lors de mises à niveau, ou passez les codes lors de la migration des clients vers un nouveau niveau de plan.
Utilisez prevent_change pour les mises à niveau 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,
do_not_bill
​
quantity
integer<int32>
requis

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

Plage requise: x >= 0
​
adaptive_currency_fees_inclusive
boolean | null

Whether adaptive currency fees should be included in the price (true) or added on top (false). If not specified, uses the subscription's stored setting.

​
addons
Attach Addon Request · object[] | null

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

​
discount_code
string | null
obsolète

DEPRECATED: Use discount_codes instead. Cannot be used together with discount_codes.

​
discount_codes
string[] | null

Stacked discount codes to apply to the new plan. Max 20. Cannot be used together with discount_code. If provided, replaces any existing discount codes. Empty array removes all discounts. If not provided (None), existing discounts with preserve_on_plan_change=true are preserved.

​
effective_at
enum<string>

When to apply the plan change.

  • immediately (default): Apply the plan change right away
  • next_billing_date: Schedule the change for the next billing date
Options disponibles:
immediately,
next_billing_date
​
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.

Last modified on May 22, 2026