Vai al contenuto principale
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>"
}
Aggiorna il metodo di pagamento per un abbonamento. Questo endpoint supporta sia gli abbonamenti attivi sia quelli in stato on_hold.
Per gli abbonamenti in stato on_hold, l’aggiornamento del metodo di pagamento crea automaticamente un addebito per i due residui, genera una fattura e riattiva l’abbonamento allo stato active dopo il pagamento riuscito.

​
Casi d’Uso

  • Abbonamenti attivi: Aggiorna il metodo di pagamento quando una carta scade o il cliente desidera utilizzare un metodo di pagamento diverso
  • Abbonamenti in sospeso: Riattiva abbonamenti che sono stati messi in sospeso a causa di pagamenti non riusciti aggiornando il metodo di pagamento
  • Gestione dei metodi di pagamento: Passa tra i metodi di pagamento salvati o aggiungi nuovi metodi
Per elencare i metodi di pagamento esistenti per un cliente, utilizza le List Payment Methods API. Questo ti aiuta a recuperare gli ID dei metodi di pagamento disponibili quando usi type: "existing" per aggiornare il metodo di pagamento di un abbonamento.

​
Comportamento per Abbonamenti Attivi

Quando aggiorni il metodo di pagamento per un abbonamento attivo:
  • Il metodo di pagamento viene aggiornato immediatamente
  • Non viene creato alcun addebito
  • L’abbonamento rimane attivo
  • I rinnovi futuri utilizzeranno il nuovo metodo di pagamento

​
Comportamento per Abbonamenti in Sospeso

Quando aggiorni il metodo di pagamento per un abbonamento in stato on_hold:
  1. Viene creato automaticamente un addebito per i due residui
  2. Viene generata una fattura per l’addebito
  3. Il pagamento viene elaborato con il nuovo metodo di pagamento
  4. Dopo il pagamento riuscito, l’abbonamento viene riattivato allo stato active
  5. Riceverai eventi webhook: payment.succeeded seguito da subscription.active
Se il pagamento fallisce dopo l’aggiornamento del metodo di pagamento per un abbonamento on_hold, l’abbonamento rimarrà nello stato on_hold. Monitora gli eventi webhook per tracciare lo stato del pagamento.

​
Eventi Webhook

Quando aggiorni un metodo di pagamento per un abbonamento on_hold, riceverai i seguenti eventi webhook:
  1. payment.succeeded - L’addebito per i due residui è stato completato con successo
  2. subscription.active - L’abbonamento è stato riattivato

Autorizzazioni

​
Authorization
string
header
obbligatorio

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

Parametri del percorso

​
subscription_id
string
obbligatorio

Subscription Id

Corpo

application/json
​
type
enum<string>
obbligatorio
Opzioni disponibili:
new
​
return_url
string | null

Risposta

Payment method updated

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