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 pour un abonnement. Ce point de terminaison prend en charge à la fois les abonnements actifs et les abonnements en on_hold état.
Pour les abonnements en on_hold état, la mise à jour du mode de paiement crée automatiquement un prélèvement pour les montants dus restants, génère une facture et réactive l’abonnement à l’état active après un 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 pour un client, utilisez l’API Lister les modes de paiement. Cela vous aide à récupérer les identifiants de mode de paiement disponibles lors de l’utilisation de 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 du mode de paiement pour un abonnement en on_hold état :
  1. Un prélèvement est automatiquement créé pour les montants dus restants
  2. Une facture est générée pour le prélèvement
  3. Le paiement est traité en utilisant le nouveau mode de paiement
  4. Après un paiement réussi, l’abonnement est réactivé à l’état active
  5. Vous recevrez des événements webhook : payment.succeeded suivis de subscription.active
Si le paiement échoue après la mise à jour du mode de paiement pour un abonnement on_hold, l’abonnement restera dans l’état on_hold. Surveillez les événements webhook pour suivre l’état 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 - Le prélèvement pour les montants dus restants a été réussi
  2. subscription.active - L’abonnement a été réactivé

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
subscription_id
string
required

Subscription Id

Body

application/json
​
type
enum<string>
required
Options disponibles:
new
​
return_url
string | null

Response

Payment method updated

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