Zum Hauptinhalt springen
Wechsle Produkte und Preispläne in einem bestehenden Abonnement mit automatischer Proration und Gutschriften.
Gekündigte Abonnements können nicht mehr transitioniert werden.

POST /api/subscriptions/[subscriptionId]/transition

Führt einen Übergang zu neuen Produkten/Preisplänen durch.

Request

Request Body

effectiveAt
string
erforderlich
Zeitpunkt des Übergangs im ISO 8601 Format. Muss in der Zukunft oder jetzt sein. Ab diesem Zeitpunkt gelten die neuen Items.
desiredItems
array
erforderlich
Liste der gewünschten Items nach dem Übergang. Mindestens 1 Item erforderlich.
proration
string
Standard:"none"
Wie sollen Gutschriften für nicht genutzte Zeit berechnet werden?
Die Gutschrift wird sofort finalisiert und an den Kunden gesendet. Der Guthabenbetrag wird automatisch mit der nächsten Rechnung verrechnet.
invoiceTiming
string
Standard:"phaseStart"
Wann sollen die neuen Items abgerechnet werden?
cancelReason
string
Optionaler Grund für die Beendigung der alten Items (max. 255 Zeichen)
dryRun
boolean
Standard:"false"
Wenn true, wird eine Vorschau der Änderungen zurückgegeben ohne sie zu speichern

Response (200 OK)

previousPhase
object
Die abgeschlossene Phase mit den alten Items
newPhase
object
Die neue aktive Phase mit den neuen Items
changes
object
Übersicht der entfernten und hinzugefügten Items
creditNoteId
string
ID der erstellten Gutschrift (falls vorhanden, nur bei Festpreis-Produkten)

Beispiele

Upgrade mit anteiliger Gutschrift

Sofortige Abrechnung

Vorschau (Dry-Run)


Fehler-Codes


Verwandte Dokumentation