Zum Hauptinhalt springen
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>"
}
Aktualisieren Sie die Zahlungsmethode für ein Abonnement. Dieser Endpunkt unterstützt sowohl aktive Abonnements als auch Abonnements im on_hold Zustand.
Bei Abonnements im on_hold Zustand erstellt das Aktualisieren der Zahlungsmethode automatisch eine Abbuchung für offene Beträge, generiert eine Rechnung und reaktiviert das Abonnement nach erfolgreicher Zahlung in den active Zustand.

​
Anwendungsfälle

  • Aktive Abonnements: Zahlungsmethode aktualisieren, wenn eine Karte abläuft oder der Kunde eine andere Zahlungsmethode verwenden möchte
  • Auf Eis gelegte Abonnements: Reaktivieren von Abonnements, die aufgrund fehlgeschlagener Zahlungen auf Eis gelegt wurden, durch Aktualisierung der Zahlungsmethode
  • Zahlungsmethodenverwaltung: Wechsel zwischen gespeicherten Zahlungsmethoden oder Hinzufügen neuer Zahlungsmethoden
Um vorhandene Zahlungsmethoden für einen Kunden aufzulisten, verwenden Sie die List Payment Methods API. Dies hilft Ihnen, verfügbare Zahlungsmethoden-IDs abzurufen, wenn Sie type: "existing" verwenden, um die Zahlungsmethode eines Abonnements zu aktualisieren.

​
Verhalten bei aktiven Abonnements

Beim Aktualisieren der Zahlungsmethode für ein aktives Abonnement:
  • Die Zahlungsmethode wird sofort aktualisiert
  • Es wird keine Gebühr erstellt
  • Das Abonnement bleibt aktiv
  • Zukünftige Verlängerungen verwenden die neue Zahlungsmethode

​
Verhalten bei auf Eis gelegten Abonnements

Beim Aktualisieren der Zahlungsmethode für ein Abonnement im on_hold Zustand:
  1. Es wird automatisch eine Abbuchung für offene Beträge erstellt
  2. Für die Abbuchung wird eine Rechnung erstellt
  3. Die Zahlung wird mit der neuen Zahlungsmethode verarbeitet
  4. Nach erfolgreicher Zahlung wird das Abonnement in den active Zustand reaktiviert
  5. Sie erhalten Webhook-Ereignisse: payment.succeeded gefolgt von subscription.active
Wenn die Zahlung nach der Aktualisierung der Zahlungsmethode für ein on_hold Abonnement fehlschlägt, bleibt das Abonnement im on_hold Zustand. Überwachen Sie Webhook-Ereignisse, um den Zahlungsstatus zu verfolgen.

​
Webhook-Ereignisse

Beim Aktualisieren einer Zahlungsmethode für ein on_hold Abonnement erhalten Sie die folgenden Webhook-Ereignisse:
  1. payment.succeeded – Die Abbuchung für offene Beträge war erfolgreich
  2. subscription.active – Das Abonnement wurde reaktiviert

Autorisierungen

​
Authorization
string
header
erforderlich

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

Pfadparameter

​
subscription_id
string
erforderlich

Subscription Id

Body

application/json
​
type
enum<string>
erforderlich
Verfügbare Optionen:
new
​
return_url
string | null

Antwort

Payment method updated

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