アクションフローでのRecurlyアクションの使い方

Suite、すべてのバージョン

Team、Growth、Professional、EnterpriseまたはEnterprise Plus

Support

Team、ProfessionalまたはEnterprise

要約：◀▼

アクションフローをRecurlyに接続することで、顧客のアカウントやサブスクリプションの管理を自動化できます。Recurlyのアクションには、アカウントやサブスクリプションの作成、更新、検索のほか、サブスクリプションの解約、請求書や取引の詳細の取得などがあります。コネクションには専用のサービスアカウントを使用し、Recurly APIの認証情報を入力してください。このインテグレーションにより、サポートプロセスにおける請求およびサブスクリプションのワークフローを効率化できます。

アクションビルダーをRecurlyなどの外部システムに接続すると、管理者は自動化ワークフロー内でZendeskを外部システムと連携させることができます。これにより、部門間のコラボレーションを強化し、複数のプラットフォームにまたがる一貫した利用体験を維持できます。

メモ：アクションフロー内の外部システムに関わるステップは、総称して「外部アクション」と呼ばれます。

この記事では、以下のトピックについて説明します。

Recurlyをアクションビルダーに接続する
アクションフローでのRecurlyアクションの使い方

Recurlyをアクションビルダーに接続する

外部アクションをアクションフローで使用するには、アクションビルダーを外部システムへ接続する必要があります。

外部システムに接続してアクションフローで外部アクションを使用する場合は、以下のベストプラクティスをお勧めします。

アクションフローによって実行される外部アクションは、すべて外部システムを接続したユーザーに帰属します。したがって、各外部システムに接続する場合、個人の資格情報ではなく専用のサービスアカウントを使用することが推奨されます。
すべてのインテグレーションでは、必要なスコープへのアクセスが要求されます。ただし、外部システムへの接続を承認する前に、スコープを確認し、妥当性を検証することが重要です。
OpenAIなどのAPIキーベースのツールの認証情報を管理する場合は、キーを安全な保管庫または認証情報マネージャーに保存することをお勧めします。

RecurlyのドメインとAPIキーを確認するには

Recurlyコネクションには、認証用のAPIキーが必要です。以下の項目を指定する必要があります。

Recurlyサブドメイン：RecurlyのURL内のサブドメイン部分（例：yourcompany.recurly.com の「yourcompany」の箇所）。
APIキー：RecurlyのプライベートAPIキーは、Recurlyの「Integrations」>「API Credentials」>「Private API Key」で確認できます。

詳細については、Recurlyのドキュメントを参照してください。

アクションビルダーをRecurlyに接続するには

管理センターで、サイドバーにある「 アプリおよびインテグレーション」をクリックし、「アクション」>「アクションフロー」を選択します。
アクションフローを新規作成するか、既存のアクションフローを編集します。
ステップサイドバーを開きます。
「外部アクション」セクションで、「Recurly」をクリックします。
「接続」をクリックします。
Recurlyの画面の指示に従ってRecurlyのAPIキーを入力し、接続を完了します。
重要：アクションフローによって実行される外部アクションは、すべて外部システムを接続したユーザーに帰属します。したがって、各外部システムに接続する場合、個人の資格情報ではなく専用のサービスアカウントを使用することが推奨されます。

接続が完了すると、接続していることを示すインジケーター、接続したインスタンスの詳細、およびRecurlyで利用可能なアクションが表示されます。

アクションフローでのRecurlyアクションの使い方

以下のRecurlyアクションを選択できます。

アカウントを作成する
アカウントを更新する
アカウントを参照する
サブスクリプションを作成する
サブスクリプションを更新する
サブスクリプションを解約する
サブスクリプションを参照する
請求書を参照する
取引を参照する

アカウントを作成する

「アカウントを作成する」アクションを使用して、Recurlyに新しい顧客のアカウントを作成します。

このアクションには以下の入力と出力が含まれます。

変数

入力

	変数
