Verwenden von Recurly-Aktionen in Aktionsflüssen

Suite, alle Versionen

Team, Growth, Professional, Enterprise oder Enterprise Plus

Support

Team, Professional oder Enterprise

Zusammenfassung: ◀▼

Sie können Aktionsflüsse mit Recurly verbinden, um die Verwaltung von Kundenkonten und Abonnements zu automatisieren. Zu den möglichen Aktionen gehören das Erstellen, Aktualisieren und Nachschlagen von Konten und Abonnements sowie das Kündigen von Abonnements und das Abrufen von Rechnungs- oder Transaktionsdetails. Verwenden Sie ein dediziertes Dienstkonto für Verbindungen und stellen Sie Recurly API-Anmeldedaten bereit. Diese Integration optimiert die Abrechnungs- und Abonnement-Workflows im Rahmen Ihrer Supportprozesse.

Durch Verbinden des Aktionsgenerators mit externen Systemen wie Recurly können Administratoren Zendesk in automatisierten Workflows mit externen Systemen integrieren, um die Zusammenarbeit zu verbessern und für ein plattformübergreifend einheitliches Erlebnis zu sorgen.

Hinweis: Die mit externen Systemen verknüpften Schritte in Aktionsflüssen werden als externe Aktionen bezeichnet.

In diesem Beitrag werden folgende Themen behandelt:

Verbinden von Recurly mit dem Aktionsgenerator
Verwenden von Recurly-Aktionen in Aktionsflüssen

Verbinden von Recurly mit dem Aktionsgenerator

Bevor Sie externe Aktionen in Aktionsflüsse einbinden können, müssen Sie den Aktionsgenerator mit dem externen System verbinden.

Beachten Sie beim Verbinden mit externen Systemen für die Verwendung in Aktionsflüssen die folgenden Best Practices:

Alle von einem Aktionsfluss ausgeführten externen Aktionen werden dem Benutzer zugeordnet, der das externe System verbunden hat. Deshalb wird empfohlen, für die Verbindung mit einem externen System ein dediziertes Dienstkonto und keine persönlichen Anmeldedaten zu verwenden.
Alle Integrationen fordern den Zugang zu erforderlichen Zugriffsarten an. Sie sollten die Zugriffsarten jedoch unbedingt überprüfen und validieren, bevor Sie die Verbindung zum externen System autorisieren.
Bei der Verwaltung von Anmeldedaten für Tools wie OpenAI, die auf API-Schlüsseln basieren, sollten die Schlüssel nach Möglichkeit in einem sicheren Tresor oder Credential Manager gespeichert werden.

So finden Sie Ihre Recurly-Domäne und Ihren Recurly API-Schlüssel

Für die Authentifizierung der Recurly-Verbindung wird ein API-Schlüssel benötigt. Sie müssen folgende Informationen bereitstellen:

Recurly-Subdomäne: Die Subdomäne aus Ihrer Recurly-URL (z. B. die Zeichenfolge „IhreFirma“ aus der URL „IhreFirma.recurly.com“).
API-Schlüssel: Ihren privaten Recurly API-Schlüssel. Sie finden ihn in Recurly unter Integrations > API Credentials > Private API Key.

Weitere Informationen finden Sie in der Recurly-Dokumentation.

So verbinden Sie den Aktionsgenerator mit Recurly

Klicken Sie in der Seitenleiste des Admin Centers auf Apps und Integrationen und dann auf Aktionen > Aktionsflüsse.
Erstellen oder bearbeiten Sie einen Aktionsfluss.
Öffnen Sie die Schritt-Seitenleiste.
Klicken Sie unter Externe Aktionen auf Recurly.
Klicken Sie auf Verbinden.
Befolgen Sie die Anweisungen, um Ihren Recurly API-Schlüssel einzugeben und den Verbindungsaufbau abzuschließen.
Wichtig: Alle von einem Aktionsfluss ausgeführten externen Aktionen werden dem Benutzer zugeordnet, der das externe System verbunden hat. Deshalb wird empfohlen, für die Verbindung mit einem externen System ein dediziertes Dienstkonto und keine persönlichen Anmeldedaten zu verwenden.

