Dokumentation

1Verrechnung und Belastung

Die Verrechnung umfasst alles, was damit zusammenhängt, wie viel belastet werden soll. Die Belastung ist der Prozess, bei dem das Geld tatsächlich beim Abonnenten eingezogen wird. Diese beiden Prozesse sind in unserem System entkoppelt. Das bedeutet, dass die Belastung nicht direkt nach der Verrechnung ausgeführt werden muss. Dieser Schritt kann verzögert werden (siehe Belastungsstrategien). Ausserdem hängt der Betrag, der belastet werden soll, nicht nur vom berechneten Betrag aus dem Verrechnungsprozess ab. Er kann davon abweichen.

Sobald das Abonnement aktiv ist, führen wir für jeden Abonnenten ein Abonnement-Buchungsjournal. Während der Periode können Sie Einträge in das Buchungsjournal des Abonnenten aufnehmen, indem Sie Verbrauchsberichte bereitstellen oder zusätzliche Buchungseinträge für Leistungen hinzufügen, die Sie Ihrem Abonnenten verrechnen möchten. Sobald die Periode abgelaufen ist, wird das Token des Abonnenten belastet und eine Periodenrechnung erstellt und an Ihren Abonnenten gesendet.

Es gibt verschiedene Arten von Belastungen, die vom System automatisch in das Buchungsjournal des Abonnenten gebucht werden. Sie haben jedoch auch die Möglichkeit, Buchungseinträge manuell zu erstellen. Falls Sie eine nutzungsabhängige Gebühr verwenden, müssen Sie Metrische Verbrauchsberichte erstellen, die angeben, dass die verbrauchten Einheiten belastet werden können.

2Metrische Verbrauchsberichte

Die Metrischen Verbrauchsberichte werden verwendet, um Ihren Abonnenten die verbrauchten Einheiten zu belasten, falls Sie nutzungsabhängige Gebühren für Ihr Produkt verwenden.

2.1Metrische Verbrauchsberichte erstellen

Metrische Verbrauchsberichte werden verwendet, um die gemessene Nutzung Ihrer Produkte mit einem nutzungsabhängigen Preis zu verrechnen. Sie können den metrischen Verbrauchsbericht im Backend erstellen unter Space > Abonnement > Metrische Verbrauchsberichte.

Metrische Verbrauchsberichte werden in der Regel über die Web-Service-API erstellt. Sie können auch die Operation create auf dem Subscription Metric Usage Service verwenden, um einen Verbrauchsbericht zu erstellen.

Request

{
	"consumedUnits": "150",
	"description": "Transaction usage subscription 101",
	"externalId": "15-04-transaction-usage",
	"metric": {
		"id": 1
	},
	"subscription": {
		"id": 3
	}
}

2.2Metrische Verbrauchsberichte belasten

Alle metrischen Verbrauchsberichte werden Ihrem Abonnenten am Ende der Periode automatisch belastet. Wir summieren alle metrischen Verbrauchsberichte eines Abonnenten und wenden automatisch die nutzungsabhängige Gebühr an, die im Produkt definiert ist.

3Buchungseinträge

Falls Sie Ihrem Abonnenten Belastungen oder Gutschriften hinzufügen möchten, können Sie dies über Buchungseinträge tun.

3.1Buchungseinträge erstellen

Buchungseinträge können manuell hinzugefügt werden. Öffnen Sie das Abonnement und wechseln Sie in den Tab Buchungseinträge, um Positionen hinzuzufügen.

Sie können Buchungseinträge auch über die API hinzufügen, indem Sie die Operation create auf dem Subscription Ledger Entry Service verwenden.

Note
Negative Beträge entsprechen Gutschriften.

Request

{
	"amountIncludingTax": "55",
	"externalId": "subscriber-101-consulting-service",
	"quantity": "1",
	"subscriptionVersion": {
		"id": 3
	},
	"taxes": [{
		"rate": "8",
		"title": "VAT Switzerland"
	}],
	"title": "Consulting Services"
}

3.2Buchungseinträge belasten

Sobald die Buchungseinträge erstellt sind, befinden sie sich im Status open. Offene Buchungseinträge werden automatisch belastet, sobald die nächste Periode fällig ist. Alternativ können Sie Buchungseinträge auch manuell belasten, indem Sie eine Belastung für das Abonnement erstellen.

Belastungen können über das Backend erstellt werden, indem Sie zum Tab Belastungen im Abonnement navigieren. Eine Belastung besteht aus einem geplanten Ausführungsdatum und einer Referenz. Sobald das geplante Ausführungsdatum erreicht ist, werden alle offenen Buchungseinträge belastet. Alternativ können Sie Belastungen auch über die Web-Service-API erstellen, indem Sie die Operation create auf dem Subscription Charge Service verwenden.

Request

{
	"externalId": "1-charge-subscription-101",
	"plannedExecutionDate": "2017-04-25T07:50:15.596Z",
	"processingType": "SYNCHRONOUS",
	"reference": "1-charge-subscription-101",
	"subscription": {
		"id": 3
	}
}

4Belastungsstrategien

Belastungen werden normalerweise automatisch ausgeführt, sobald die Periode abgeschlossen ist. Sie haben jedoch die Möglichkeit, spezielle Belastungsstrategien zu konfigurieren, wann die Belastung Ihres Abonnenten erfolgen soll. Dies geschieht unter Space > Abonnemente > Konfiguration > Strategien. Hier können Sie eine Belastungsstrategie auswählen.

Sie können auch mehrere Belastungsstrategien konfigurieren und Bedingungen darauf anwenden, wie sie ausgewählt werden. Strategiebedingungen können unter Space > Abonnemente > Strategiebedingungen definiert werden.

Wenn beispielsweise der Gesamtbetrag, der belastet werden soll, unter 5 EUR liegt, ist die Belastung möglicherweise nicht sinnvoll, weil die Gebühren zu hoch sind. Daher kann eine Belastungsstrategie definiert werden, welche die Belastung für diese spezifische Periode überspringt. Der Betrag wird in die nächste Periode übertragen.

Ein weiterer Anwendungsfall könnte sein, dass die Belastung immer zu Beginn des Monats erfolgen soll, weil Sie erwarten, dass der Abonnent dann genügend Geld auf dem Bankkonto hat. Sie können also eine Belastungsstrategie konfigurieren, welche die Belastung bis zum nächsten Monatsbeginn verzögert.