Reservation: insert

    顧客企業の予約を追加します。

    参考

    • 顧客企業がパートナー会社の場合、解約 (type: DELETE) 予約は設定できません。
    • 有料転換 (type: START_PAID_SERVICE) の場合、顧客企業がフリープラン/トライアルを利用中の場合のみ設定できます。
    • ライセンス追加 (type: ADD_LICENSE) は、年額プランを利用する顧客企業のみ設定できます。
    • 最大ユーザー数の設定 (type: SET_MAX_USER) の場合、月額プランを利用する顧客企業のみ設定できます。
    • フリープランを利用中の顧客企業が有料転換予約を設定する際、ベーシック/プレミアムプランに有料転換する場合は、Upgrade‐domain に登録済みのドメインを指定し、商品 ID (productId) を指定してください。 ライトプランに有料転換する場合は、商品 ID (productId) を指定する必要はありません。

    API の種類

    サーバー API

    Request

    Request URL

    • POST https://apis.worksmobile.com/r/{API_ID}/partners/v1/customers/{domainId}/subscription/reservation

    Path Parameters

    属性 タイプ 説明
    domainId Integer 顧客企業のドメイン ID

    Request body

    パラメーター タイプ 必修 説明
    type String Y 予約タイプ。
    - DELETE: 解約
    - START_PAID_SERVICE: 有料転換
    - ADD_LICENSE: ライセンス追加
    - SET_MAX_USER: 最大ユーザー数の設定
    writable
    applyYmd Date(Long_timeMillis) Y 予約適用日。
    - typeがSTART_PAID_SERVICEの場合
    * トライアル/有料プラン:翌日~猶予期間終了日
    * フリープラン:翌日~ +60日
    - typeがDELETEの場合
    * トライアル/有料プラン:翌日~契約終了日の翌日
    * フリープラン:翌日~ +60日
    -予約タイプが ADD_LICENSE, SET_MAX_USER: 翌日 ~ 契約終了日
    writable
    plan String N プラン
    - 予約タイプが START_PAID_SERVICE の場合、利用するプラン
    - フリープラン/トライアルは指定不可
    writable
    license Integer N ライセンス数
    - 予約タイプが START_PAID_SERVICE の場合、設定するライセンス数
    - 予約タイプが ADD_LICENSE の場合、追加するライセンス数
    writable
    maxMember Integer N 最大ユーザー数
    - 予約タイプが START_PAID_SERVICE または SET_MAX_USER の場合
    設定する最大ユーザー数
    writable
    productId String N 予約タイプが START_PAID_SERVICE の場合で、フリープラン (グループ名利用) からベーシック/プレミアムプランにアップグレードする商品 ID。ライトプランに有料転換する場合は指定する必要はありません。 writable
    domain String N フリープラン (グループ名利用) からベーシック/プレミアムプランにアップグレードする場合に設定するドメイン。ライトプランに有料転換する場合は指定する必要はありません。
    - Upgrade‐domain に登録済みのドメインのみ使用可能です。
    writable

    Request Example

    2017 年 10 月 20 日に解約を予約する。

    {
           "type": "DELETE",
           "applyYmd": 1508457600000
    }
    

    トライアルを利用中の顧客企業が 2017 年 10 月 23 日に月額プラン (最大ユーザー数 30) で有料転換を予約する。

    {
           "type": "START_PAID_SERVICE",
           "applyYmd": 1508716800000,
           "plan": "MONTHLY",
           "maxMember": 30
    }
    

    トライアルを利用中の顧客企業が 2017 年 10 月 23 日に年額ライセンス (ライセンス 100) に有料転換を予約する。

    {
           "type": "START_PAID_SERVICE",
           "applyYmd": 1508716800000,
           "plan": "ANNUAL_LICENSE",
           "license": 100
    }
    

    フリープランを利用中の顧客企業が 2017 年 10 月 23 日にプレミアムの月額プラン (最大ユーザー数 30) で有料転換を予約する。

    {
           "type": "START_PAID_SERVICE",
           "applyYmd": 1508716800000,
           "plan": "MONTHLY",
           "maxMember": 30,
           "productId": "PRM",
           "domain" : "example.com"
    }
    

    2017 年 10 月 23 日にライセンス 10 個追加を予約する。

    {
           "type": "ADD_LICENSE",
           "applyYmd": 1508716800000,
           "license": 10
    }
    

    2017 年 10 月 20 日に最大ユーザーの制限解除を予約する。

    {
           "type": "SET_MAX_USER",
           "applyYmd": 1508457600000,
           "maxMember": null
    }
    

    Response

    Status 201

    Reservation Resource