Nach dem Verbindungsaufbau sehen Sie eine entsprechende Anzeige sowie Details zur verbundenen Instanz und den verfügbaren Recurly-Aktionen.

Verwenden von Recurly-Aktionen in Aktionsflüssen

Folgende Recurly-Aktionen sind verfügbar:

Konto erstellen
Konto aktualisieren
Nachschlagekonto
Abonnement erstellen
Abonnement aktualisieren
Abonnement kündigen
Nachschlageabonnement
Nachschlagerechnung
Nachschlagetransaktion

Erstellen eines Kontos

Mit der Aktion Konto erstellen können Sie in Recurly ein neues Kundenkonto erstellen.

Diese Aktion weist die folgenden Eingaben und Ausgaben auf:

Variablen

Eingaben

	Variablen
Eingaben	Erforderlich: `Account Code` „Account Code“ ist eine eindeutige Kontokennung (max. 50 Zeichen). Verwenden Sie eine Zendesk Benutzer- oder Organisations-ID, um die Zuordnung zu vereinfachen. Optional: `Email`, `First Name`, `Last Name`, `Company`, `Tax Exempt` „Tax Exempt“ kann auf „Yes“ oder „No“ gesetzt werden.
Ausgabe	Kontodetails wie ID, Code, E-Mail-Adresse, Status, created_at und hosted_login_token.

Erforderlich: Account Code

„Account Code“ ist eine eindeutige Kontokennung (max. 50 Zeichen). Verwenden Sie eine Zendesk Benutzer- oder Organisations-ID, um die Zuordnung zu vereinfachen.

Optional: Email, First Name, Last Name, Company, Tax Exempt

„Tax Exempt“ kann auf „Yes“ oder „No“ gesetzt werden.

Ausgabe Kontodetails wie ID, Code, E-Mail-Adresse, Status, created_at und hosted_login_token.

Aktualisieren eines Kontos

Mit der Aktion Konto aktualisieren können Sie ein vorhandenes Kundenkonto in Recurly ändern.

Diese Aktion weist die folgenden Eingaben und Ausgaben auf:

Variablen

Eingaben

	Variablen
Eingaben	Erforderlich: `Account Code` „Account Code“ kann entweder der Kontocode oder die UUID sein. Optional: `Email`, `First Name`, `Last Name`, `Company` Geben Sie nur Werte für die Felder an, die Sie aktualisieren möchten. Die vorhandenen Werte in nicht angegebenen Feldern bleiben unverändert.
Ausgabe	Kontodetails wie ID, Code, Status und updated_at-Zeitstempel.

Erforderlich: Account Code

„Account Code“ kann entweder der Kontocode oder die UUID sein.

Optional: Email, First Name, Last Name, Company

Geben Sie nur Werte für die Felder an, die Sie aktualisieren möchten. Die vorhandenen Werte in nicht angegebenen Feldern bleiben unverändert.

Ausgabe Kontodetails wie ID, Code, Status und updated_at-Zeitstempel.

Nachschlagen eines Kontos

Mit der Aktion Konto nachschlagen können Sie Details zu einem Konto mit dem angegebenen Kontocode oder der angegebenen UUID abrufen. Hierbei werden umfassende Informationen zu dem betreffenden Kundenkonto einschließlich des Abonnementstatus und der Abrechnungsdetails zurückgegeben.

Diese Aktion weist die folgenden Eingaben und Ausgaben auf:

	Variablen
Eingaben	Erforderlich: `Account Code` „Account Code“ kann entweder der Kontocode oder die UUID sein.
Ausgabe	Kontodetails wie id, code, email, first_name, last_name, company, state, balance, has_active_subscription, has_past_due_invoice, created_at und updated_at.

Erstellen eines Abonnements

Mit der Aktion Abonnement erstellen können Sie ein neues Abonnement für ein Recurly-Konto erstellen.

Diese Aktion weist die folgenden Eingaben und Ausgaben auf:

Variablen

