Plan ändern
Ändern Sie den Plan eines bestehenden Abonnements und ermöglichen Sie sowohl Upgrades als auch Downgrades auf andere Preisstufen.
Hinweis: Standardmäßig werden dafür die vorhandenen Zahlungsinformationen des Kunden verwendet. Setzen Sie collect_via_payment_link, um stattdessen über eine gehostete Checkout-Seite abzurechnen.
Geplante Tarifänderungen
Verwenden Sie deneffective_at-Parameter, um zu steuern, wann die Tarifänderung wirksam wird:
Zahlungsfehlerbehandlung
Verwenden Sie denon_payment_failure-Parameter, um zu steuern, was passiert, wenn die Zahlung für die Tarifänderung fehlschlägt:
on_payment_failure nicht angegeben ist, erfolgt die Standardverhalten gemäß Ihrer Geschäftseinstellung im Dashboard.Über Payment Link abrechnen
Setzen Siecollect_via_payment_link auf true, um den Kunden stattdessen zu einer gehosteten Checkout-Seite weiterzuleiten, anstatt die gespeicherte Zahlungsmethode zu belasten. Die Antwort enthält dann payment_id, payment_link, client_secret und expires_on — leiten Sie den Kunden zu payment_link weiter, um die Zahlung abzuschließen.
Dies erfordert:
422 zurück. Solange der Link unbezahlt ist, bleibt das Abonnement auf seinem aktuellen Plan, und ein weiterer change-plan-Request gibt 409 zurück, sofern Sie nicht cancel_older_payment_link setzen.
Weiterleitung nach der Zahlung
Setzen Siereturn_url, um den Kunden nach der Zahlung des Links zu Ihrer Website zurückzuleiten. Die Weiterleitung fügt subscription_id, payment_id und status als Query-Parameter hinzu.
statusist der Status der Zahlung für die Planänderung, nicht der Status des Abonnements.- Wenn die Zahlung fehlschlägt, bleibt das Abonnement auf seinem aktuellen Plan aktiv. Um es erneut zu versuchen, rufen Sie
change-planerneut auf, um einen neuen Link zu erhalten. - Der neue Plan kann kurz nach der Weiterleitung angewendet werden, sobald der Payment-Webhook eintrifft.
return_url benötigt collect_via_payment_link: true. Ohne dieses Feld gibt der Request 422 zurück.
Einen ausstehenden Zahlungslink ersetzen
Wenn der Kunde den Checkout verlässt, ohne zu bezahlen, setzen Siecancel_older_payment_link beim nächsten change-plan-Request auf true. Dodo Payments storniert den unbezahlten Link, und die neue Planänderung ersetzt die ausstehende. Der stornierte Link akzeptiert keine Zahlungen mehr.
Der Request wird validiert, bevor der Link storniert wird. Dadurch bleibt der Link des Kunden bei einem ungültigen Request erhalten. Der Link wird nur storniert, wenn der Kunde noch nicht mit der Zahlung begonnen hat:
change-plan-Request erstellt eine eigene Rechnung. Die ersetzte Planänderung und ihre Rechnung werden storniert.
Rabattcodes
Sie können beim Ändern von Plänen einen oder mehrere gestapelte Rabattcodes anwenden, indem Sie das Arraydiscount_codes übergeben (maximal 20 Einträge, die in Array-Reihenfolge angewendet werden). Das einzelne Feld discount_code ist veraltet, funktioniert aber weiterhin für bestehende Integrationen. Es kann im selben Request nicht mit discount_codes kombiniert werden.
Autorisierungen
Send your API key as a bearer token: Authorization: Bearer <api_key>. A test mode key starts with dodo_test_, for example dodo_test_AbCd1234EfGh5678.<secret>. A live mode key starts with dodo_live_. Use a test mode key on test.dodopayments.com and a live mode key on live.dodopayments.com. Keys from before these tags have no tag and operate as before.
Body
Cancel the payment link of a pending plan change, so that this change can replace it.
The link is cancelled only if the customer has not started to pay. A
paid or in-progress payment gives a 409. A failed cancel gives a
503, and a retry is safe.
The request is validated before the cancel. A later failure, for example an amount below the minimum, leaves the subscription on its current plan with no open link. A retry is safe.
The preview route shares this request body and ignores this field.
Replace a scheduled plan change with this one.
The scheduled change is cancelled by the transaction that applies this change. A change that never applies leaves the schedule in place.
effective_at: next_billing_date is allowed. The new schedule then
replaces the old one in the request transaction.
A pending plan change still gets a 409. This field does not affect it.
The preview route shares this request body, so a preview that sets this
field also passes the scheduled-change 409.
Collect the plan-change amount with a payment link. The customer then pays on a checkout page.
The business needs the allow_plan_change_via_payment_link capability.
The request needs effective_at: immediately. The request also needs
on_payment_failure: prevent_change.
The preview route shares this request body and ignores this field.
Stacked discount codes to apply to the new plan. Max 20. Cannot be used together with discount_code. If provided, replaces any existing discount codes. Empty array removes all discounts. If not provided (None), existing discounts with preserve_on_plan_change=true are preserved.
Controls behavior when the plan change payment fails.
prevent_change: Keep subscription on current plan until payment succeedsapply_change(default): Apply plan change immediately regardless of payment outcome
With effective_at: next_billing_date, the plan change payment replaces the renewal payment.
If that payment fails with prevent_change, the plan change is cancelled.
The subscription then renews on the current plan, with the usual payment retries.
If not specified, uses the business-level default setting.
prevent_change, apply_change The URL that receives the customer after they pay the payment link.
Needs collect_via_payment_link: true. Without it, the request gets a
422. A change that collects no money issues no link and does not use
the URL. The preview route validates this field but does not use it.
The redirect adds subscription_id, payment_id and status. The
status value is the status of the plan-change payment. It is not the
status of the subscription. When that payment fails, the subscription
stays active on its current plan. To try again, call this endpoint
again to get a new link. The new plan can apply after the redirect,
when the payment webhook arrives.
Antwort
Subscription plan changed. A link request can return checkout details. A pending plan change applies after payment succeeds. For an invoice-led subscription, an invoice bills the change (invoice_id), or the change is credited.
Handles for a hosted checkout page that settles a plan change.
The four fields repeat UpdatePaymentMethodResponse and a subset of
CreateSubscriptionResponse. A shared type would rename the generated SDK
types for all three routes, so each route keeps its own.