契約者の移譲APIと操作手順
- erika_nakagawa
ここでは、API経由で契約者の移譲の操作をする方法とCloudGear Accounts画面上での操作方法をご説明します。契約者の移譲ができる契約は一般契約です。
- 1 API経由での移譲方法
- 1.1 1. アクセストークンの取得
- 1.2 2.契約者移譲メールの送信
- 1.3 3.契約者移譲処理の実行
- 1.4 契約者移譲状況の取得
- 1.5 契約者移譲のリクエストの取り消し
- 2 CloudGear Accounts画面上での操作
- 2.1 1.契約者移譲メールの送信
- 2.2 2.契約者移譲処理の実行
- 2.2.1 クレジットカード払いの場合
- 2.2.2 銀行振込の場合
- 2.3 契約者移譲のリクエストの取り消し
API経由での移譲方法
1. アクセストークンの取得
契約者移譲APIにリクエストを送信するには、事前にOAuth 2.0 認証フローを使用してアクセストークンを取得する必要があります。
ユーザー認証の連携で作成した認証情報を使用し、WebAPIに使用するアクセストークンを取得します。
Authorization Codeによるアクセストークンの取得方法については、こちらのページをご覧ください。
契約者の移譲を行うためのアクセストークンには、「api.subscription.transfer.owners:read」、「api.subscription.transfer.owners:write」スコープが必要となります。
2.契約者移譲メールの送信
契約者移譲APIを使用して指定したuidのアカウント宛に「契約者の移譲」のメールを送信します。現在の契約者のみリクエストできます。移譲処理の実行までの期限は1週間です。
リクエスト
PUT /v1/subscriptions/{subscriptionId}/transfer_ownerプレースホルダー | 説明 |
|---|---|
<subscriptionId> | 契約者を移譲したいサブスクリプションのIDを指定します。 |
リクエストボディ | 説明 |
|---|---|
<uid> | 移譲したいアカウントのuidを指定します。 |
3.契約者移譲処理の実行
契約者移譲の処理を実行します。移譲を依頼されたユーザー（2の操作でメールを受け取ったユーザー）のみリクエストできます。
契約者が変わるため、契約の移譲前に使用していた支払い方法を変更する必要があり、その情報をリクエストボディに設定します。
リクエスト
POST /v1/subscriptions/{subscriptionId}/transfer_owner
プレースホルダー | 説明 |
|---|---|
<subscriptionId> | 契約者を移譲したいサブスクリプションのIDを指定します。 |
リクエストボディ | 説明 |
|---|---|
<token> | Stripeで作成したトークン。 クレジットカード支払いで登録されている契約、かつ新規カードを登録したい場合。 |
<cardId> | 移譲先アカウントに登録済みのカードId。 クレジットカード支払いで登録されている契約の場合必須。 |
<paymentName> | 振込元名義。 銀行振込で登録されている契約の場合必須。 |
契約者移譲状況の取得
2の操作で登録された内容を確認します。現在の契約者もしくは移譲を依頼されたユーザーのみリクエストできます。
リクエスト
GET /v1/subscriptions/{subscriptionId}/transfer_owner
契約者移譲のリクエストの取り消し
2の操作で登録した情報の削除をします。現在の契約者のみリクエストできます。
リクエスト
CloudGear Accounts画面上での操作
1.契約者移譲メールの送信
契約者のアカウントでCloudGear Accountsにアクセスします。
「契約管理」メニューをクリックします。
一覧から移譲したい契約を選択し、サイドバーの「契約設定」を選択します。
「契約者の移譲」カードが表示されています。
「招待を送る」をクリックします。
モーダルが開きます。
インプットに移譲したいアカウントのユーザーIDを入力し、OKをクリックします。
画面下部に「契約者移譲手続きメールを送信しました。」とメッセージが表示され、契約者の移譲カード内に「【ユーザーID】のユーザー宛にメールを送信済みです。」と表示されます。
2.契約者移譲処理の実行
クレジットカード払いの場合
1の手順が終わると指定したユーザーIDのアカウント宛にメールが届きます。
「契約者の移譲を行う」をクリックします。
移譲先のユーザーでログイン後、「契約者の移譲」ページが表示されます。
カードを新規追加したい場合は「新規登録」ボタン、既存カードを使用したい場合は、登録済みクレジットカード一覧より選択します。
選択したカードが「移譲先情報の確認」の「移譲後のクレジットカード」の欄に表示されます。
「変更する」ボタンをクリックします。
移譲が完了し、契約のダッシュボード画面が表示されます。
銀行振込の場合
1の手順が終わると指定したユーザーIDのアカウント宛にメールが届きます。
「契約者の移譲を行う」をクリックします。
移譲先のユーザーでログイン後、「契約者の移譲」ページが表示されます。
振込元名義を変更したい場合は「新規登録」ボタン、既存のものを使用したい場合は、登録済みの振込元名義より選択します。
選択した振込元名義が「移譲先情報の確認」の「移譲後の振込元名義」の欄に表示されます。
「変更する」ボタンをクリックします。
移譲が完了し、契約のダッシュボード画面が表示されます。
契約者移譲のリクエストの取り消し
1の手順後、「招待を取り消す」をクリックします。
招待が取り消され、招待前の状態に戻ります。