Hoppa till huvudinnehåll
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>"
}
Uppdatera betalningsmetoden för en prenumeration. Denna slutpunkt stöder både aktiva prenumerationer och prenumerationer i on_hold tillstånd.
För prenumerationer i on_hold tillstånd, skapar uppdatering av betalningsmetoden automatiskt en avgift för kvarstående skulder, genererar en faktura och reaktiverar prenumerationen till active tillstånd vid lyckad betalning.

​
Användningsfall

  • Aktiva prenumerationer: Uppdatera betalningsmetod när ett kort går ut eller kunden vill använda en annan betalningsmetod
  • Pausade prenumerationer: Reaktivera prenumerationer som har pausats på grund av misslyckade betalningar genom att uppdatera betalningsmetoden
  • Hantering av betalningsmetoder: Växla mellan sparade betalningsmetoder eller lägg till nya
För att lista befintliga betalningsmetoder för en kund, använd List Payment Methods API. Detta hjälper dig att hämta tillgängliga betalningsmetod-ID:n när du använder type: "existing" för att uppdatera en prenumerations betalningsmetod.

​
Beteende för aktiva prenumerationer

När betalningsmetoden uppdateras för en aktiv prenumeration:
  • Betalningsmetoden uppdateras omedelbart
  • Ingen avgift skapas
  • Prenumerationen förblir aktiv
  • Framtida förnyelser kommer att använda den nya betalningsmetoden

​
Beteende för pausade prenumerationer

När betalningsmetoden uppdateras för en prenumeration i on_hold tillstånd:
  1. En avgift skapas automatiskt för kvarstående skulder
  2. En faktura genereras för avgiften
  3. Betalningen behandlas med den nya betalningsmetoden
  4. Vid lyckad betalning reaktiveras prenumerationen till active tillstånd
  5. Du kommer att få webhook-händelser: payment.succeeded följt av subscription.active
Om betalningen misslyckas efter att betalningsmetoden har uppdaterats för en on_hold prenumeration, kommer prenumerationen att förbli i on_hold tillstånd. Övervaka webhook-händelser för att spåra betalningsstatus.

​
Webhook-händelser

När betalningsmetoden uppdateras för en on_hold prenumeration, kommer du att få följande webhook-händelser:
  1. payment.succeeded - Avgiften för kvarstående skulder var framgångsrik
  2. subscription.active - Prenumerationen har reaktiverats

Auktoriseringar

​
Authorization
string
header
obligatorisk

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

Sökvägsparametrar

​
subscription_id
string
obligatorisk

Subscription Id

Kropp

application/json
​
type
enum<string>
obligatorisk
Tillgängliga alternativ:
new
​
return_url
string | null

Svar

Payment method updated

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