Eingaben

	Variablen
Eingaben	Erforderlich: `Account Code`, `Plan`, `Currency`, `Collection method` Optional: `Quantity`, `Trial End Date`, `Start Date`, `Billing Info ID` Beachten Sie beim Verwenden der Aktion Abonnement erstellen folgende Punkte: Das Feld „Plan“ wird dynamisch mit den in Ihrem Recurly-Konto verfügbaren Abonnementplänen ausgefüllt. Die Optionen für „Currency“ beinhalten die Werte USD, EUR, GBP, CAD, AUD, JPY und INR. Das Feld „Collection Method“ bestimmt das Abrechnungsverhalten: „automatic“ bedeutet, dass Abonnementverlängerungen automatisch abgerechnet werden, während bei „manual“ eine Rechnung verschickt wird. Die Werte für „Trial End Date“ und „Start Date“ sollten im ISO-8601-Format eingegeben werden (z. B. „2026-12-31T00:00:00Z“). Wenn keine andere Menge angegeben ist, weist das Feld „Quantity“ standardmäßig den Wert 1 auf. „Billing Info ID“ erfordert die Recurly-Funktion „Wallet“ und wird derzeit nicht unterstützt.
Ausgabe	Abonnementdetails wie uuid, account_code, account_email, plan_code, plan_name, state, quantity, currency, current_period_started_at, current_period_ends_at, trial_ends_at, activated_at und created_at.

Erforderlich: Account Code, Plan, Currency, Collection method

Optional: Quantity, Trial End Date, Start Date, Billing Info ID

Beachten Sie beim Verwenden der Aktion Abonnement erstellen folgende Punkte:

Das Feld „Plan“ wird dynamisch mit den in Ihrem Recurly-Konto verfügbaren Abonnementplänen ausgefüllt.
Die Optionen für „Currency“ beinhalten die Werte USD, EUR, GBP, CAD, AUD, JPY und INR.
Das Feld „Collection Method“ bestimmt das Abrechnungsverhalten: „automatic“ bedeutet, dass Abonnementverlängerungen automatisch abgerechnet werden, während bei „manual“ eine Rechnung verschickt wird.
Die Werte für „Trial End Date“ und „Start Date“ sollten im ISO-8601-Format eingegeben werden (z. B. „2026-12-31T00:00:00Z“).
Wenn keine andere Menge angegeben ist, weist das Feld „Quantity“ standardmäßig den Wert 1 auf.
„Billing Info ID“ erfordert die Recurly-Funktion „Wallet“ und wird derzeit nicht unterstützt.

Ausgabe Abonnementdetails wie uuid, account_code, account_email, plan_code, plan_name, state, quantity, currency, current_period_started_at, current_period_ends_at, trial_ends_at, activated_at und created_at.

Aktualisieren eines Abonnements

Mit der Aktion Abonnement aktualisieren können Sie den Plan, die Menge oder den Zeitraum eines vorhandenen Abonnements ändern.

Diese Aktion weist die folgenden Eingaben und Ausgaben auf:

Variablen

Eingaben

	Variablen
Eingaben	Erforderlich: `Subscription UIID` Optional: `New Plan`, `Quantity`, `When to Apply` Das Feld „New Plan“ wird dynamisch mit den verfügbaren Abonnementplänen ausgefüllt. „When to Apply“ bestimmt, ob die Änderungen sofort (Now) oder zu Beginn des nächsten Abrechnungszeitraums (At renewal) in Kraft treten. Geben Sie nur Werte für die Felder an, die Sie aktualisieren möchten.
Ausgabe	Abonnementdetails wie uuid, state, plan_code, plan_name, quantity und updated_at-Zeitstempel.

Erforderlich: Subscription UIID

Optional: New Plan, Quantity, When to Apply

Das Feld „New Plan“ wird dynamisch mit den verfügbaren Abonnementplänen ausgefüllt. „When to Apply“ bestimmt, ob die Änderungen sofort (Now) oder zu Beginn des nächsten Abrechnungszeitraums (At renewal) in Kraft treten. Geben Sie nur Werte für die Felder an, die Sie aktualisieren möchten.