入力	必須：`Account Code` 「アカウントコード」は一意のアカウント識別子（最大50文字）。ZendeskのユーザーIDまたは組織IDを使用することで相互照合が容易になる。オプション：`Email`、`First Name`、`Last Name`、`Company`、`Tax Exempt` 「非課税」には「はい」または「いいえ」のいずれかを設定。
出力	アカウントの詳細：ID、コード、メールアドレス、状態、created_atタイムスタンプ、hosted_login_token など。

必須：Account Code

「アカウントコード」は一意のアカウント識別子（最大50文字）。ZendeskのユーザーIDまたは組織IDを使用することで相互照合が容易になる。

オプション：Email、First Name、Last Name、Company、Tax Exempt

「非課税」には「はい」または「いいえ」のいずれかを設定。

出力アカウントの詳細：ID、コード、メールアドレス、状態、created_atタイムスタンプ、hosted_login_token など。

アカウントを更新する

「アカウントを更新する」アクションを使用して、Recurly内の既存の顧客アカウントの情報を変更します。

このアクションには以下の入力と出力が含まれます。

変数

入力

	変数
入力	必須：`Account Code` 「アカウントコード」には、アカウントコードまたはUUIDのいずれかを設定。オプション：`Email`、`First Name`、`Last Name`、`Company` 更新するフィールドの値のみ入力する。指定しなかったフィールドの既存の値は変更されない。
出力	アカウントの詳細：ID、コード、状態、および updated_atタイムスタンプなど。

必須：Account Code

「アカウントコード」には、アカウントコードまたはUUIDのいずれかを設定。

オプション：Email、First Name、Last Name、Company

更新するフィールドの値のみ入力する。指定しなかったフィールドの既存の値は変更されない。

出力アカウントの詳細：ID、コード、状態、および updated_atタイムスタンプなど。

アカウントを参照する

「アカウントを参照する」アクションを使用して、アカウントコードまたはUUIDに基づいてアカウントの詳細を取得します。このアクションにより、サブスクリプションのステータスや請求の詳細など、顧客アカウントに関する包括的な情報を取得できます。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：`Account Code` 「アカウントコード」には、アカウントコードまたはUUIDのいずれかを設定。
出力	アカウントの詳細：ID、コード、メールアドレス、first_name、last_name、会社名、状態、残高、has_active_subscription、has_past_due_invoice、およびcreated_at、updated_atの各タイムスタンプなど。

サブスクリプションを作成する

「サブスクリプションを作成する」アクションを使用して、Recurlyアカウントの新規サブスクリプションを作成します。

このアクションには以下の入力と出力が含まれます。

変数

入力

	変数
入力	必須：`Account Code`、`Plan`、`Currency`、`Collection method` オプション：`Quantity`、`Trial End Date`、`Start Date`、`Billing Info ID` 「サブスクリプションを作成する」アクションを使用する際の注意点：「プラン」フィールドには、Recurlyアカウントで利用可能なサブスクリプションプランが動的に表示される。「通貨」には、USD、EUR、GBP、CAD、AUD、JPY、INRのオプションがある。「回収方法」で請求時の動作を決定する。「自動」は更新時に自動的に課金され、「手動」は請求書が送付される。「トライアル終了日」および「開始日」は、ISO 8601の日時形式で指定する（例：2026-12-31T00:00:00Z）。「数量」の指定がない場合、デフォルトで1になる。「請求情報ID」は現在サポートされておらず、Recurlyの「ウォレット」機能が必要。
出力	サブスクリプションの詳細：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、created_atの各タイムスタンプなど。

必須：Account Code、Plan、Currency、Collection method

オプション：Quantity、Trial End Date、Start Date、Billing Info ID

「サブスクリプションを作成する」アクションを使用する際の注意点：

「プラン」フィールドには、Recurlyアカウントで利用可能なサブスクリプションプランが動的に表示される。
「通貨」には、USD、EUR、GBP、CAD、AUD、JPY、INRのオプションがある。
「回収方法」で請求時の動作を決定する。「自動」は更新時に自動的に課金され、「手動」は請求書が送付される。
「トライアル終了日」および「開始日」は、ISO 8601の日時形式で指定する（例：2026-12-31T00:00:00Z）。
「数量」の指定がない場合、デフォルトで1になる。
「請求情報ID」は現在サポートされておらず、Recurlyの「ウォレット」機能が必要。

