Zum Hauptinhalt springen
Sie können Ihren gesamten Abrechnungslebenszyklus über die API oder die Konsole verwalten. Dieser Leitfaden behandelt, wie Sie Pläne auflisten, Kosten schätzen, eine Checkout-Sitzung erstellen, Ihr Abonnement überprüfen, Add-ons hinzufügen und bei Bedarf kündigen.

Voraussetzungen

  • Ein Truthlocks-Konto mit einem aktiven Mandanten.
  • Ein API-Schlüssel mit Abrechnungsberechtigungen. Siehe API-Schlüssel, um einen zu erstellen.

Einen Plan auswählen

Truthlocks bietet fünf Planstufen an. Verwenden Sie den Endpunkt ‘plans’, um den vollständigen Katalog abzurufen – dies ist ein öffentlicher Endpunkt und erfordert keine Authentifizierung.
Einen Vergleich aller Pläne finden Sie unter Abrechnungsübersicht.

Ihre Kosten schätzen

Vor dem Abonnement verwenden Sie den Schätzungsendpunkt, um eine Planempfehlung basierend auf Ihrer erwarteten Nutzung zu erhalten. Dies ist auch ein öffentlicher Endpunkt.
Die Antwort enthält einen empfohlenen Plan und eine geschätzte monatliche Gesamtsumme. Für eine detaillierte Kostenaufschlüsselung verwenden Sie stattdessen den Endpunkt projected invoice.

Aktuelle Tarife prüfen

Die effektiven nutzungsbasierten Tarife Ihres Mandanten hängen von Ihrer Preisliste und Region ab. Rufen Sie sie ab mit:
Die Antwort enthält Basistarife und alle regionalen Preisanpassungen:
Wenn Ihre Organisation eine benutzerdefinierte Preisliste von einem Plattformadministrator zugewiesen bekommen hat, erscheinen diese Preise hier anstelle der Standardpreise.

Einen Plan abonnieren

Erstellen Sie eine Checkout-Sitzung, um Ihr Abonnement zu starten oder zu aktualisieren. Der Abrechnungsdienst wählt automatisch den richtigen Zahlungsanbieter für Ihre Region aus.
1

Eine Checkout-Sitzung erstellen

Rufen Sie den Checkout-Endpunkt mit dem gewünschten Plan und den Weiterleitungs-URLs auf:
Die Antwort enthält eine checkout_url, die vom Zahlungsanbieter gehostet wird.
2

Zur Kasse weiterleiten

Senden Sie den Benutzer an die checkout_url, um die Zahlung abzuschließen.
3

Das Abonnement bestätigen

Überprüfen Sie nach der Zahlung, ob das Abonnement aktiv ist:
Sie können optional einen Parameter provider (stripe, paystack oder flutterwave) übergeben, um das automatische regionenbasierte Routing zu überschreiben. Details finden Sie unter Anbieter-Routing.

Add-ons anhängen

Add-ons erweitern Ihren Plan um zusätzliche Funktionen. Fügen Sie sie über die API hinzu:
Wenn das Add-on einen Preis hat, enthält die Antwort einen checkout_url zur Zahlungsabwicklung. Kostenlose Add-ons werden sofort aktiviert.
Die Preise für Add-ons passen sich automatisch an das Abrechnungsland Ihrer Organisation an. Mieter in kostengünstigeren Regionen zahlen einen reduzierten Satz – zum Beispiel kostet das Compliance Pack in Nigeria 149,50 /Monat(0,5xMultiplikator)anstelledesBasispreisesvon299/Monat (0,5x Multiplikator) anstelle des Basispreises von 299 . Die vollständige Stufentabelle finden Sie unter regionale Add-on-Preise.
Um ein Add-on zu entfernen:
Den vollständigen Add-on-Katalog und Details zur Antwort finden Sie unter Add-ons verwalten.

Nutzung überwachen

Verfolgen Sie Ihren aktuellen Abrechnungszyklusverbrauch, um innerhalb Ihrer Planlimits zu bleiben:
Um vor der Durchführung einer Operation zu prüfen, ob diese innerhalb des Kontingents liegt:

Abrechnungsportal öffnen

Leiten Sie Benutzer zu ihrem Self-Service-Portal des Zahlungsanbieters weiter, um Zahlungsmethoden zu aktualisieren, Rechnungen anzuzeigen oder ihr Abonnement zu verwalten:
Die Antwort enthält eine portal_url. Leiten Sie den Benutzer zu dieser URL weiter. Portal-Sitzungen laufen schnell ab, generieren Sie daher jedes Mal eine neue URL.

Abonnement kündigen

Um zu kündigen, rufen Sie den Kündigungs-Endpunkt auf. Die Kündigung wird am Ende des aktuellen Abrechnungszeitraums wirksam – bis dahin behalten Sie vollen Zugriff.
Nach Ablauf des Zeitraums wird Ihr Konto auf den Developer (kostenlos)-Plan herabgestuft. Um sich erneut anzumelden, erstellen Sie eine neue Checkout-Sitzung.
Sie können eine Stornierung nicht über die API rückgängig machen. Um Ihr Abonnement fortzusetzen, müssen Sie den Bestellvorgang erneut durchlaufen.

Verwandt

Billing-Übersicht

Planen Sie Tarifstufen, Tarife, Berechtigungen und Add-ons.

Anbieter-Routing

Wie Zahlungen nach Region weitergeleitet werden.

Billing API-Referenz

Vollständige Referenz des Billing-API-Endpunkts.

Berechtigungen

Überprüfen Sie Ihre aktiven Funktionen und Kontingente.