Passer au contenu principal
POST
/
subscriptions
/
{subscription_id}
/
update-payment-method
JavaScript
import DodoPayments from 'dodopayments';

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

const response = await client.subscriptions.updatePaymentMethod('subscription_id', { type: 'new' });

console.log(response.payment_id);
{
  "client_secret": "<string>",
  "expires_on": "2023-11-07T05:31:56Z",
  "payment_id": "<string>",
  "payment_link": "<string>"
}
Mettez à jour le mode de paiement d’un abonnement. Ce point de terminaison prend en charge les abonnements actifs ainsi que ceux en état on_hold.
Pour les abonnements en état on_hold, la mise à jour du mode de paiement crée automatiquement une charge pour les sommes restantes, génère une facture et réactive l’abonnement à l’état active après paiement réussi.

​
Cas d’utilisation

  • Abonnements actifs : Mettez à jour le mode de paiement lorsque la carte expire ou que le client souhaite utiliser un mode de paiement différent
  • Abonnements en attente : Réactivez les abonnements qui ont été mis en attente en raison de paiements échoués en mettant à jour le mode de paiement
  • Gestion des modes de paiement : Alternez entre les modes de paiement enregistrés ou ajoutez-en de nouveaux
Pour lister les modes de paiement existants d’un client, utilisez l’API Liste des modes de paiement. Cela vous permet de récupérer les identifiants des modes de paiement disponibles lorsque vous utilisez type: "existing" pour mettre à jour le mode de paiement d’un abonnement.

​
Comportement pour les abonnements actifs

Lors de la mise à jour du mode de paiement pour un abonnement actif :
  • Le mode de paiement est mis à jour immédiatement
  • Aucun prélèvement n’est créé
  • L’abonnement reste actif
  • Les renouvellements futurs utiliseront le nouveau mode de paiement

​
Comportement pour les abonnements en attente

Lors de la mise à jour d’un mode de paiement pour un abonnement en état on_hold :
  1. Une charge est automatiquement créée pour les sommes restantes
  2. Une facture est générée pour la charge
  3. Le paiement est traité avec le nouveau mode de paiement
  4. Après paiement réussi, l’abonnement est réactivé à l’état active
  5. Vous recevrez les événements webhook : payment.succeeded suivie de subscription.active
Si le paiement échoue après la mise à jour du mode de paiement d’un abonnement on_hold, l’abonnement restera en état on_hold. Surveillez les événements webhook pour suivre le statut du paiement.

​
Événements Webhook

Lors de la mise à jour d’un mode de paiement pour un abonnement on_hold, vous recevrez les événements webhook suivants :
  1. payment.succeeded - La charge pour les sommes restantes a été effectuée avec succès
  2. subscription.active - L’abonnement a été réactivé

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
​
type
enum<string>
requis
Options disponibles:
new
​
return_url
string | null

Réponse

Payment method updated

​
client_secret
string | null
​
expires_on
string<date-time> | null
​
payment_id
string | null
​
payment_link
string | null