出力サブスクリプションの詳細：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、created_atの各タイムスタンプなど。

サブスクリプションを更新する

「サブスクリプションを更新する」アクションを使用して、既存のサブスクリプションのプラン、数量、または変更の適用タイミングを変更します。

このアクションには以下の入力と出力が含まれます。

変数

入力

	変数
入力	必須：`Subscription UIID` オプション：`New Plan`、`Quantity`、`When to Apply` 「新しいプラン」フィールドには、利用可能なサブスクリプションプランが動的に表示される。「適用のタイミング」で、変更を直ちに（「今すぐ」）適用するか、次の請求サイクル（「更新時」）に適用するかを指定する。更新するフィールドの値のみ入力する。
出力	サブスクリプションの詳細：uuid、state、plan_code、plan_name、quantity、およびupdated_atのタイムスタンプなど。

必須：Subscription UIID

オプション：New Plan、Quantity、When to Apply

「新しいプラン」フィールドには、利用可能なサブスクリプションプランが動的に表示される。「適用のタイミング」で、変更を直ちに（「今すぐ」）適用するか、次の請求サイクル（「更新時」）に適用するかを指定する。更新するフィールドの値のみ入力する。

出力サブスクリプションの詳細：uuid、state、plan_code、plan_name、quantity、およびupdated_atのタイムスタンプなど。

サブスクリプションを解約する

「サブスクリプションを解約する」アクションを使用して、アクティブなサブスクリプションを、期間末または直ちに解約します。

このアクションには以下の入力と出力が含まれます。

変数

入力

	変数
入力	必須：`Subscription UUID` オプション：`When to Cancel` 「解約のタイミング」に解約のタイミングを指定する。「期間末（推奨）」を選択すると、現在の契約期間の終了時に解約される。「次の請求サイクル」を選択すると、次の請求日に解約される。自社の事業方針に最も適したオプションを選択すること。
出力	サブスクリプションの詳細：uuid、state、および canceled_at、expires_at の各タイムスタンプなど。

必須：Subscription UUID

オプション：When to Cancel

「解約のタイミング」に解約のタイミングを指定する。「期間末（推奨）」を選択すると、現在の契約期間の終了時に解約される。「次の請求サイクル」を選択すると、次の請求日に解約される。自社の事業方針に最も適したオプションを選択すること。

出力サブスクリプションの詳細：uuid、state、および canceled_at、expires_at の各タイムスタンプなど。

サブスクリプションを参照する

「サブスクリプションを参照する」アクションを使用して、UUIDに基づいてサブスクリプションの詳細を取得します。このアクションにより、請求期間、料金、解約状況など、サブスクリプションに関する包括的な情報を取得できます。出力には、現在の状態とタイムスタンプの履歴情報の両方が含まれます。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：`Subscription UUID`
出力	サブスクリプションの詳細：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、expires_atの各タイムスタンプなど。

請求書を参照する

「請求書を参照する」アクションを使用して、請求書番号または UUID に基づいて請求書の詳細を取得します。出力には、請求書のPDFを直接ダウンロードできるリンク「pdf_url」が含まれます。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：`Invoice ID` 「請求書ID」には、請求書番号（例：1234）またはUUIDのいずれかを指定できる。
出力	請求書の詳細：請求書ID、請求書番号、account_code、状態、種類、小計、税額、合計、残高、通貨、および created_at、due_at、closed_at の各タイムスタンプ、pdf_urlなど。

取引を参照する

「取引を参照する」アクションを使用して、UUID に基づいて支払い取引の詳細を取得します。このアクションにより、支払い方法、ゲートウェイの応答、取引ステータスなど、支払い取引に関する詳細を取得できます。出力には、（該当する場合）無効化および返金のタイムスタンプが含まれます。

このアクションには以下の入力と出力が含まれます。

	変数
入力	必須：`Transaction UUID`
出力	取引の詳細：uuid、account_code、invoice_number、subscription_uuid、type、status、amount、currency、payment_method、gateway_code、gateway_message、およびcreated_at、voided_at、refunded_at の各タイムスタンプなど。