Ausgabe Abonnementdetails wie uuid, state, plan_code, plan_name, quantity und updated_at-Zeitstempel.

Kündigen eines Abonnements

Mit der Aktion Abonnement kündigen können Sie ein aktives Abonnement zum Ende der Laufzeit oder sofort kündigen.

Diese Aktion weist die folgenden Eingaben und Ausgaben auf:

Variablen

Eingaben

	Variablen
Eingaben	Erforderlich: `Subscription UUID` Optional: `When to Cancel` „When to Cancel“ bestimmt den Zeitpunkt der Kündigung: „At term end“ (empfohlen) kündigt das Abonnement am Ende aller Abrechnungszeiträume, während das Abonnement mit „At next billing cycle“ zum nächsten Abrechnungstermin gekündigt wird. Wählen Sie die Option, die am besten zu Ihren Unternehmensrichtlinien passt.
Ausgabe	Abonnementdetails wie uuid und state sowie canceled_at- und expires_at-Zeitstempel.

Erforderlich: Subscription UUID

Optional: When to Cancel

„When to Cancel“ bestimmt den Zeitpunkt der Kündigung: „At term end“ (empfohlen) kündigt das Abonnement am Ende aller Abrechnungszeiträume, während das Abonnement mit „At next billing cycle“ zum nächsten Abrechnungstermin gekündigt wird. Wählen Sie die Option, die am besten zu Ihren Unternehmensrichtlinien passt.

Ausgabe Abonnementdetails wie uuid und state sowie canceled_at- und expires_at-Zeitstempel.

Nachschlagen eines Abonnements

Mit der Aktion Abonnement nachschlagen können Sie detaillierte Informationen zu dem Abonnement mit der angegebenen UUID abrufen. Hierbei werden umfassende Abonnementinformationen wie Abrechnungszeiträume, Preisinfos und Kündigungsstatus zurückgegeben. Die Ausgabe beinhaltet sowohl den aktuellen Status als auch historische Zeitstempel.

Diese Aktion weist die folgenden Eingaben und Ausgaben auf:

	Variablen
Eingaben	Erforderlich: `Subscription UUID`
Ausgabe	Abonnementdetails wie uuid, account_code, account_email, plan_code, plan_name, plan_interval_unit, plan_interval_length, state, quantity, currency, unit_amount, subtotal, current_period_started_at, current_period_ends_at, trial_ends_at, activated_at, canceled_at und expires_at.

Nachschlagen einer Rechnung

Mit der Aktion Rechnung nachschlagen können Sie Details zu der Rechnung mit der angegebenen Rechnungsnummer oder UUID abrufen. Die Ausgabe beinhaltet pdf_url und stellt damit einen direkten Link zum Herunterladen der Rechnung im PDF-Format bereit.

Diese Aktion weist die folgenden Eingaben und Ausgaben auf:

	Variablen
Eingaben	Erforderlich: `Invoice ID` „Invoice ID“ kann eine Rechnungsnummer (z. B. „1234“) oder eine UUID sein.
Ausgabe	Rechnungsdetails wie id, number, account_code, state, type, subtotal, tax, total, balance, currency, created_at, due_at, closed_at und pdf_url.

Nachschlagen einer Transaktion

Mit der Aktion Transaktion nachschlagen können Sie Details zu der Zahlungstransaktion mit der angegebenen UUID abrufen. Hierbei werden umfassende Transaktionsinformationen wie die Zahlungsmethode, die Gateway-Antwort und der Transaktionsstatus zurückgegeben. Die Ausgabe beinhaltet Zeitstempel für etwaige Stornierungen und Rückerstattungen.

Diese Aktion weist die folgenden Eingaben und Ausgaben auf:

	Variablen
Eingaben	Erforderlich: `Transaction UUID`
Ausgabe	Transaktionsdetails wie uuid, account_code, invoice_number, subscription_uuid, type, status, amount, currency, payment_method, gateway_code, gateway_message, created_at, voided_at und refunded_at.